EventListResponse
data object[]required
Unique event identifier.
Every event type the platform emits. email.* events carry an email_id, except email.received, which fires for inbound mail and carries an inbound_id. domain.* and tracking_domain.* events carry a domain_id. campaign.* events carry a campaign_id, contact.* events a contact_id, and suppression.* events the suppressed address; these three families are workspace-wide and carry neither an email_id nor a domain_id. webhook.test is delivered by the test-endpoint operation and cannot be subscribed to. Treat this enum as open: clients must tolerate a value added by a later release rather than failing to decode the surrounding object.
Possible values: [email.sent, email.delivered, email.bounced, email.opened, email.clicked, email.complained, email.failed, email.delayed, email.cancelled, email.received, domain.verified, domain.verification_failed, tracking_domain.verified, tracking_domain.verification_failed, campaign.started, campaign.paused, campaign.resumed, campaign.completed, campaign.cancelled, campaign.auto_paused, contact.status_changed, contact.import_completed, suppression.created, suppression.removed, webhook.test]
ID of the email this event belongs to. Present for every email.* event and absent for email.received and webhook.test.
ID of the inbound message. Present only on email.received.
When the event occurred.
data objectrequired
Event-specific data. Structure varies by event type:
- delivered: to, from, subject, delivered_at, smtp_code, mx_host
- bounced: to, bounce_type, bounce_subtype, smtp_code, enhanced_status_code, provider, recommended_action, original_error
- opened: to, ip_address, user_agent, open_source
- clicked: to, url, ip_address, user_agent, click_count
- complained: to, bounce_type
- sent/failed/delayed: event metadata
Event-specific data. Structure varies by event type:
- delivered: to, from, subject, delivered_at, smtp_code, mx_host
- bounced: to, bounce_type, bounce_subtype, smtp_code, enhanced_status_code, provider, recommended_action, original_error
- opened: to, ip_address, user_agent, open_source
- clicked: to, url, ip_address, user_agent, click_count
- complained: to, bounce_type
- sent/failed/delayed: event metadata
Whether there are more items available after this page.
Cursor to use as starting_after for the next page.
{
"data": [
{
"id": "string",
"type": "email.sent",
"email_id": "string",
"inbound_id": "string",
"created_at": "2024-07-29T15:51:28.071Z",
"data": {}
}
],
"has_more": true,
"next_cursor": "string"
}