Skip to contentSkip to navigationSkip to topbar
On this page
Looking for more inspiration?Visit the
(information)
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.

Using Linked Audiences with Iterable


FREE x
TEAM x
BUSINESS
ADDON
(new)

This is a beta feature

This feature is in active development and might change before general availability.

Linked Audiences lets you dynamically personalize email messages(link takes you to an external page) in Iterable using the predefined traits of any Linked Audience profile and the attributes of any entities used to match the profile into the audience.


Supported Iterable engagement tools

supported-iterable-engagement-tools page anchor

The following engagement tools are available for use with Linked Audiences in Segment:

TypeDescription
Journey Campaign(link takes you to an external page)Trigger a single-step campaign when you add a specific custom event to a user profile in Iterable. Dynamically personalize the campaign with rich entity context.

Segment Destination Actions

segment-destination-actions page anchor

Segment sends data from your Linked Audiences to actions-based destinations. For example, you could send account information for the audience profiles with past due accounts to an email platform.

You can configure multiple triggers per audience (for example, one for account entry, and one for account exit).

Segment Destination ActionHow does it work?How does Iterable store the data?Iterable API Endpoint
Custom EventSegment sends personalization payload information into Iterable as Iterable custom events(link takes you to an external page). The entity personalization payload is contained in the dataFields parameter within API calls.Custom event properties(link takes you to an external page)Track an event(link takes you to an external page)
Upsert UserSegment sends personalization payloads into Iterable as Iterable user profiles(link takes you to an external page). The entity personalization payload is contained in the datafields parameter in API calls.User profile fields(link takes you to an external page)Update user data(link takes you to an external page)

Iterable Journey campaign

iterable-journey-campaign page anchor

Iterable Journey Campaigns(link takes you to an external page) store the entity personalization payload as event properties in custom events(link takes you to an external page).

Note: Using custom events can impact your Iterable billing(link takes you to an external page).

Prerequisites

prerequisites page anchor

In Segment, make sure you have:

In Iterable, make sure you have:

Step 1. Set up an Iterable Journey campaign

step-1-set-up-an-iterable-journey-campaign page anchor

To use Linked Audiences you must set up a Journey campaign in Iterable.

In Iterable, do the following:

  1. Create a Journey(link takes you to an external page) and in the Start tile(link takes you to an external page) select the Entry source as Event Occurs(link takes you to an external page), then choose Entry type = Custom event. Search and choose the name of the Segment custom event you previously set up and tested in Segment.
  2. Add an Email Message tile(link takes you to an external page), create your campaign(link takes you to an external page), and connect it to your Start Tile.
  3. Edit the content in your email:
    1. Under Design, choose either the WYSIWYG Editor(link takes you to an external page) or the Side by Side Editor(link takes you to an external page).
    2. Reference your Segment custom event payload schema in Iterable to determine what properties to include in your message. You can do this by accessing the user's profile(link takes you to an external page) and clicking into their event history(link takes you to an external page) (Events > History > Details).
    3. Translate the event properties in the payload schema into Handlebars syntax(link takes you to an external page) for custom events(link takes you to an external page), and enter it in the HTML editor in Iterable. See the personalization examples below for more specific details.
  4. Choose any additional settings that apply and review and publish your journey(link takes you to an external page). Then continue on to Test your campaign flow in Segment.

Step 2. Test your campaign flow

step-2-test-your-campaign-flow page anchor
  1. Open the Segment app and send yourself a test email for review. Add your Iterable user id and click Send test event to destination. Review the email you received, and make sure it is formatted properly.
A screenshot of the test event page.

If the event is sent successfully to Iterable, you will see a "message": "success" response in Segment.

  1. Open Iterable and check the Campaign tab in Messaging Insights(link takes you to an external page) (Insights > Messaging Insights > Campaigns > [Your Unique Campaign]) to confirm that Iterable has sent the message.
  2. If your email doesn't look the way you want it to, adjust the Handlebars syntax(link takes you to an external page) in Iterable, and send another test event. See the following personalization examples for more specific details.
  3. When you're finished testing your campaign, proceed to Enable your Linked Audience.

Handlebars examples to use in Iterable

handlebars-examples-to-use-in-iterable page anchor

Use the following examples as context and information to experiment with setting up your campaign in Iterable.

The following is an example of what your payload data might look like with nested payload properties:

1
{
2
"event": "abandoned_carts_linked_audience",
3
"properties": {
4
"first_name": "Andrew",
5
"last_name": "Shopper",
6
"shopping_cart__id": "123",
7
"shopping_cart__products": [
8
{
9
"id": "324",
10
"product_name": "Premium Tennis Shoes",
11
"product_price": "$140",
12
"__entity": "product"
13
},
14
{
15
"id": "489",
16
"product_name": "Premium Jacket",
17
"product_price": "$200",
18
"__entity": "product"
19
}
20
],
21
"__entity": "cart"
22
}
23
}

The following helps translate your payload data into Handlebars syntax:

  • To reference a specific event property:
    • Use the following Handelbars syntax: {{event_property_name}}
    • An example of this property might look like: {{first_name}}
  • To reference nested event properties within an Array:
    • Use the following Handlebars syntax: {{event_property_name.[#_that_represents_specific_entry_in_array].nested_event_property_name}}
    • An example of this property might look like: {{shopping_cart__products[0].product_name}}

You can read more on how to reference event properties(link takes you to an external page) and nested properties(link takes you to an external page) in Handlebars.

Use the Segment custom event payload schema to build an abandoned cart email campaign that includes specific information for the product in a customer's shopping cart.

When an email is sent, it lists the specific product and its related price in your customer's shopping cart. It might look like the following screenshot:

A screenshot of an email, with the name, item, and price personalized.

This is an example of what your email using HTML and Handlebars syntax(link takes you to an external page) might look like in Iterable:

1
Hi {{first_name}},
2
<br />
3
<br />
4
Did you forget to checkout?<br />
5
<br />
6
We noticed you added some items to your shopping cart including this item: <br />
7
<br />
8
<b>Product Name: </b>
9
{{shopping_cart__products.[0].product_name}}
10
<br />
11
<b>Product Price: </b>
12
{{shopping_cart__products.[0].product_price}} USD
13
<br />
14
<br />
15
16
Quick, now is your chance to own this item before it sells out!
17

Use the Segment custom event payload schema to build an abandoned cart email campaign where you can use the #each block helper(link takes you to an external page) to run a block of code repeatedly. In this example, you can list all of the products and their related prices in a customer's shopping cart.

When an email is sent, it lists all of the products and their related prices in your customer's shopping cart. It might look like the following screenshot:

A screenshot of an abandoned cart email, with a personalized name, two items, and prices for those items.

This is an example of what your email using HTML and Handlebars syntax(link takes you to an external page) might look like in Iterable:

1
Hi {{first_name}},
2
<br />
3
<br />
4
Did you forget to checkout?<br />
5
<br />
6
We noticed you added some items to your shopping cart. Here's what you left: <br />
7
<br />
8
9
{{#each shopping_cart__products}}
10
<b>Product Name: </b>
11
{{product_name}}
12
<br />
13
<b>Product Price: </b>
14
{{product_price}} USD
15
<br />
16
<br />
17
18
{{/each}}
19
20
Quick, now is your chance to own these items before they sell out!