Guides

Webhooks

Receive events as they happen and verify each request with its signature.

Event types

Subscribe to the events your system needs. Each event carries the message id and a timestamp.

Payloads are JSON sent with a POST request. [Confirm final schema]

{
  "event": "delivered",
  "message_id": "[id]",
  "recipient": "you@example.com",
  "timestamp": "[ISO 8601]"
}

Compute an HMAC of the raw body with your signing secret and compare it with the signature header. Reject requests that do not match.

Respond with a 2xx status within [N] seconds. Failed deliveries are retried. [Confirm schedule]

EventMeaning

deliveredThe receiving server accepted the message.

bouncedThe message could not be delivered.

deferredA temporary failure; delivery will be retried.

openedThe recipient opened the message.

clickedThe recipient clicked a tracked link.

complainedThe recipient reported the message as spam.

Was this page helpful?Contact support