Skip to main content
PATCH
Update webhook

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

webhookId
string
required

Body

application/json
endpoint
string<uri>
Maximum string length: 2048
events
enum<string>[]
Required array length: 1 - 8 elements
Available options:
email.sent,
email.delivered,
email.delivery_delayed,
email.bounced,
email.complained,
email.failed,
email.opened,
email.clicked
description
string
Maximum string length: 256
status
enum<string>
Available options:
enabled,
disabled

Response

Success

id
string
required
endpoint
string
required
events
enum<string>[]
required
Available options:
email.sent,
email.delivered,
email.delivery_delayed,
email.bounced,
email.complained,
email.failed,
email.opened,
email.clicked
description
string
required
status
enum<string>
required
Available options:
enabled,
disabled
created_at
string<date-time>
required