Create a webhook endpoint
POST
Register an http(s) endpoint to receive email events. The signing_secret (whsec_…) is returned once, only here. Store it to verify delivery signatures. Needs the manage:webhooks scope, which can be minted onto a live API key. An API key may subscribe only to events its read scopes cover: email.received needs read:inbound, and every other event type needs send or read:emails. Otherwise the call returns 403 insufficient_scope. Dashboard sessions are not limited this way.
Loading code example
Loading code example
Authorizations
Authorizationstringheaderrequired
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
urlstringrequiredDestination URL; must be an http(s) URL.
eventsarray<"email.delivered" | "email.bounced" | "email.complained" | "email.failed" | "email.delivery_delayed" | "email.opened" | "email.clicked" | "email.suppressed" | "email.unsubscribed" | "email.received">requiredThe event types to subscribe to.
Required array length:
>= 1 elementsResponse
application/json
The webhook endpoint was created.