Create a webhook
POST
/webhooksAutorisierung
AuthorizationBearer-Token · headererforderlichA BillionSend API key (bs_…).
Request-Body
erforderlichapplication/jsonendpointstring<uri>erforderlichmax. Länge 2048
eventsstring[]erforderlichmin. 1 Elemente
inbox_idsstring<uuid>[] | nullBillionSend extension: inbox events and email.received reach this endpoint only for these inboxes of the team (at most 100). null means every inbox. Omitted: every inbox.
max. 100 Elemente
signing_secretstringSigning secret to use instead of minting one: whsec_ followed by base64 of 24-64 bytes (the Standard Webhooks format). An existing secret carried over keeps the receiver verifying unchanged; when omitted, a new one is generated.
Antworten
200
Webhook created; signing_secret is also retrievable via GET /webhooks/{id}
objectstringerforderlichErlaubt:
webhookidstring<uuid>erforderlichsigning_secretstringerforderlich401
Missing, malformed, unknown or revoked API key
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlich403
Plan webhook endpoint limit reached
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlich422
Validation error
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlich429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlich