Create a webhook
POST
/webhooksAuthorization
AuthorizationBearer token · headerrequiredA BillionSend API key (bs_…).
Request body
requiredapplication/jsonendpointstring<uri>requiredmax length 2048
eventsstring[]requiredmin items 1
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 items 100
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.
Responses
200
Webhook created; signing_secret is also retrievable via GET /webhooks/{id}
objectstringrequiredAllowed:
webhookidstring<uuid>requiredsigning_secretstringrequired401
Missing, malformed, unknown or revoked API key
statusCodenumberrequirednamestringrequiredmessagestringrequired403
Plan webhook endpoint limit reached
statusCodenumberrequirednamestringrequiredmessagestringrequired422
Validation error
statusCodenumberrequirednamestringrequiredmessagestringrequired429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberrequirednamestringrequiredmessagestringrequired