Skip to main content

Event

idstringrequired

Unique event identifier.

typestringrequired

Event type.

Possible values: [email.sent, email.delivered, email.bounced, email.opened, email.clicked, email.complained, email.failed, email.delayed]

email_idstringrequired

ID of the email this event belongs to.

created_atstring<date-time>required

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
property name*any

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
{
  "id": "string",
  "type": "email.sent",
  "email_id": "string",
  "created_at": "2024-07-29T15:51:28.071Z",
  "data": {}
}