Create a webhook
POST
/webhooksAutorización
AuthorizationToken Bearer · headerobligatorioA BillionSend API key (bs_…).
Cuerpo de la solicitud
obligatorioapplication/jsonendpointstring<uri>obligatoriolongitud máx. 2048
eventsstring[]obligatoriomín. 1 elementos
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 elementos
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.
Respuestas
200
Webhook created; signing_secret is also retrievable via GET /webhooks/{id}
objectstringobligatorioValores permitidos:
webhookidstring<uuid>obligatoriosigning_secretstringobligatorio401
Missing, malformed, unknown or revoked API key
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorio403
Plan webhook endpoint limit reached
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorio422
Validation error
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorio429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorio