Skip to main content
GET
Pre-flight a trigger (ready check)

Authorizations

Authorization
string
header
default:Bearer brew_your_api_key
required

Send your Brew API key as Authorization: Bearer brew_xxx.

Headers

X-Brand-Id
string

The brand this request acts on. REQUIRED for organization-scoped credentials (otherwise 400 BRAND_ID_REQUIRED — there is no default brand); list ids with GET /v1/brands. Brand-scoped credentials may omit it, and sending a different brand returns 403 BRAND_SCOPE_MISMATCH. A brand outside your organization returns 404 BRAND_NOT_FOUND.

Required string length: 1 - 64

Path Parameters

triggerEventId
string
required

Trigger id returned by POST /v1/automations/triggers. Custom triggers use tri_… ids; integration triggers use composite ids (e.g. clerk:org_…:brand_…:user.created, URL-encode the colons).

Required string length: 1 - 256
Example:

"tri_signup"

Response

Ready: the key, scope, and permissions all pass; details carries the payload contract and matched consumers.

success
boolean
required
status
enum<string>
required

Discriminator for the response category. Pairs with code. A trigger with no published automation attached returns status: "failed" + code: "NO_PUBLISHED_AUTOMATION" (HTTP 422). Successful fires always return status: "triggered".

Available options:
triggered,
idempotent_replay,
ready,
invalid_api_key,
invalid_json,
failed,
forbidden,
payload_mismatch,
trigger_event_not_found
code
string
required
message
string
required
receivedAt
string
required

ISO-8601 timestamp the request was processed at.

triggerEventId
string
details
object