Skip to main content
GET
Get a trigger payload contract

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 (integration triggers use composite ids — URL-encode the colons).

Required string length: 1 - 256
Example:

"tri_signup"

Query Parameters

format
enum<string>

Rendering. json (default) returns the contract object; ts | zod | jsonschema | skill return {format, content} — a generated TypeScript type, Zod schema, JSON Schema document, or SKILL.md wiring brief.

Available options:
json,
ts,
zod,
jsonschema,
skill

Response

The contract (format=json, default) or {format, content} for text formats.

subjectKind
enum<string>
required
Available options:
trigger
subjectId
string
required
Minimum string length: 1
source
enum<string>
required
Available options:
stored,
derived_from_schema,
derived_from_template
typeName
string
required
Minimum string length: 1
format
enum<string>
required
Available options:
json,
ts,
zod,
jsonschema,
skill
contractHash
string
Required string length: 64
version
integer
Required range: x >= 1
enforcement
enum<string>
Available options:
off,
prune,
strict
driftStatus
enum<string>
Available options:
fresh,
stale
fields
object[]
content
string