Zum Inhalt springen
Esc
↑↓navigieren↵öffnen⌘Jvorschau

Create a webhook

POST/webhooks
Autorisierung
AuthorizationBearer-Token · headererforderlich

A BillionSend API key (bs_…).

Request-Body
erforderlichapplication/json
endpointstring<uri>erforderlich
max. Länge 2048
eventsstring[]erforderlich
min. 1 Elemente
inbox_idsstring<uuid>[] | null

BillionSend 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_secretstring

Signing 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}

objectstringerforderlich
Erlaubt:webhook
idstring<uuid>erforderlich
signing_secretstringerforderlich
401

Missing, malformed, unknown or revoked API key

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
403

Plan webhook endpoint limit reached

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
422

Validation error

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
429

Over the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
Ausprobieren
Server
Autorisierung
Bodyapplication/json
Anfrage
curl -X POST 'https://api.billionsend.com/webhooks' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "endpoint": "http://example.com",
  "events": [
    "email.scheduled"
  ],
  "inbox_ids": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "signing_secret": "string"
}'
Antwort
{
  "object": "webhook",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "signing_secret": "string"
}

War diese Seite hilfreich?