This preview of pull request 1639 is meant for internal use only.

Iterable Source


Good to know: Event source

The Iterable Source is an event source. This means that it sends data as events, which are behaviors or occurrences tied to a user and a point in time. Data from these sources can be loaded into your Segment warehouses, and also sent to Segment streaming destinations. Learn more about cloud sources.

Iterable is the growth marketing platform that enables brands to create, execute and optimize campaigns to power world-class customer engagement across email, push, SMS, in-app and more with unparalleled data flexibility. An integrated, cross-channel solution—built for marketers, trusted by engineers, designed with intelligence.

Take your company’s marketing analysis to the next level by adding Iterable as a Source to Segment. Iterable will automatically collect cross-channel messaging events like Email Delivered and Push Delivered, forward them to your destinations and load them into your data warehouse.

In your favorite BI or analytics tool, you’ll be able to analyze all your cross-channel marketing campaigns in SQL or through drag-and-drop reports. And you’ll be able to sync your Iterable data with event data you’re already sending through Segment to analyze the down-funnel effects of your messaging.

Getting Started

If you have previously enabled sending email events using the Iterable destination during our beta (using a project write key), you do not need to create new Iterable source. Your email data will continue to flow as normal.

  1. From your workspace’s segment.com/<your-workspace>/sources page, click Add source.

  2. Choose Iterable.

  3. Give the Source a name and add any labels to help you organize and filter your sources. You can give the source any name, but Segment recommends a name that reflects the source itself, as this name autopopulates the schema name. For example, the source name Iterable creates the schema iterable.

  4. The next page (“Overview”) will surface your Segment write key for Iterable. Copy this write key. 

  5. To finish the setup, you’ll have to go into your Iterable account and enter this Segment write key in their integrations settings. Find the right place in Iterable by clicking Integrations > Third Party > Segment.

  6. Click Save.

  7. In Segment, click into your Iterable Source in segment.com/<your-workspace>/sources. From there you’ll be able to add Destinations where you want to see email events.

That’s it! As you send emails, events will now be sent to your destinations and automatically loaded into any warehouses you have enabled. 

Components

Stream

Iterable uses our stream Source component to send Segment email events. It uses a server-side track method to send data to Segment. These events are then available in any destination that accepts server-side events, and available in a schema in your data warehouse, so you can query using SQL. 

The default behavior is for Iterable to pass the userId associated with the email recipient as the userId. There are cases in which Iterable does not have an associated userId, in which case the email address will be passed in as the anonymousId

Collections

Collections are the groupings of data we pull from your Source. In your warehouse, each collection gets its own table, as well as a tracks table that aggregates all the events into a single table. 

Collection Type Description
Email Delivered Event Message has been successfully delivered to the receiving server
Email Opened Event Recipient has opened the HTML message. You need to enable Open Tracking for getting this type of event
Email Bounced Event Receiving server could not or would not accept message
Email Link Clicked Event Recipient clicked on a link within the message. You need to enable Click Tracking for getting this type of event
Email Subscribed Event User subscribes to a messaging channel
Email Unsubscribed Event Recipient clicked on message’s subscription management link
Email Marked as Spam Event Recipient marked message as spam
Push Delivered Event Message has been successfully delivered to the receiving server
Push Opened Event User has been shown push notification by client app
Push Bounced Event Receiving server could not or would not accept message
Mobile App Uninstalled Event Ghost message sent 12 hours after original push delivered results in rejection from receiving server
SMS Send Event Message has been successfully delivered to the receiving server
SMS Bounced Event Receiving server could not or would not accept message
SMS Received Event User has sent an inbound SMS that was received by server

Send data to Iterable

The Iterable Source works better when you also connect Iterable as a destination. With the Iterable Destination, you can use Segment to send Iterable user and event data from which you trigger email campaigns. Want to start sending website or mobile data TO Iterable? Head on over to our Iterable destination docs.

This page was last modified: 03 Dec 2020



Get started with Segment

Segment is the easiest way to integrate your websites & mobile apps data to over 300 analytics and growth tools.
or
Create free account