Skip to main content
PATCH
Update a webhook endpoint

Authorizations

X-API-Key
string
header
required

An organization API key, prefixed bk_live_. Takes precedence over Authorization when both are sent. The key is bound to one organization, and the scopes it was issued with are enforced per endpoint.

Headers

X-Organization-Id
string<uuid>

Required when authenticating with an access token. Optional with an API key, whose own organization binding is authoritative; a value contradicting it is refused with 403.

Path Parameters

id
string
required

Body

application/json
url
string
Minimum string length: 2
description
string | null
events
enum<string>[]
Available options:
email.delivered,
email.bounced,
email.opened,
email.clicked,
email.marked_spam,
email.unsubscribed,
email.dropped,
email.deferred,
email.rejected,
email.complained,
contact.subscribed,
contact.unsubscribed,
contact.updated,
campaign.sent,
campaign.completed,
test.event
isActive
boolean
customHeaders
object[] | null
timeoutSeconds
number
Required range: 0 <= x <= 300
maxRetries
number
Required range: 0 <= x <= 20

Response

success
boolean
required
Example:

true

message
string
required
data
object
required