Skip to main content
GET
Check a trigger is ready to fire

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:

"user_signed_up"

Response

The readiness report: whether a fire would start runs, and everything needed to wire the caller.

triggerEventId
string
required
Required string length: 1 - 256
ready
boolean
required

True when a fire right now would start at least one run.

blockers
object[]
required
publishedAutomations
object[]
required
counts
object
required
title
string
description
string
provider
string
providerEventKey
string
payloadSchema
object
endpoint
string

The fire URL to POST events to.