API Referencewebhooks

Create a webhook

View as Markdown

Create a signed webhook endpoint. The signing secret is returned once; store it securely and verify every delivery signature.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Headers

BCTRL-Subaccount-IdstringOptional
Optional effective subaccount context for organization API keys. Subaccount API keys are already scoped and cannot use this header to act as another subaccount.

Request

This endpoint expects an object.
eventslist of enumsRequired
urlstringRequiredformat: "uri"<=2048 characters
namestringOptional1-80 characters

Response

Created
createdAtdatetime
RFC 3339 timestamp with a UTC offset.
enabledboolean
eventslist of enums
idstring
Unique webhook identifier generated by BCTRL.
namestring or null1-80 characters
secretstring
subaccountIdstring or null
updatedAtdatetime
RFC 3339 timestamp with a UTC offset.
urlstringformat: "uri"<=2048 characters

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error