You're in the right place! Segment documentation is now part of Twilio Docs. The content you are used to is still here—just in a new home with a refreshed look.

Spec: Email Events

This guide explains what data should be sent to Segment from Email tools and hence is targeted to partners who send Email data back into Segment rather than targeted to customers themselves. The semantic events detailed below represent the ideal for Email events; not every Email tool supports all of these events or all of their properties.

Overview

Every Email tool is built around the idea of delivering emails to recipients. A user sends one or many emails through an email tool, and the email is either delivered to a recipient or bounces if the email is undeliverable.

When an email is delivered, a recipient can take one or many actions on it: They might open the email, click on a link in the email's body, mark the email as spam, or unsubscribe

Events

The email category has the following semantic events:

Email Bounced

This event should be sent when an email tool receives notice from an email server that an email is undeliverable.

Properties

This event supports the following semantic properties:

Property	Type	Description
`email_id`	String	An ID used to identify the email.
`email_subject`	String	The email's subject line.
`campaign_id`	String	An id used to identify a campaign
`campaign_name`	String	A name used to identify a campaign

Context

This event supports the following semantic context properties:

Property	Type	Description
`context.traits`	Object	An associative array about the email's intended recipient.
`context.traits.email`	String	The intended recipient's email address.

Example

1{
2  "user_id": "019mr8mf4r",
3  "action": "track",
4  "event": "Email Bounced",
5  "context": {
6    "ip": "67.207.109.102",
7    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.118 Safari/537.36",
8    "traits": {
9      "email": "pgibbons@example.com"
10    }
11  },
12  "properties": {
13    "email_id": "18vzF7u3z",
14    "email_subject": "First shirt on us!",
15    "campaign_id": "123",
16    "campaign_name": "New Customer Discount"
17  }
18}

Email Delivered

This event should be fired when the receiving mail server confirms receipt of an email.

Properties

This event supports the following semantic properties:

Property	Type	Description
`email_id`	String	An ID used to identify the email.
`email_subject`	String	The email's subject line.
`campaign_id`	String	An id used to identify a campaign
`campaign_name`	String	A name used to identify a campaign

Context

This event supports the following semantic context properties:

Property	Type	Description
`context.traits`	Object	An associative array about the email's intended recipient.
`context.traits.email`	String	The intended recipient's email address.

Example

1{
2  "user_id": "019mr8mf4r",
3  "action": "track",
4  "event": "Email Delivered",
5  "context": {
6    "ip": "67.207.109.102",
7    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.118 Safari/537.36",
8    "traits": {
9      "email": "pgibbons@example.com"
10    }
11  },
12  "properties": {
13    "email_id": "18vzF7u3z",
14    "email_subject": "First shirt on us!",
15    "campaign_id": "123",
16    "campaign_name": "New Customer Discount"
17  }
18}

Email Link Clicked

This event should be fired when the recipient clicks on a link in the email's body.

Properties

This event supports the following semantic properties:

Property	Type	Description
`email_id`	String	An ID used to identify the email.
`email_subject`	String	The email's subject line.
`campaign_id`	String	An id used to identify a campaign
`campaign_name`	String	A name used to identify a campaign
`link_id`	String	An id used to identify a link
`link_url`	String	The URL the link points to.

Context

This event supports the following semantic context properties:

Property	Type	Description
`context.ip`	Object	The opening computer's public IP address.
`context.traits`	Object	An associative array describing the email's intended recipient.
`context.traits.email`	String	The intended recipient's email address.
`context.user_agent`	String	The opening browser's user agent.

Example

1{
2  "user_id": "019mr8mf4r",
3  "action": "track",
4  "event": "Email Link Clicked",
5  "context": {
6    "ip": "67.207.109.102",
7    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.118 Safari/537.36",
8    "traits": {
9      "email": "joanna@chotchkies.com"
10    }
11  },
12  "properties": {
13    "email_id": "18vzF7u3z",
14    "email_subject": "First shirt on us!",
15    "campaign_id": "123",
16    "campaign_name": "New Customer Discount",
17    "link_id": "101",
18    "link_url": "https://www.buymyshirts.com?promo=NEWCUSTOMER"
19  }
20}

Email Marked as Spam

This event should be fired when a recipient marks an email as spam.

Properties

This event supports the following semantic properties:

Property	Type	Description
`email_id`	String	An ID used to identify the email.
`email_subject`	String	The email's subject line.
`campaign_id`	String	An id used to identify a campaign
`campaign_name`	String	A name used to identify a campaign

Context

This event supports the following semantic context properties:

Property	Type	Description
`context.ip`	Object	The opening computer's public IP address.
`context.traits`	Object	An associative array describing the email's intended recipient.
`context.traits.email`	String	The intended recipient's email address.
`context.user_agent`	String	The opening browser's user agent.

Example

1{
2  "user_id": "019mr8mf4r",
3  "action": "track",
4  "event": "Email Marked as Spam",
5  "context": {
6    "ip": "67.207.109.102",
7    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.118 Safari/537.36",
8    "traits": {
9      "email": "mwaddams@example.com"
10    }
11  },
12  "properties": {
13    "email_id": "18vzF7u3z",
14    "email_subject": "First shirt on us!",
15    "campaign_id": "123",
16    "campaign_name": "New Customer Discount"
17  }
18}

Email Opened

This event should be fired when the recipient opens the email.

Properties

This event supports the following semantic properties:

Property	Type	Description
`email_id`	String	An ID used to identify the email.
`email_subject`	String	The email's subject line.
`campaign_id`	String	An id used to identify a campaign
`campaign_name`	String	A name used to identify a campaign

Context

This event supports the following semantic context properties:

Property	Type	Description
`context.ip`	String	The opening computer's public IP address.
`context.traits`	Object	An associative array describing the email's intended recipient.
`context.traits.email`	String	The intended recipient's email address.
`context.user_agent`	String	The opening browser's user agent.

Example

1{
2  "user_id": "019mr8mf4r",
3  "action": "track",
4  "event": "Email Opened",
5  "context": {
6    "ip": "67.207.109.102",
7    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.118 Safari/537.36",
8    "traits": {
9      "email": "pgibbons@example.com"
10    }
11  },
12  "properties": {
13    "email_id": "18vzF7u3z",
14    "email_subject": "First shirt on us!",
15    "campaign_id": "123",
16    "campaign_name": "New Customer Discount"
17  }
18}

Unsubscribed

This event should be fired when the recipient unsubscribes from the email. The unsubscription can either happen for a particular list, or globally from all marketing emails, depending on the tool. Typically you cannot unsubscribe from a transactional email such as a password reset.

Properties

This event supports the following semantic properties:

Property	Type	Description
`email_id`	String	An ID used to identify the email.
`email_subject`	String	The email's subject line.
`campaign_id`	String	An id used to identify a campaign
`campaign_name`	String	A name used to identify a campaign
`list_id`	String	An optional id used to identify a list
`list_name`	String	An optional name used to identify a list

Context

This event supports the following semantic context properties:

Property	Type	Description
`context.ip`	String	The opening computer's public IP address.
`context.traits`	Object	An associative array describing the email's intended recipient.
`context.traits.email`	String	The intended recipient's email address.
`context.user_agent`	String	The opening browser's user agent.

Example

1{
2  "user_id": "019mr8mf4r",
3  "action": "track",
4  "event": "Unsubscribed",
5  "context": {
6    "ip": "67.207.109.102",
7    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.118 Safari/537.36",
8    "traits": {
9      "email": "pgibbons@example.com"
10    }
11  },
12  "properties": {
13    "email_id": "18vzF7u3z",
14    "email_subject": "First shirt on us!",
15    "campaign_id": "123",
16    "campaign_name": "New Customer Discount",
17    "list_id": "1425",
18    "list_name": "New customers"
19  }
20}