webhooks

Create a webhook endpoint

Registers an HTTPS endpoint. Endpoints receive every event type (message.received, sms.received, domain.verified, endpoint.test) — there is no per-endpoint event filter — and payloads never contain message bodies. Deliveries are signed X-MailFixture-Signature: t=<unix>,v1=<hmac-sha256> with the endpoint's secret; 8 attempts with backoff, and 5 consecutively exhausted deliveries auto-disable the endpoint.

post/v1/webhooks

Request

  • Base URL: https://api.mailfixture.com
  • URL: https://api.mailfixture.com/v1/webhooks
  • Auth: HTTP bearer

Request body

descriptionstring

Optional; blank is treated as none.

urlstring uri required

Must be https and resolve to a public IP.

Response

Endpoint created — save secret now; lists only ever show a hint.

created_atstring date-time required
descriptionstring nullable required
idstring uuid required
secretstring required

Signing secret (whsec_…) — shown exactly once; lists only carry a hint.

urlstring required

Changes

No recorded changes to this operation across all 1 revision of this API.