This guide will help you set up Iterable as a destination in the RudderStack dashboard. It also lists the configuration settings required to correctly send data from the supported sources to Iterable.
Once you have confirmed that the source platform supports sending events to Iterable, follow these steps:
From your RudderStack dashboard, add the source. Then, from the list of destinations, select Iterable.
Assign a name to your destination and click Continue.
Connection settings
To successfully configure Iterable as a destination, you will need to configure the following settings:
Iterable API Key: Enter your Iterable API key. You can obtain it by going to the API Configuration Settings section in your Iterable account.
Other settings
Map All Pages to Single Event Name: If this setting is enabled, all pages will be tracked to Iterable with the same event name.
For page events, RudderStack will set the event name as Loaded a Page.
For screen events, RudderStack will set the event name as Loaded a Screen.
Track All Pages: If this setting is enabled, all page events will be sent to Iterable.
Track Categorized Pages: If this setting is enabled, only pages with a category present will be tracked.
Track Named Pages: If this setting is enabled, RudderStack will track only the pages having a name.
Create new user if userID exists: If enabled, RudderStack creates a new user in Iterable if userId is present in the event using the preferUserId parameter. For more information, see Iterable’s Update user data API.
Merge top-level objects: If enabled, Iterable merges the top-level objects instead of overwriting them using the mergeNestedObjects parameter. For more information, see Iterable’s Update user data API.
It is highly recommended to use this method if you want to leverage Iterable’s web push notifications feature for your website.
Use device mode to send events: Enable this setting to send your events to Iterable via web device mode.
Mapping to trigger the getInApp messages: Use this setting to specify the event names for which you want to trigger the website push notifications.
Mapping to trigger the purchase events: Use this setting to specify the event names for which you want to trigger the Iterable purchase events.
Identifier to identify a user over a session: Select the identifier from Email and UserID. RudderStack uses this identifier to uniquely identify a user during the session.
Trigger a track event for web in-app push: Enable this setting to track your website in-app push notifications.
Package Name: Enter the name of your website for which the in-app notifications are shown.
In-app message settings
The following settings let you customize the on-screen position, timing, content, and behavior of the in-app notifications:
Time (in ms) for messages to animate in and out
Space (px or %) between screen bottom & messages
Space (px or %) between screen right & messages
Space (px or %) between screen top & messages
Wait time for next message
Control how to open links
Screen Reader Text
Focus Element
Color of Close button
Size of Close button
Position
Space between button & container top
Space between button & container side
Custom pathname
Prevent user dismissing in-app message by clicking outside message
Consent management settings: Configure the consent management settings for the specified source by choosing the Consent management provider from the dropdown and entering the relevant consent category IDs. See Consent Management in RudderStack for more information on this feature.
Send data to Iterable catalogs
This feature requires access to the catalog API. Contact your Iterable customer success manager to add the catalog feature to your Iterable account.
RudderStack supports sending data to your Iterable catalog when connected to a Reverse ETL source.
While connecting a Reverse ETL source to the Iterable destination using the Visual Data Mapper, you can see the Iterable catalogs listed in the Object dropdown :
You can then map the catalog fields with warehouse columns where Item ID is a required field:
Verify that your Iterable account has access to the catalog API if RudderStack returns only the User object in the dropdown and does not show any catalog objects.
FAQ
Where can I find the Iterable API key?
You can get the Iterable API key by navigating to Integrations > API Keys. For more information, refer to this Iterable documentation.
What does the Track Named Pages setting imply?
If the Track Named Pages setting is enabled in the RudderStack dashboard, RudderStack will only track the pages that have a name assigned to them.
What does the Track Categorized Pages imply?
If the Track Categorized Pages setting is enabled in the RudderStack dashboard, RudderStack will only track the pages that have a category assigned to them.
This site uses cookies to improve your experience while you navigate through the website. Out of
these
cookies, the cookies that are categorized as necessary are stored on your browser as they are as
essential
for the working of basic functionalities of the website. We also use third-party cookies that
help
us
analyze and understand how you use this website. These cookies will be stored in your browser
only
with
your
consent. You also have the option to opt-out of these cookies. But opting out of some of these
cookies
may
have an effect on your browsing experience.
Necessary
Always Enabled
Necessary cookies are absolutely essential for the website to function properly. This
category only includes cookies that ensures basic functionalities and security
features of the website. These cookies do not store any personal information.
This site uses cookies to improve your experience. If you want to
learn more about cookies and why we use them, visit our cookie
policy. We'll assume you're ok with this, but you can opt-out if you wish Cookie Settings.