Skip to main content
POST
Validate a trigger payload

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"

Body

application/json
payload
object
required
enforcement
enum<string>
Available options:
prune,
strict

Response

The verdict — for BOTH valid and invalid payloads (valid discriminates).

valid
boolean
required
errors
object[]
required
warnings
object[]
required
resolvedPayload
object
required
prunedKeys
string[]
required
source
enum<string>
required
Available options:
stored,
derived_from_schema,
derived_from_template
contractHash
string
Required string length: 64