Articles in this section

See more

Integrating Segment with Iterable (Iterable to Segment)

To send data from Iterable to Segment, you can enable Iterable as a Segment source.

NOTE

This integration requires an Iterable account and a Segment account.

If you're not already an Iterable customer, request a demo to discuss how the Iterable and Segment integration can work for you.

In this article

Setup

To get started sending data from your Iterable project to Segment, follow these steps:

  1. In Segment, add a new source and select Iterable.

    Segment's integration catalog

  2. Give your source a Name (we recommend using the name of your Iterable project).

    Adding an Iterable source to Segment

  3. On the Overview tab, copy the Write Key.

    Copying the Segment Write Key

  4. In Iterable, navigate to Integrations > Third-Party.

  5. From there, add a new integration and choose Segment.

    Adding a Segment integration in Iterable

  6. To enable the integration, enter your Segment write key and click Add Integration.

Confirm the source is working

Now, make sure that Iterable is sending system events to Segment. To do this, sign in to Segment and look at the Debugger for your Iterable source.

Viewing Iterable events in Segment's source debugger

If you're having trouble, contact support@iterable.com.

Event names

Here are the system events that Iterable sends to Segment, and how their names map from across systems:

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 Click SMS Clicked
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

Examples of Iterable email events in Segment

Below are some example email events sent from Iterable to Segment.

NOTE

We recently renamed Workflows to Journeys—however, our APIs and field names still refer to them as "Workflows" (for example, workflowId). Continue to use the term "Workflows" in your API requests and responses.

Email Delivered

{
  "context": {
    "integration": {
      "name": "Iterable",
      "version": "1.0.0"
    },
    "library": {
      "name": "unknown",
      "version": "unknown"
    },
    "os": {},
    "traits": {
      "email": "ramona@example.com"
    }
  },
  "event": "Email Delivered",
  "integrations": {
    "Iterable": false
  },
  "messageId": "...",
  "properties": {
    "campaignId": 1193044,
    "campaignName": "Test campaign",
    "catalogCollectionCount": 0,
    "catalogLookupCount": 0,
    "channelId": 30224,
    "contentId": 6525985,
    "createdAt": "2020-05-05 02:02:05 +00:00",
    "email": "ramona@iterable.com",
    "emailId": "...",
    "emailSubject": "Test email",
    "experimentId": null,
    "labels": [],
    "locale": null,
    "messageBusId": "...",
    "messageId": "...",
    "messageTypeId": 34567,
    "productRecommendationCount": 0,
    "templateId": 1665755,
    "templateName": "Test template",
    "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": "ramona@example.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": "...",
  "properties": {
    "campaignId": 1193044,
    "campaignName": "Test campaign",
    "channelId": 30224,
    "createdAt": "2020-05-05 02:02:55 +00:00",
    "email": "ramona@example.com",
    "emailId": "...",
    "emailSubject": "Test email",
    "experimentId": null,
    "labels": [],
    "locale": null,
    "messageId": "...",
    "messageTypeId": 34567,
    "proxySource": "Gmail",
    "templateId": 1665755,
    "templateName": "Test template",
    "userAgentDevice": "Gmail",
    "workflowId": null,
    "workflowName": null
  },
  "receivedAt": "2020-05-05T02:02:55.728Z",
  "timestamp": "2020-05-05T02:02:55.728Z",
  "type": "track",
  "userId": "string"
}


{
  "context": {
    "integration": {
      "name": "Iterable",
      "version": "1.0.0"
    },
    "ip": "192.168.0.1",
    "library": {
      "name": "unknown",
      "version": "unknown"
    },
    "os": {
      "name": "Mac"
    },
    "traits": {
      "email": "ramona@example.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": "...",
  "properties": {
    "campaignId": 1193044,
    "campaignName": "Test campaign",
    "channelId": 30224,
    "city": "San Francisco",
    "contentId": 6526033,
    "country": "United States",
    "createdAt": "2020-05-05 02:17:56 +00:00",
    "email": "ramona@example.com",
    "emailId": "...",
    "emailSubject": "Test email",
    "experimentId": null,
    "hrefIndex": 0,
    "labels": [],
    "linkUrl": "https://www.example.com",
    "locale": null,
    "messageId": "...",
    "messageTypeId": 34567,
    "region": "CA",
    "templateId": 1665755,
    "templateName": "Test template",
    "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 they're present, the singular channelId and messageTypeId fields represent the message channel and message type associated with the campaign. The plural channelIds and messageTypeIds fields are the message channels and message types for which subscriptions are being modified.

{
  "context": {
    "integration": {
      "name": "Iterable",
      "version": "1.0.0"
    },
    "library": {
      "name": "unknown",
      "version": "unknown"
    },
    "os": {},
    "traits": {
      "email": "ramona@example.com"
    }
  },
  "event": "Unsubscribed",
  "integrations": {
    "Iterable": false
  },
  "messageId": "...",
  "properties": {
    "campaignId": 1193044,
    "campaignName": "Test campaign",
    "channelId": 30224,
    "channelIds": [30224],
    "createdAt": "2020-05-05 02:02:59 +00:00",
    "email": "ramona@example.com",
    "emailId": "...",
    "emailListIds": [],
    "emailSubject": "Test email",
    "experimentId": null,
    "labels": [],
    "locale": null,
    "messageId": "...",
    "messageTypeId": 34567,
    "messageTypeIds": [],
    "templateId": 1665755,
    "templateName": "Test template",
    "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": "ramona@example.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": "ramona@example.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": "...",
  "properties": {
    "campaignId": 6,
    "campaignName": "test",
    "channelId": 1,
    "createdAt": "2020-05-01 21:47:16 +00:00",
    "email": "ramona@example.com",
    "emailId": "...",
    "emailSubject": "Test email",
    "experimentId": null,
    "labels": [],
    "locale": null,
    "messageId": "...",
    "messageTypeId": 1,
    "templateId": 12,
    "templateName": "Test template",
    "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"
}

Related articles

Comments

0 comments

Please sign in to leave a comment.