Skip to main content
PATCH
Update a trigger

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"

Body

application/json
title
string
Required string length: 1 - 120
description
string
Maximum string length: 2000
payloadSchema
object

Response

Updated.

triggerEventId
string
required
Required string length: 1 - 256
title
string
required
Required string length: 1 - 120
provider
enum<string>
required
Available options:
brew_api,
clerk,
stripe,
shopify,
stytch,
supabase,
workos,
revenuecat,
custom
payloadSchema
object
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
description
string
Maximum string length: 2000
providerEventKey
string