> ## Documentation Index > Fetch the complete documentation index at: https://docs.brew.new/llms.txt > Use this file to discover all available pages before exploring further. # Get or create an unsubscribe trigger > Returns the brand’s trigger for one Brew event scope, creating it the first time. Brew events start automations from things that happen inside Brew. The first is `contact.unsubscribed`: a contact unsubscribed with an email’s unsubscribe link or their mail app’s one-click button (never a bounce, complaint, import or API edit). **Use when** an automation should start when a contact unsubscribes, from one marketing domain’s list or from every email the brand sends. **Input** `{ event: "contact.unsubscribed", scope: "domain", domainId }` for one marketing domain’s list (ids from `listDomains`), or `{ event: "contact.unsubscribed", scope: "all" }` for every email. An unsubscribe from all clicked in one of a domain’s emails also starts that domain’s trigger, while the contact was still on its list. **Returns** `201` with the new trigger row, or `200` with the existing one (`created: false`). Brew owns its title and payload, so the row is immutable and never fires over the API. The contact has just opted out, so an automation on this trigger sends only a message they need (such as confirming the unsubscribe) from a transactional domain, or mail from another marketing domain they are still on; publish refuses a flow none of whose emails could reach them. **Errors** `400 INVALID_REQUEST` when `domainId` is missing for `scope: "domain"` or sent for `scope: "all"`; `404 DOMAIN_NOT_FOUND` for an unknown or cross-brand domain; `422 DOMAIN_PURPOSE_NOT_ALLOWED` for a transactional domain, which owns no list; `409 TRIGGER_LIMIT_REACHED` when the brand already holds the maximum number of triggers. **See also** `createAutomation`, `fireTrigger`, `listDomains`. ## OpenAPI ````yaml /api-reference/openapi-public-v1.yaml post /v1/automations/triggers/brew-events openapi: 3.1.0 info: title: Brew Public API v1 version: 1.0.0 description: >- Brew Public API v1. Generated from the app Zod contracts (`lib//contracts.ts`): this document is the contract, and every operation documents exactly the error codes it can return. - Base URL `https://brew.new/api`; every path starts with `/v1`; JSON in and out. Request bodies and query strings are strict: an unknown key is `400 INVALID_REQUEST` and `error.param` names it. - Identity is always in the path. `GET /v1/` lists (`{ data, pagination: { limit, cursor, hasMore } }`; page until `cursor` is `null`), and `GET /v1//{id}` returns the bare resource, the same object a write returns. `?include=` expands relations on a detail read only, and is `400` on a list. There is no `?=` read anywhere. - Writes carry identity in the path and return the bare resource: `POST /v1/` creates (`201`, or `202` when work continues asynchronously), `PATCH` and `DELETE /v1//{id}` update or delete (`DELETE` answers `{ , deleted }` and is idempotent). Lifecycle state changes such as publishing ride `PATCH` as attributes. Two writes report more than the row and say so in their shape: `POST` and `PATCH /v1/contacts` are upserts that answer `{ contact, created | updated, … }` because whether a row was created, which fields changed, and which field definitions were minted are facts about the write, not about the contact. - Non-CRUD operations are explicit action sub-paths, for example `POST /v1/automations/{automationId}/test`, `POST /v1/domains/{domainId}/verify`, `POST /v1/sends/{sendId}/cancel` and `POST /v1/automations/triggers/{triggerEventId}/fire`. - Every resource has one root. Sends read and write at `/v1/sends`, fired triggers at `/v1/automations/trigger-instances`, and `/v1/analytics/*` holds only reports (aggregates over a window). Every endpoint answers in the same envelopes, with no exceptions. - Field names are camelCase; enum values are lowercase snake_case; timestamps are ISO 8601 UTC strings. Identifiers are opaque strings of at most 64 characters (`triggerEventId` up to 256); never parse a prefix. - Everything that runs shares one status vocabulary: `queued`, `scheduled`, `running`, `paused`, `completed`, `partially_completed`, `failed`, `canceled`. It covers sends, automation runs, manual audience runs, audience builds and inbox placement tests, so one status switch reads them all. A step inside a run is `running`, `completed`, `failed` or `skipped`. - Every error on every endpoint is `{ error: { code, type, message, suggestion, docs, param?, retryAfter?, details? } }`. Branch on `code`: the closed list is the `ApiErrorCode` component and every operation documents exactly the codes it can return. Non-fatal caveats arrive as `warnings: [{ code, message, field? }]` on `2xx` bodies. - A credential is brand-scoped (the brand is implicit; send nothing) or organization-scoped (name the brand with the `X-Brand-Id` header on brand-scoped operations, else `400 BRAND_ID_REQUIRED`; there is no default brand). Only `POST /v1/api-keys` carries a `brandId` field, and only a signed-in organization admin session may call `/v1/api-keys`. A brand outside your reach surfaces as `404`, never `403`. - Send `Idempotency-Key` (up to 100 characters) on any POST you might repeat: the same key and body replays the original response for 24 hours; the same key with a different body is `409 IDEMPOTENCY_CONFLICT`. Rate limits are per credential and named policy (`X-RateLimit-*` headers; `429` carries `Retry-After`). Credit-metered operations advertise `402` and carry `x-brew-credited: true` in the spec. - Discovery without a key: `GET /v1/help` (JSON catalog with scopes, credits and rate limits per operation), `GET /v1/llms.txt` (this guide) and `GET /v1/health`. The OpenAPI document is served at `/openapi.json`. contact: name: Brew Support url: https://docs.brew.new email: support@brew.new servers: - url: https://brew.new/api description: Production - url: http://localhost:3000/api description: Local development security: - bearerAuth: [] - apiKeyAuth: [] tags: - name: Emails description: >- Email designs and sending. Generate a design with the Brew email agent, edit, version, restore — then send it: `POST /v1/sends` delivers a design to a target (a saved audience, an inline list, or a single address) via a verified domain, and `POST /v1/sends` with `test: true` fires a one-off test. Sending is not campaign-specific. Send reads live under Sends (`/v1/sends`). - name: Sends description: >- The unit of delivery and analytics. `POST /v1/sends` delivers a design to a target; `GET /v1/sends` lists campaign sends (with lifetime stats) or, with a join filter, one automation’s per-recipient deliveries; `GET /v1/sends/{sendId}` reads one send and its events. Cancel, pause and resume are action sub-paths. - name: Brands description: >- Brand lifecycle for ORGANIZATION-scoped credentials: list the brands a credential can reach, read one, and create a new one (extraction runs asynchronously — poll `GET /v1/brands/{brandId}` until `status: completed`). These endpoints act on the organization, so they take no `X-Brand-Id`. - name: Analytics description: >- Read-only cross-resource reports: the brand overview, windowed automation performance and the unified event feed. Send rows (with lifetime stats) live at `/v1/sends`; fired triggers at `/v1/automations/trigger-instances`. - name: Automations description: >- Automation graphs — deterministic create from explicit `nodes` + `connections`, update, version, publish / unpublish, test. Includes trigger event definitions + the fire endpoint (`/v1/automations/triggers`) and run history (`/v1/automations/runs`). - name: Contacts description: Create, search, patch, and delete contacts. Email is the primary key. - name: Contact Fields description: List, create, and delete custom contact field definitions. - name: Audiences description: Saved contact filter sets — a recipient target for sends. - name: Domains description: 'Sending domains: add, read DNS records, verify, configure sender defaults.' - name: Templates description: Public template gallery (read-only) usable as generation references. - name: Brand description: The single brand bound to the API key. - name: Chats description: >- List the brand's Brew chats, and read a brand-scoped digest of one — referenced emails/automations/triggers + a trimmed transcript — so an external agent can resume the conversation. - name: Notifications description: >- The brand's notification feed, as the app's bell shows it. Each row is gated by the credential's access to its feature, and a comment mention reaches only the person it names. - name: Insights description: >- Brew Insights, read-only: the insight engine’s deterministic findings about the brand, ranked as the Insights page shows them, one finding in full with its frozen metrics and evidence, and the intelligence layer beside them (weekly pulse, latest report, open suggestions, agent memo). - name: Integrations description: >- Brand-scoped catalog of connectable providers plus which ones are already connected. Connect itself stays in Settings (`/integrations/{provider}`). - name: API Keys description: >- Mint, list, and revoke API keys through a signed-in Clerk session whose active organization role is exactly `org:admin`. API-key and OAuth actors receive `403`. `POST` body `brandId` is the new key's binding (the only v1 body field named `brandId`). - name: Meta description: >- Public discovery surface (no auth): the machine-readable API catalog (`/v1/help`). paths: /v1/automations/triggers/brew-events: post: tags: - Automations summary: Get or create an unsubscribe trigger description: >- Returns the brand’s trigger for one Brew event scope, creating it the first time. Brew events start automations from things that happen inside Brew. The first is `contact.unsubscribed`: a contact unsubscribed with an email’s unsubscribe link or their mail app’s one-click button (never a bounce, complaint, import or API edit). **Use when** an automation should start when a contact unsubscribes, from one marketing domain’s list or from every email the brand sends. **Input** `{ event: "contact.unsubscribed", scope: "domain", domainId }` for one marketing domain’s list (ids from `listDomains`), or `{ event: "contact.unsubscribed", scope: "all" }` for every email. An unsubscribe from all clicked in one of a domain’s emails also starts that domain’s trigger, while the contact was still on its list. **Returns** `201` with the new trigger row, or `200` with the existing one (`created: false`). Brew owns its title and payload, so the row is immutable and never fires over the API. The contact has just opted out, so an automation on this trigger sends only a message they need (such as confirming the unsubscribe) from a transactional domain, or mail from another marketing domain they are still on; publish refuses a flow none of whose emails could reach them. **Errors** `400 INVALID_REQUEST` when `domainId` is missing for `scope: "domain"` or sent for `scope: "all"`; `404 DOMAIN_NOT_FOUND` for an unknown or cross-brand domain; `422 DOMAIN_PURPOSE_NOT_ALLOWED` for a transactional domain, which owns no list; `409 TRIGGER_LIMIT_REACHED` when the brand already holds the maximum number of triggers. **See also** `createAutomation`, `fireTrigger`, `listDomains`. operationId: ensureBrewEventTrigger parameters: - name: Idempotency-Key in: header required: false description: >- Optional idempotency key for safe retries. Reusing the same key with the same request body returns the original response for 24 hours. schema: type: string minLength: 1 maxLength: 100 example: api-request-2026-04-08-001 - name: X-Brand-Id in: header required: false description: >- 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`. schema: type: string minLength: 1 maxLength: 64 example: kx7b3s7fapqz8mjm12ekz1kxdx87yceg requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BrewEventTriggersPostRequest' example: event: contact.unsubscribed scope: domain domainId: jd7f0c2a8w1x9m4n6p3q5r8s2t responses: '200': description: The trigger already existed for this scope. headers: x-request-id: schema: type: string description: >- Unique request identifier. Share this with support when debugging a request. example: req_8cac13fd94e6420cacdd75a1aa403a28 required: true description: >- Unique request identifier. Share this with support when debugging a request. X-RateLimit-Limit: schema: type: integer description: Requests allowed in the current rolling rate limit window. example: 100 required: true description: Requests allowed in the current rolling rate limit window. X-RateLimit-Remaining: schema: type: integer description: Requests remaining in the current rolling rate limit window. example: 99 required: true description: Requests remaining in the current rolling rate limit window. X-RateLimit-Reset: schema: type: integer description: >- Unix timestamp in seconds when the oldest recorded request leaves the rolling window. example: 1712592360 required: true description: >- Unix timestamp in seconds when the oldest recorded request leaves the rolling window. content: application/json: schema: $ref: '#/components/schemas/BrewEventTriggerSaved' example: triggerEventId: k57abc123unsub title: Unsubscribed from news.acme.com description: >- Starts when a contact unsubscribes from emails sent from news.acme.com, from an email's unsubscribe link or the mail app's unsubscribe button. Unsubscribing from all emails in one of those emails starts it too. provider: brew_event providerEventKey: contact.unsubscribed brewEvent: event: contact.unsubscribed scope: domain domainHost: news.acme.com payloadSchema: fields: - key: email required: true type: string - children: - key: scope required: true type: string - key: domain required: false type: string - key: method required: true type: string - key: reasons required: true type: array itemType: string - key: reasonText required: false type: string - key: emailId required: false type: string - key: emailTitle required: false type: string - key: sendId required: false type: string - key: at required: true type: string key: unsubscribe required: true type: object type: object createdAt: '2026-10-13T12:00:00.000Z' updatedAt: '2026-10-13T12:00:00.000Z' created: false '201': description: Created. headers: x-request-id: schema: type: string description: >- Unique request identifier. Share this with support when debugging a request. example: req_8cac13fd94e6420cacdd75a1aa403a28 required: true description: >- Unique request identifier. Share this with support when debugging a request. X-RateLimit-Limit: schema: type: integer description: Requests allowed in the current rolling rate limit window. example: 100 required: true description: Requests allowed in the current rolling rate limit window. X-RateLimit-Remaining: schema: type: integer description: Requests remaining in the current rolling rate limit window. example: 99 required: true description: Requests remaining in the current rolling rate limit window. X-RateLimit-Reset: schema: type: integer description: >- Unix timestamp in seconds when the oldest recorded request leaves the rolling window. example: 1712592360 required: true description: >- Unix timestamp in seconds when the oldest recorded request leaves the rolling window. content: application/json: schema: $ref: '#/components/schemas/BrewEventTriggerSaved' example: triggerEventId: k57abc123unsub title: Unsubscribed from news.acme.com description: >- Starts when a contact unsubscribes from emails sent from news.acme.com, from an email's unsubscribe link or the mail app's unsubscribe button. Unsubscribing from all emails in one of those emails starts it too. provider: brew_event providerEventKey: contact.unsubscribed brewEvent: event: contact.unsubscribed scope: domain domainHost: news.acme.com payloadSchema: fields: - key: email required: true type: string - children: - key: scope required: true type: string - key: domain required: false type: string - key: method required: true type: string - key: reasons required: true type: array itemType: string - key: reasonText required: false type: string - key: emailId required: false type: string - key: emailTitle required: false type: string - key: sendId required: false type: string - key: at required: true type: string key: unsubscribe required: true type: object type: object createdAt: '2026-10-13T12:00:00.000Z' updatedAt: '2026-10-13T12:00:00.000Z' created: true '400': description: >- `BRAND_ID_REQUIRED`: An organization-scoped credential called a brand-scoped operation without naming the brand. `INVALID_REQUEST`: The body or query failed validation: an unknown key, a wrong type, or a missing required field. `param` names the offender. headers: x-request-id: schema: type: string description: >- Unique request identifier. Share this with support when debugging a request. example: req_8cac13fd94e6420cacdd75a1aa403a28 required: true description: >- Unique request identifier. Share this with support when debugging a request. content: application/json: schema: $ref: '#/components/schemas/ApiErrorEnvelope' examples: brandIdRequired: summary: BRAND_ID_REQUIRED value: error: code: BRAND_ID_REQUIRED type: invalid_request message: >- An organization-scoped credential called a brand-scoped operation without naming the brand. suggestion: >- List brands with GET /v1/brands, then name one with the X-Brand-Id header. There is no default brand. docs: https://docs.brew.new/api-reference/api/authentication invalidRequest: summary: INVALID_REQUEST value: error: code: INVALID_REQUEST type: invalid_request message: >- The body or query failed validation: an unknown key, a wrong type, or a missing required field. `param` names the offender. suggestion: Fix the field reported in `param` and retry. docs: https://docs.brew.new/api-reference/api/errors '401': description: >- `API_KEY_REVOKED`: The API key was revoked. `AUTHENTICATION_REQUIRED`: No API key or session accompanied the request. `INVALID_API_KEY`: The API key is malformed or unknown. headers: x-request-id: schema: type: string description: >- Unique request identifier. Share this with support when debugging a request. example: req_8cac13fd94e6420cacdd75a1aa403a28 required: true description: >- Unique request identifier. Share this with support when debugging a request. content: application/json: schema: $ref: '#/components/schemas/ApiErrorEnvelope' examples: apiKeyRevoked: summary: API_KEY_REVOKED value: error: code: API_KEY_REVOKED type: authentication_error message: The API key was revoked. suggestion: Create a new active API key and retry. docs: https://docs.brew.new/api-reference/api/authentication authenticationRequired: summary: AUTHENTICATION_REQUIRED value: error: code: AUTHENTICATION_REQUIRED type: authentication_error message: No API key or session accompanied the request. suggestion: >- Provide a valid API key or sign in with an organization session. docs: https://docs.brew.new/api-reference/api/authentication invalidApiKey: summary: INVALID_API_KEY value: error: code: INVALID_API_KEY type: authentication_error message: The API key is malformed or unknown. suggestion: >- Check the API key format and retry with a valid active key. docs: https://docs.brew.new/api-reference/api/authentication '403': description: >- `ACCOUNT_SUSPENDED`: The organization behind the credential is suspended. `BRAND_SCOPE_MISMATCH`: A brand-scoped credential named a brand other than the one it is bound to. `INSUFFICIENT_PERMISSIONS`: The credential lacks the permission scope the operation needs. `INSUFFICIENT_ROLE`: The caller lacks the access the operation needs: `param` names `member` (access to the brand) or `org_admin` (the organization role). headers: x-request-id: schema: type: string description: >- Unique request identifier. Share this with support when debugging a request. example: req_8cac13fd94e6420cacdd75a1aa403a28 required: true description: >- Unique request identifier. Share this with support when debugging a request. content: application/json: schema: $ref: '#/components/schemas/ApiErrorEnvelope' examples: accountSuspended: summary: ACCOUNT_SUSPENDED value: error: code: ACCOUNT_SUSPENDED type: authorization_error message: The organization behind the credential is suspended. suggestion: >- The organization behind this credential is suspended. Contact support@brew.new; do not retry. docs: https://docs.brew.new/api-reference/api/authentication brandScopeMismatch: summary: BRAND_SCOPE_MISMATCH value: error: code: BRAND_SCOPE_MISMATCH type: authorization_error message: >- A brand-scoped credential named a brand other than the one it is bound to. suggestion: >- Omit the brand to use the one this credential is bound to, or use an organization-scoped credential to reach other brands. docs: https://docs.brew.new/api-reference/api/authentication insufficientPermissions: summary: INSUFFICIENT_PERMISSIONS value: error: code: INSUFFICIENT_PERMISSIONS type: authorization_error message: >- The credential lacks the permission scope the operation needs. suggestion: Use an API key or session with the required permission. docs: https://docs.brew.new/api-reference/api/authentication insufficientRole: summary: INSUFFICIENT_ROLE value: error: code: INSUFFICIENT_ROLE type: authorization_error message: >- The caller lacks the access the operation needs: `param` names `member` (access to the brand) or `org_admin` (the organization role). suggestion: >- Ask an organization admin to run this, to add you to the brand, or to make you an admin. docs: https://docs.brew.new/api-reference/api/authentication '404': description: >- `BRAND_NOT_FOUND`: The named or bound brand does not exist in this organization (unknown, deleting, or another organization). `DOMAIN_NOT_FOUND`: No domain with that id exists in the brand. headers: x-request-id: schema: type: string description: >- Unique request identifier. Share this with support when debugging a request. example: req_8cac13fd94e6420cacdd75a1aa403a28 required: true description: >- Unique request identifier. Share this with support when debugging a request. content: application/json: schema: $ref: '#/components/schemas/ApiErrorEnvelope' examples: brandNotFound: summary: BRAND_NOT_FOUND value: error: code: BRAND_NOT_FOUND type: not_found message: >- The named or bound brand does not exist in this organization (unknown, deleting, or another organization). suggestion: >- List the brands this credential can reach with GET /v1/brands. docs: https://docs.brew.new/api-reference/api/errors domainNotFound: summary: DOMAIN_NOT_FOUND value: error: code: DOMAIN_NOT_FOUND type: not_found message: No domain with that id exists in the brand. suggestion: Use GET /v1/domains to choose a verified domain. docs: https://docs.brew.new/api-reference/api/errors '409': description: >- `IDEMPOTENCY_CONFLICT`: The same Idempotency-Key was reused with a different request body. `IDEMPOTENCY_IN_PROGRESS`: A request with this Idempotency-Key is still executing. `TRIGGER_LIMIT_REACHED`: The brand already holds the maximum number of trigger events. headers: x-request-id: schema: type: string description: >- Unique request identifier. Share this with support when debugging a request. example: req_8cac13fd94e6420cacdd75a1aa403a28 required: true description: >- Unique request identifier. Share this with support when debugging a request. content: application/json: schema: $ref: '#/components/schemas/ApiErrorEnvelope' examples: idempotencyConflict: summary: IDEMPOTENCY_CONFLICT value: error: code: IDEMPOTENCY_CONFLICT type: conflict message: >- The same Idempotency-Key was reused with a different request body. suggestion: >- Reuse the original payload or send a new idempotency key. docs: https://docs.brew.new/api-reference/api/idempotency idempotencyInProgress: summary: IDEMPOTENCY_IN_PROGRESS value: error: code: IDEMPOTENCY_IN_PROGRESS type: conflict message: A request with this Idempotency-Key is still executing. suggestion: >- Wait for the original request to finish, then retry the same key to replay its response. docs: https://docs.brew.new/api-reference/api/idempotency triggerLimitReached: summary: TRIGGER_LIMIT_REACHED value: error: code: TRIGGER_LIMIT_REACHED type: conflict message: >- The brand already holds the maximum number of trigger events. suggestion: >- Delete an unused trigger with `DELETE /v1/automations/triggers/{triggerEventId}`, then retry. Each brand holds at most 100. docs: https://docs.brew.new/api-reference/api/errors '422': description: >- `DOMAIN_PURPOSE_NOT_ALLOWED`: The sending domain is admitted for a different purpose than this send (marketing vs transactional). headers: x-request-id: schema: type: string description: >- Unique request identifier. Share this with support when debugging a request. example: req_8cac13fd94e6420cacdd75a1aa403a28 required: true description: >- Unique request identifier. Share this with support when debugging a request. content: application/json: schema: $ref: '#/components/schemas/ApiErrorEnvelope' examples: domainPurposeNotAllowed: summary: DOMAIN_PURPOSE_NOT_ALLOWED value: error: code: DOMAIN_PURPOSE_NOT_ALLOWED type: invalid_request message: >- The sending domain is admitted for a different purpose than this send (marketing vs transactional). suggestion: >- Use a marketing domain for campaigns and audience sends. For transactional flows, wire the design into a published automation with a trigger and fire POST /v1/automations/triggers/{triggerEventId}/fire. docs: https://docs.brew.new/api-reference/api/errors '429': description: >- `RATE_LIMITED`: The credential exhausted the rolling window for this route policy; Retry-After is when the oldest recorded request leaves, and the refused request does not take a slot. headers: x-request-id: schema: type: string description: >- Unique request identifier. Share this with support when debugging a request. example: req_8cac13fd94e6420cacdd75a1aa403a28 required: true description: >- Unique request identifier. Share this with support when debugging a request. X-RateLimit-Limit: schema: type: integer description: Requests allowed in the current rolling rate limit window. example: 60 required: true description: Requests allowed in the current rolling rate limit window. X-RateLimit-Remaining: schema: type: integer description: Requests remaining in the current rolling rate limit window. example: 0 required: true description: Requests remaining in the current rolling rate limit window. X-RateLimit-Reset: schema: type: integer description: >- Unix timestamp in seconds when the oldest recorded request leaves the rolling window. example: 1712592360 required: true description: >- Unix timestamp in seconds when the oldest recorded request leaves the rolling window. Retry-After: schema: type: integer description: Seconds to wait before retrying the request. example: 42 required: true description: Seconds to wait before retrying the request. content: application/json: schema: $ref: '#/components/schemas/ApiErrorEnvelope' examples: rateLimited: summary: RATE_LIMITED value: error: code: RATE_LIMITED type: rate_limit message: >- The credential exhausted the rolling window for this route policy; Retry-After is when the oldest recorded request leaves, and the refused request does not take a slot. suggestion: Wait the Retry-After time, then retry the same request. docs: https://docs.brew.new/api-reference/api/rate-limits retryAfter: 42 details: scope: credential limit: 60 remaining: 0 reset: 1712592360 consumed: false '500': description: >- `INTERNAL_ERROR`: An unexpected failure; the x-request-id header identifies it. headers: x-request-id: schema: type: string description: >- Unique request identifier. Share this with support when debugging a request. example: req_8cac13fd94e6420cacdd75a1aa403a28 required: true description: >- Unique request identifier. Share this with support when debugging a request. content: application/json: schema: $ref: '#/components/schemas/ApiErrorEnvelope' examples: internalError: summary: INTERNAL_ERROR value: error: code: INTERNAL_ERROR type: internal_error message: >- An unexpected failure; the x-request-id header identifies it. suggestion: >- Retry the request. If it keeps failing, contact support with the x-request-id header. docs: https://docs.brew.new/api-reference/api/errors components: schemas: BrewEventTriggersPostRequest: type: object properties: event: type: string enum: - contact.unsubscribed description: >- The Brew event. `contact.unsubscribed`: a contact unsubscribed with an email unsubscribe link or their mail app’s unsubscribe button. scope: type: string enum: - domain - all description: >- `domain`: unsubscribes from one marketing sending domain (pass `domainId`). `all`: unsubscribes from every email the brand sends. domainId: type: string minLength: 1 description: >- The marketing domain (from `GET /v1/domains`) whose unsubscribe list this trigger watches. Required when `scope` is `domain`; omit for `all`. required: - event - scope additionalProperties: false BrewEventTriggerSaved: type: object properties: triggerEventId: type: string minLength: 1 maxLength: 256 title: type: string minLength: 1 maxLength: 120 description: type: string maxLength: 2000 provider: type: string enum: - brew_api - clerk - stripe - shopify - stytch - supabase - workos - framer - revenuecat - custom - brew_event providerEventKey: type: string brewEvent: type: object properties: event: type: string enum: - contact.unsubscribed description: The Brew event this trigger starts on. scope: type: string enum: - domain - all description: >- `domain`: unsubscribes from one marketing sending domain (its list). `all`: unsubscribes from every email the brand sends. domainHost: type: string minLength: 1 description: >- The sending domain whose list this trigger watches, e.g. `news.acme.com`. Present only when `scope` is `domain`. required: - event - scope additionalProperties: false payloadSchema: type: object properties: type: type: string enum: - object fields: type: array items: $ref: '#/components/schemas/TriggerPayloadField' required: - type - fields createdAt: type: string format: date-time updatedAt: type: string format: date-time skill: type: string created: type: boolean description: >- True when this call created the trigger; false when it already existed. required: - triggerEventId - title - provider - payloadSchema - createdAt - updatedAt - created additionalProperties: false ApiErrorEnvelope: type: object properties: error: type: object properties: code: $ref: '#/components/schemas/ApiErrorCode' type: type: string enum: - authentication_error - authorization_error - invalid_request - not_found - not_implemented - conflict - rate_limit - payment_required - service_unavailable - internal_error message: type: string minLength: 1 param: type: string minLength: 1 suggestion: type: string minLength: 1 docs: type: string format: uri retryAfter: type: integer minimum: 0 details: type: object additionalProperties: {} required: - code - type - message - suggestion - docs required: - error TriggerPayloadField: type: object properties: key: type: string minLength: 1 description: >- Variable name used by emails and automations, e.g. email or firstName. Prefer self-descriptive keys; this column has no separate description field. type: type: string enum: - string - int - boolean - object - array required: type: boolean description: >- True when the inbound payload must carry this key for the trigger to fire. fallbackValue: anyOf: - type: string - type: number - type: boolean description: >- Substitution value when the inbound payload is missing this field. Also used as the email agent's `e.g. {{ key | fallback }}` example. Scalar leaves only. pii: type: string enum: - none - low - high description: >- PII classification for redaction. "high" auto-redacts the value in execution logs and the inbound log. "low" (default when omitted) preserves the value. "none" is an explicit marker that the field is non-personal. On a container, "high" redacts the whole subtree. children: type: array items: $ref: '#/components/schemas/TriggerPayloadField' description: >- Nested field nodes for type "object", or the element shape for an array of objects. Emails reference nested leaves as dotted paths ({{ order.total }}) and arrays via {% for %}. itemType: type: string enum: - string - int - boolean description: >- Element type for a type "array" of scalars. Omit when the array carries objects (declare `children` instead). required: - key - type - required ApiErrorCode: type: string enum: - ACCOUNT_SUSPENDED - API_KEY_REVOKED - AUDIENCE_BUILD_ACTIVE - AUDIENCE_BUILD_ALREADY_ACTIVE - AUDIENCE_EDIT_CONFLICT - AUDIENCE_MEMBERSHIP_NOT_EXPRESSIBLE - AUDIENCE_NOT_FOUND - AUDIENCE_RUN_NOT_FOUND - AUDIT_NOT_FOUND - AUTHENTICATION_REQUIRED - AUTOMATION_GRAPH_INVALID - AUTOMATION_NOT_FOUND - AUTOMATION_NOT_PAUSABLE - AUTOMATION_NOT_PUBLISHED - AUTOMATION_RUN_NOT_FOUND - AUTOMATION_VERSION_CONFLICT - AUTOMATION_VERSION_NOT_FOUND - BATCH_TOO_LARGE - BRAND_DOMAIN_CONFLICT - BRAND_ID_REQUIRED - BRAND_LIMIT_REACHED - BRAND_NOT_FOUND - BRAND_NOT_READY - BRAND_SCOPE_MISMATCH - CHAT_NOT_FOUND - COMMENT_NOT_FOUND - CONSENT_REQUIRED - CONTACT_NOT_FOUND - CONTENT_OPERATION_FAILED - CONTRACT_LOCKED_BY_PUBLISHED_AUTOMATIONS - CORE_FIELD_IMMUTABLE - DOMAIN_ALREADY_EXISTS - DOMAIN_CLAIMED_ELSEWHERE - DOMAIN_NOT_FOUND - DOMAIN_NOT_READY - DOMAIN_OTHER_BRAND - DOMAIN_PROVIDER_ERROR - DOMAIN_PURPOSE_NOT_ALLOWED - DOMAIN_VERIFICATION_FAILED - DOMAIN_VERIFIED_ELSEWHERE - EMAIL_GENERATION_FAILED - EMAIL_GROUP_NAME_CONFLICT - EMAIL_GROUP_NOT_FOUND - EMAIL_IMAGES_MISSING - EMAIL_IMPORT_FAILED - EMAIL_IN_PROGRESS - EMAIL_IN_USE_BY_AUTOMATION - EMAIL_NOT_FOUND - EMAIL_NOT_READY - EMAIL_RUN_AMBIGUOUS - EMAIL_TEMPLATE_INVALID - EMAIL_VERSION_NOT_FOUND - EXPORT_PROVIDER_ERROR - EXPORT_UNSUPPORTED - FIELD_NOT_FOUND - FIELD_TYPE_MISMATCH - FIGMA_ACCESS_DENIED - FIGMA_CONVERSION_FAILED - FIGMA_FRAME_NOT_FOUND - FIGMA_NOT_CONNECTED - FIGMA_UNAVAILABLE - FIGMA_URL_INVALID - FLOW_NOT_FOUND - IDEMPOTENCY_CONFLICT - IDEMPOTENCY_IN_PROGRESS - INSIGHT_NOT_FOUND - INSUFFICIENT_CREDITS - INSUFFICIENT_PERMISSIONS - INSUFFICIENT_ROLE - INTEGRATION_NOT_CONNECTED - INTERNAL_ERROR - INVALID_API_KEY - INVALID_EMAIL - INVALID_PAYLOAD - INVALID_REQUEST - LIQUID_RENDER_ERROR - METHOD_NOT_ALLOWED - MISSING_EMAIL - NO_ELIGIBLE_RECIPIENTS - NO_PUBLISHED_AUTOMATION - NOT_FOUND - NOT_IMPLEMENTED - ORG_SCOPE_REQUIRED - PAYLOAD_SCHEMA_EMAIL_REQUIRED - PAYLOAD_TOO_LARGE - PREVIEW_NOT_FOUND - PUBLISH_VALIDATION_FAILED - RATE_LIMITED - RECIPIENT_UNSUBSCRIBED - REFERENCE_EMAIL_NOT_FOUND - RESUBSCRIBE_NOT_ALLOWED - RUN_IN_PROGRESS - RUN_NOT_CANCELLABLE - RUN_NOT_PAUSABLE - RUN_NOT_PAUSED - RUN_NOT_RESUMABLE - RUN_START_FAILED - RUN_STOP_FAILED - SEND_NOT_CANCELLABLE - SEND_NOT_FOUND - SEND_NOT_PAUSABLE - SEND_NOT_RESUMABLE - SEND_QUOTA_EXCEEDED - SERVICE_UNAVAILABLE - TEMPLATE_NOT_FOUND - TRIGGER_ALREADY_EXISTS - TRIGGER_EVENT_NOT_FOUND - TRIGGER_HAS_DEPENDENT_AUTOMATIONS - TRIGGER_IMMUTABLE - TRIGGER_INSTANCE_NOT_FOUND - TRIGGER_LIMIT_REACHED - TRIGGER_NOT_FIREABLE - UPLOAD_IN_PROGRESS - UPLOAD_NOT_FOUND - UPLOAD_NOT_RECEIVED securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API key description: 'Send your Brew API key as `Authorization: Bearer brew_xxx`.' x-default: Bearer brew_your_api_key apiKeyAuth: type: apiKey in: header name: X-API-Key description: 'Send your Brew API key as `X-API-Key: brew_xxx`.' x-default: brew_your_api_key ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.