email.scheduled
Webhook event triggered when an email is scheduled.
The email.scheduled event is triggered when an email's status changes to scheduled.
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.scheduled).
created_at string
ISO 8601 timestamp when the webhook event was created.
data object
Contains the event-specific details such as email ID, recipients, and status.
Handling this event
When your endpoint receives an email.scheduled event, you might want to:
- Update the status in your internal database.
- Trigger an automated follow-up workflow.
- Log the event for analytics purposes.
{
"type": "email.scheduled",
"created_at": "2023-01-01T12:00:00Z",
"data": {
"email_id": "em_123456789",
"from": "sender@example.com",
"to": ["recipient@example.com"],
"subject": "Hello World",
"status": "scheduled",
"timestamp": "2023-01-01T12:00:00Z"
}
}Learn More
Was this page helpful?