Mailfully logo

Create a webhook endpoint

POSThttps://api.mailfully.com/v1/webhooks

Register an http(s) endpoint to receive email events. The signing_secret (whsec_…) is returned once, only here. Store it to verify delivery signatures. Dashboard only (owner, admin, or member). API keys get 403 insufficient_scope.

Loading code example
Loading code example

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

urlstringrequired

Destination 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">required

The event types to subscribe to.

Required array length: >= 1 elements

Response

application/json

The webhook endpoint was created.