This document describes the API endpoints used by the Brandye Zapier integration.

Base URL:

<https://app.brandye.com>

The Zapier app exposes one trigger: Quiz Completed. It lets merchants send completed Brandye quiz submissions to other Zapier apps.

Authentication

Brandye uses Zapier custom authentication. Zapier stores two fields:

Field Required Description
api_key Yes The Brandye API key for the merchant store. It is shown in the Brandye app Zapier setup modal.
shop Yes The merchant Shopify shop. Both yourstore.myshopify.com and yourstore are accepted. Brandye normalizes short shop names to the .myshopify.com domain.

Zapier sends these values as query parameters on each Brandye API request:

?api_key={api_key}&shop={shop}

Example:

<https://app.brandye.com/api/zapier/auth/test?api_key=00000000-0000-0000-0000-000000000000&shop=example.myshopify.com>

Authentication succeeds only when the API key belongs to the requested shop.

Endpoints

Test Authentication

Zapier calls this endpoint when a merchant connects a Brandye account.

GET /api/zapier/auth/test

Query parameters:

Name Required Description
api_key Yes Brandye store API key.
shop Yes Shopify shop domain or short store name.

Successful response:

{
  "success": true
}