We've built an integration with Segment that allows you to pipe email campaign data out of Iterable and into your warehouse, where it can interact with Segment's 200+ integrations.
The data will be sent to Segment as a track
call.
How to enable
In order to enable the data source, you will need a:
-
Segment account
If you are creating a new Segment account, please give Iterable a shout out by listing Iterable in the How Did You Hear About Us? field.
Iterable account
Getting started
-
Select Iterable from the Cloud Apps catalog from your workspace's /sources page.
-
Give the source a nickname and a schema name.
The nickname will be used to designate the source in the Segment interface, and the schema name is the namespace you'll be querying against in your warehouse. Both can be whatever you like, but we recommend sticking to something that reflects the source itself, like
Iterable
for Nickname anditerable
for the SQL schema name. -
On the overview page, copy your write key into Iterable.
Click Save.
-
In Segment, turn on the integrations you want to sync or connect your warehouse.
Alternatively, you can enable Iterable as a source in Iterable. To do so, navigate to Integrations > Third-Party:
Add a new integration and choose Segment:
Locate and enter your Segment write key.
If you are using Iterable for mobile push notifications, Iterable can also send push delivery, bounce, and open events as track calls to Segment.
Confirm the source is working
You can confirm that the Source is working by sending a test campaign to yourself.
You'll also see this message once data is flowing to your integrations or warehouse.
If these events are flowing into your Segment debugger, you'll know that the source is properly enabled. If you run into any issues, please contact our team at support@iterable.com.
For reference, this table includes all events as they would be named in Iterable and what they will be named when sent to Segment:
Iterable Event | Event Tracked by Segment |
---|---|
Channel/Type/List Subscribe | Subscribed |
Channel/Type/List Unsubscribe | Unsubscribed |
Hosted Unsubscribe Click | Hosted Unsubscribe Click |
Email Send | Email Delivered |
Email Bounced | Email Bounced |
Email Open | Email Opened |
Email Click | Email Link Clicked |
Email Complaint | Email Marked as Spam |
Push Send | Push Delivered |
Push Bounce | Push Bounced |
Push Open | Push Opened |
Push Uninstall | Mobile App Uninstalled |
SMS Send | SMS Delivered |
SMS Bounce | SMS Bounced |
SMS Received | SMS Received |
In App Send | In App Sent |
In App Delivery | In App Delivered |
In App Open | In App Opened |
In App Click | In App Clicked |
Web Push Send | Web Push Delivered |
Web Push Click | Web Push Clicked |
Use cases
You can read about use cases here and more about Segment's Sources product here.
Examples of Iterable email events in Segment
Email Delivered
{ "context": { "integration": { "name": "Iterable", "version": "1.0.0" }, "library": { "name": "unknown", "version": "unknown" }, "os": {}, "traits": { "email": "docs@iterable.com" } }, "event": "Email Delivered", "integrations": { "Iterable": false }, "messageId": "api-1bT7FPnYimuzrM0pRdxwSfuijFT", "properties": { "campaignId": 1193044, "campaignName": "docs test", "catalogCollectionCount": 0, "catalogLookupCount": 0, "channelId": 30224, "contentId": 6525985, "createdAt": "2020-05-05 02:02:05 +00:00", "email": "docs@iterable.com", "emailId": "c1193044:t1665755:docs@iterable.com", "emailSubject": "Free pizza", "experimentId": null, "labels": [], "locale": null, "messageBusId": "01000171e2919c22-c14654df-d15e-41fd-9f93-9b0a0a80ce4d-000000", "messageId": "79a52890929b4e15aedbb07cfb2aa502", "messageTypeId": 34567, "productRecommendationCount": 0, "templateId": 1665755, "templateName": "docs test", "workflowId": null, "workflowName": null }, "receivedAt": "2020-05-05T02:02:05.880Z", "timestamp": "2020-05-05T02:02:05.880Z", "type": "track" }
Email Opened
{ "context": { "integration": { "name": "Iterable", "version": "1.0.0" }, "ip": "192.168.0.1", "library": { "name": "unknown", "version": "unknown" }, "os": { "name": "Gmail" }, "traits": { "email": "docs@iterable.com" }, "userAgent": "Mozilla/5.0 (Windows NT 5.1; rv:11.0) Gecko Firefox/11.0 (via ggpht.com GoogleImageProxy)" }, "event": "Email Opened", "integrations": { "Iterable": false }, "messageId": "api-1bT7LkL5v6ffMavWMOJDNHgLxoO", "properties": { "campaignId": 1193044, "campaignName": "docs test", "channelId": 30224, "createdAt": "2020-05-05 02:02:55 +00:00", "email": "docs@iterable.com", "emailId": "c1193044:t1665755:docs@iterable.com", "emailSubject": "Free pizza", "experimentId": null, "labels": [], "locale": null, "messageId": "79a52890929b4e15aedbb07cfb2aa502", "messageTypeId": 34567, "templateId": 1665755, "templateName": "docs test", "userAgentDevice": "Gmail", "workflowId": null, "workflowName": null }, "receivedAt": "2020-05-05T02:02:55.728Z", "timestamp": "2020-05-05T02:02:55.728Z", "type": "track", "userId": "string" }
Email Link Clicked
{ "context": { "integration": { "name": "Iterable", "version": "1.0.0" }, "ip": "192.168.0.1", "library": { "name": "unknown", "version": "unknown" }, "os": { "name": "Mac" }, "traits": { "email": "docs@iterable.com" }, "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.122 Safari/537.36" }, "event": "Email Link Clicked", "integrations": { "Iterable": false }, "messageId": "api-1bT9B1t5MJc53A20I2Lo3oALWEv", "properties": { "campaignId": 1193044, "campaignName": "docs test", "channelId": 30224, "city": "San Francisco", "contentId": 6526033, "country": "United States", "createdAt": "2020-05-05 02:17:56 +00:00", "email": "docs@iterable.com", "emailId": "c1193044:t1665755:docs@iterable.com", "emailSubject": "Free pizza", "experimentId": null, "hrefIndex": 0, "labels": [], "linkUrl": "https://www.example.com", "locale": null, "messageId": "56c6a7feee584799855f55f42079215a", "messageTypeId": 34567, "region": "CA", "templateId": 1665755, "templateName": "docs test", "url": "https://www.example.com", "userAgentDevice": "Mac", "workflowId": null, "workflowName": null }, "receivedAt": "2020-05-05T02:17:56.359Z", "timestamp": "2020-05-05T02:17:56.359Z", "type": "track", "userId": "string" }
Unsubscribed
NOTE
If present, the singular fields channelId
and messageTypeId
represent the
entities associated with the campaignId
contained in the event (i.e. the
channelId
and messageTypeId
that were used with the campaign). The plural
fields channelIds
and messageTypeIds
represent the entities that the user is
being subscribed to or unsubscribed from.
{ "context": { "integration": { "name": "Iterable", "version": "1.0.0" }, "library": { "name": "unknown", "version": "unknown" }, "os": {}, "traits": { "email": "docs@iterable.com" } }, "event": "Unsubscribed", "integrations": { "Iterable": false }, "messageId": "api-1bT7MIYeXhuvTrrUPoTsOT1v1hq", "properties": { "campaignId": 1193044, "campaignName": "docs test", "channelId": 30224, "channelIds": [ 30224 ], "createdAt": "2020-05-05 02:02:59 +00:00", "email": "docs@iterable.com", "emailId": "c1193044:t1665755:docs@iterable.com", "emailListIds": [], "emailSubject": "Free pizza", "experimentId": null, "labels": [], "locale": null, "messageId": "79a52890929b4e15aedbb07cfb2aa502", "messageTypeId": 34567, "messageTypeIds": [], "templateId": 1665755, "templateName": "docs test", "unsubSource": "EmailLink", "workflowId": null, "workflowName": null }, "receivedAt": "2020-05-05T02:02:59.095Z", "timestamp": "2020-05-05T02:02:59.095Z", "type": "track", "userId": "string" }
Hosted Unsubscribe Click
{ "anonymousId": "docs@iterable.com", "context": { "integration": { "name": "Iterable", "version": "1.0.0" }, "ip": "0:0:0:0:0:0:0:1", "library": { "name": "unknown", "version": "unknown" }, "os": { "name": "Mac" }, "traits": { "email": "docs@iterable.com" }, "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.129 Safari/537.36" }, "event": "Hosted Unsubscribe Click", "integrations": { "Iterable": false }, "messageId": "api-1bK8t8qMp4BVmar3IpVMdGqEmzp", "properties": { "campaignId": 6, "campaignName": "test", "channelId": 1, "createdAt": "2020-05-01 21:47:16 +00:00", "email": "docs@iterable.com", "emailId": "c6:t12:docs@iterable.com", "emailSubject": "Free pizza", "experimentId": null, "labels": [], "locale": null, "messageId": "279db222949d4882866d31b67ae5310f", "messageTypeId": 1, "templateId": 12, "templateName": "Template created on Fri, May 01 2020, 2:46 PM", "url": "https://www.example.com", "userAgentDevice": "Mac", "workflowId": null, "workflowName": null }, "receivedAt": "2020-05-01T21:47:16.764Z", "timestamp": "2020-05-01T21:47:16.764Z", "type": "track" }
Comments
0 comments
Please sign in to leave a comment.