Create a webhook
POST
/webhooksAutorização
AuthorizationToken Bearer · headerobrigatórioA BillionSend API key (bs_…).
Corpo da requisição
obrigatórioapplication/jsonendpointstring<uri>obrigatóriocomprimento máx. 2048
eventsstring[]obrigatóriomín. 1 itens
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.
máx. 100 itens
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.
Respostas
200
Webhook created; signing_secret is also retrievable via GET /webhooks/{id}
objectstringobrigatórioValores permitidos:
webhookidstring<uuid>obrigatóriosigning_secretstringobrigatório401
Missing, malformed, unknown or revoked API key
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório403
Plan webhook endpoint limit reached
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório422
Validation error
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório