email.failed
Webhook event triggered when an email fails to send.
The email.failed event is triggered when an email fails to be sent due to a permanent error.
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.failed).
created_at string
ISO 8601 timestamp when the webhook event was created.
data object
Contains the event-specific details such as email ID and error information.
Handling this event
When your endpoint receives an email.failed event, you might want to:
- Notify the user about the failure.
- Check the error details for troubleshooting.
- Update the status in your internal database.
{
"type": "email.failed",
"created_at": "2023-01-01T12:00:00Z",
"data": {
"email_id": "em_123456789",
"to": ["recipient@example.com"],
"error": {
"code": "invalid_recipient",
"message": "The recipient address is invalid."
},
"timestamp": "2023-01-01T12:00:00Z"
}
}Learn More
Was this page helpful?