Skip to contentSkip to navigationSkip to topbar
Page tools
Useful for sharing or LLM
Accelerate development with AI

On this page
Looking for more inspiration?Visit the

Iterable Lists (Actions) Destination


The Iterable Lists destination allows users to upload lists of users to Iterable as audiences. For more information on this destination's features, visit Iterable's lists documentation(link takes you to an external page).

This is an Engage destination, which means it can be used to send data to Iterable Lists from Twilio Engage Audiences.


How it works

how-it-works page anchor

When you create an audience in Engage and connect it to the Iterable Lists destination, Segment automatically:

  1. Creates a new list in Iterable using the audience key as the list name.
  2. Adds users to the list in Iterable when they enter the audience.
  3. Removes users from the list in Iterable when they exit the audience.
(information)

Real-time to batch destination sync frequency

Real-time audience syncs may take six or more hours for the initial sync to complete. Upon completion, a sync frequency of two to three hours is expected.


Before you begin, make sure you have:

  • An Iterable API Key, which you can find in your Iterable account under Settings > API Keys.
  • Know which Iterable Project your Iterable Lists will belong to. See the the Iterable Project Type Settings FAQ below for further instructions.
  • A configured Engage Audience that you want to connect to this destination.

To set up your Iterable Lists destination in the Segment app, you'll need to:

  1. Connect Iterable Lists to Twilio Engage.
  2. Set up the Sync Action in your Iterable Lists (Actions) Destination.
  3. Connect Iterable Lists to your Audience.

Connect Iterable Lists to Twilio Engage

connect-iterable-lists-to-twilio-engage page anchor
  1. In Segment, go to Engage > Engage Settings.
  2. Click Destinations, then click Add Destination.
  3. Search for Iterable Lists (Actions) and click on it.
  4. Click Add destination, then click Confirm Source.
  5. Under Basic Settings, enter a name for your destination (for instance, "Iterable Lists Prod Space"), your Iterable API Key, select your Iterable Project Type, then enable the destination and click on Save.
  6. Turn on the Enable Destination toggle.

Set up the Sync Action in your Iterable Lists (Actions) Destination

set-up-the-sync-action-in-your-iterable-lists-actions-destination page anchor
  1. Navigate to Connections > Destinations then search for the Iterable Lists (Actions) destination you just created and click on it.
  2. Navigate to Mappings > New Mapping and click on the Sync To Iterable Lists tile.
    • Optional: if you plan to sync additional user traits or identifiers to Iterable, configure mappings for these using the Additional traits or identifiers field.
  3. Click Save.
  4. Back on the Mappings tab, enable the Sync to Iterable Lists Action.

Connect Iterable Lists to your Audience

connect-iterable-lists-to-your-audience page anchor
  1. Navigate to Engage > Audiences, then select the Audience you'd like to sync to Iterable.
  2. Click Add Destination then select the Iterable Lists (Actions) destination you created in previous steps.
    • Optional: Configure the Campaign ID, Channel Unsubscribe, and Update existing users only settings if needed.
    • Optional: Click Customized Setup if you want Engage to sync additional user traits or identifiers to the destination. This requires you to also map these traits or identifiers.
  3. This destination supports the Identify and Track methods. Both work in the same way. If using Track, there's no need to set an event name as the destination ignores any set event name.
  4. Click Save to apply the changes, then click Add 1 Destination to save the destination configuration. Segment starts to sync your audience to Iterable.

Property nameTypeRequiredDescription
API Keypassword
required

To obtain the API Key, go to the Iterable app and naviate to Integrations > API Keys. Create a new API Key with the 'Server-Side' type.


Iterable Project Typeselect

Optional

Select the type of your Iterable project. Hybrid projects support both email and user ID based identification, while User ID-Based projects only support user ID based identification.


Build your own Mappings. Combine supported triggers with the following Iterable Lists-supported actions:

(information)

Mapping limits per destination

Individual destination instances support a maximum of 5 mappings.

Sync Segment Audience to Iterable Lists

Sync To Iterable Lists is a Cloud action. The default Trigger is type = "identify" or type = "track"

Property nameTypeRequiredDescription
EmailSTRING

Optional

Email address of the user


User IDSTRING

Optional

User ID


Additional traits or identifiersOBJECT

Optional

Additional traits or identifiers to sync to Iterable. You will need to ensure these traits or objects are included via Event Settings > Customized Setup.


Traits or PropertiesOBJECT
required

Traits or Properties object from the identify() or track() call emitted by Engage


Segment Audience KeySTRING
required

Segment Audience Key. Maps to the Iterable List "Name" when the list is created in Iterable.


Segment External Audience IDSTRING
required

Segment External Audience ID. Maps to the List ID when the list is created in Iterable.


Enable Batching?BOOLEAN

Optional

When enabled, Segment will send events in batches.


Iterable Project Type Settings

iterable-project-type-settings page anchor

Iterable projects can be configured to use either userId, email, or both userId and email as user identifiers. You can check which identifiers your Iterable project is configured to use by opening your Iterable app and navigating to Settings > Project Settings > Unique identifier.

The table below outlines which Iterable Project Type destination setting you should set in the Segment app, based on your Iterable project type:

Your Iterable project typeThe correct Segment setting to use
Email-based project (unique email)Hybrid Project
Hybrid project (unique userId and unique email)Hybrid Project
UserID-based project (unique userId)User ID Based Project

You can send computed traits and audiences generated using Engage to this destination as a user property. To learn more about Engage, schedule a demo(link takes you to an external page).

For user-property destinations, an identify call is sent to the destination for each user being added and removed. The property name is the snake_cased version of the audience name, with a true/false value to indicate membership. For example, when a user first completes an order in the last 30 days, Engage sends an Identify call with the property order_completed_last_30days: true. When the user no longer satisfies this condition (for example, it's been more than 30 days since their last order), Engage sets that value to false.

When you first create an audience, Engage sends an Identify call for every user in that audience. Later audience syncs only send updates for users whose membership has changed since the last sync.


Segment lets you change these destination settings from the Segment app without having to touch any code.

Property nameTypeRequiredDescription
API Keypassword
required

To obtain the API Key, go to the Iterable app and naviate to Integrations > API Keys. Create a new API Key with the 'Server-Side' type.


Iterable Project Typeselect

Optional

Select the type of your Iterable project. Hybrid projects support both email and user ID based identification, while User ID-Based projects only support user ID based identification.

Default: hybrid