Skip to main content
POST
Get or create an integration event trigger

Authorizations

Authorization
string
header
default:Bearer brew_your_api_key
required

Send your Brew API key as Authorization: Bearer brew_xxx.

Headers

Idempotency-Key
string

Optional idempotency key for safe retries. Reusing the same key with the same request body returns the original response for 24 hours.

Required string length: 1 - 100
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

Body

application/json
eventId
string
required

The live event id from GET /v1/integrations/events (eventId). Never compose one from a provider and an event name.

Required string length: 1 - 64

Response

The trigger already existed for this event.

triggerEventId
string
required
Required string length: 1 - 256
title
string
required
Required string length: 1 - 120
provider
enum<string>
required
Available options:
brew_api,
custom,
brew_event,
clerk,
stytch,
supabase,
workos,
stripe,
shopify,
revenuecat,
framer,
posthog,
typeform,
webflow,
hubspot
payloadSchema
object
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
created
boolean
required

True when this call created the trigger; false when it already existed.

propertiesStatus
enum<string>
required

current: listed with the event or read in the last day. stored: the provider could not be read now; these are its last description. rate_limited: its read budget is spent; these are what Brew stored, possibly none (read again after retryAfterSeconds). unavailable: not read, and none stored.

Available options:
current,
stored,
rate_limited,
unavailable
description
string
Maximum string length: 2000
providerEventKey
string
retryAfterSeconds
integer

With rate_limited: seconds until the provider can be read again, when it said.