Webhook Events

Email bounced

A delivery failure report for mail the mailbox sent arrived: the receiving server refused it for a recipient. Fires for every send from the mailbox, once per failed recipient. Delayed-delivery warnings and out-of-office replies do not fire it.

Act on recommendedAction: remove means the address does not take mail. Refusals on the sending side (auth_failure, blocklisted, spam_blocked, policy_blocked) never say remove. The report also arrives as message.received, and it does not count as a reply for email.thread_replied.

postWebhookemail.bounced

Payload

idstring required
testboolean

Always true when present: only a sample sent by POST /v1/webhooks/test with an event carries it. Real deliveries never do.

event'email.bounced' required
timestampstring date-time required

Example payload

{
  "profiles": [
    {
      "externalId": "tenant_42"
    }
  ]
}

Response

Webhook received successfully

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.