email.suppressed
Webhook event triggered when an email is suppressed.
The email.suppressed event is triggered when an email is suppressed and not delivered because the recipient is on the suppression list.
Event Details
All webhook payloads follow a consistent top-level structure with event-specific data nested within the data object.
type string
The event type that triggered the webhook (e.g., email.suppressed).
created_at string
ISO 8601 timestamp when the webhook event was created.
data object
Contains the event-specific details such as email ID and suppression reason.
Handling this event
When your endpoint receives an email.suppressed event, you might want to:
- Update the status in your internal database.
- Notify the user why the email wasn't delivered.
- Check your suppression list for the recipient.
{
"type": "email.suppressed",
"created_at": "2023-01-01T12:00:00Z",
"data": {
"email_id": "em_123456789",
"to": ["recipient@example.com"],
"reason": "Previous hard bounce",
"timestamp": "2023-01-01T12:00:00Z"
}
}Learn More
Was this page helpful?