Iterable Connector Setup Guide

Configure Settings

Navigate to the Connector Marketplace and add a new connector. For more information, see About connectors.

After adding the connector, configure the following settings:

• Host
  • For EU-based API endpoints, select https://app.eu.iterable.com.
  • For US-based API endpoints, select https://app.iterable.com.
• API Key

To find your API Key, on the Iterable site, go to Integrations > API Keys in the Iterable Connector menu.

Supported Actions

Action Name	AudienceStream	EventStream
Track Event (Batched)	✗	✓
Upsert User (Batched)	✓	✓
Forget a User in Compliance with GDPR	✓	✓
Send SMS Notification to User	✓	✓
Send an Email to an Email Address	✓	✓
Trigger Workflow	✓	✓
Subscribe a User (AS Only)	✓	✗
Unsubscribe a User (AS Only)	✓	✗
Subscribe User to List	✓	✗
Unsubscribe User from List	✓	✗
Update User Email	✓	✓
Update Shopping Cart	✓	✓
Track Purchase	✓	✓
Merge Customer Data	✓	✓

Action Settings - Parameters and Options

Click Next or go to the Actions tab. It’s where you’ll set up actions and trigger them.

The following section describes how to set up parameters and options for each action.

Action — Track Event (Batched)

Batch Limits

This action uses batched requests to support high-volume data transfers to the vendor. For more information, see Batched Actions. Requests are queued until one of the following thresholds is met or the profile is published:

• Max number of requests: 1000
• Max time since oldest request: 10 minutes
• Max size of requests: 4 MB

Parameters

Parameter	Description
Event Name	Required. Name of event.
Created At	Time event happened. Set to the time event was received if unspecified. Expects a Unix timestamp. If this field is not mapped, it will be initialized with the current timestamp.
Email	Either Email or User ID must be entered to identify the user. If both are entered, Email takes precedence.
Event ID	If an event exists with the entered ID, the event will be updated. If no Event ID is specified, a new ID will automatically be generated and returned. Note that this ID cannot be longer than 512 bytes.
User ID	User ID that was passed into the updateUser call.
Campaign	Campaign tied to conversion. For more information, see Introduction to Campaigns.
Project Template	Template ID. For more information, see Introduction to Templates.
Data Fields	Additional data associated with the event. For example: item amount or item quantity. For events of the same name, identically named data fields must be of the same type.
Template Variables	Provide template variables as data input. For more information, see Template Variables Guide. Name nested template variables with the dot notation. For example: items.name. Nested template variables are typically built from data layer list attributes
Templates	Provide templates to be referenced in Body Data. For more information, see Templates Guide. Templates are injected by name with double curly braces into supported fields. For example: {{SomeTemplateName}}
API Key Override	Enter an API key or map an attribute for an API key to override the API key specified in the connector configuration.

Action — Upsert User (Batched)

Batch Limits

This action uses batched requests to support high-volume data transfers to the vendor. For more information, see Batched Actions. Requests are queued until one of the following thresholds is met or the profile is published:

• Max number of requests: 1000
• Max time since oldest request: 10 minutes
• Max size of requests: 4 MB

Parameters

Parameter	Description
Email	An email must be set unless a profile already exists with a user ID set. If a profile already exists, a lookup from the User ID to Email is performed.
Merge Nested Objects	Merge top level objects instead of overwriting. The default value is False. For example, if the user profile contains {mySettings:{mobile:true}} and the change contact field contains {mySettings:{email:true}}, the resulting profile would contain {mySettings:{mobile:true,email:true}}.
Prefer User ID	Create a new user with the specified User ID if the user does not exist yet.
User ID	Typically your database generated ID. Either Email or User ID must be specified.
Data Fields	The data fields to store in the user profile.
Template Variables	Provide template variables as data input. For more information, see Template Variables Guide. Name nested template variables with the dot notation. For example: items.name. Nested template variables are typically built from data layer list attributes.
Templates	Provide templates to be referenced in Body Data. For more information, see Templates Guide. Templates are injected by name with double curly braces into supported fields. For example: {{SomeTemplateName}}.
API Key Override	Enter an API key or map an attribute for an API key to override the API key specified in the connector configuration.

Action — Forget a User in Compliance with GDPR

Parameters

Parameter	Description
Email	Provide user email if you want to delete the specified user’s data from the Iterable project and prevent future data collection about them.
API Key Override	Enter an API key or map an attribute for an API key to override the API key specified in the connector configuration.

Action — Send SMS Notification to User

Parameters

Parameter	Description
Campaign	Campaign ID. For more information, see Introduction to Campaigns.
Allow Repeat Marketing Sends	Defaults to True.
Recipient Email	Either Email or User ID must be entered to identify the user. If both are entered, Email takes precedence.
Recipient User ID	User ID that was passed into the updateUser call.
Send At	Schedule the message for up to 365 days in the future. If set in the past, the message is sent immediately. Expected format is YYYY-MM-DD HH:MM:SS. Ensure data is properly formatted. If attribute of the Date type is provided, the connector will convert the value to the appropriate date format, shown above.
Data Fields	Fields to merge into template.
Template Variables	Provide template variables as data input. For more information, see Template Variables Guide. Name nested template variables with the dot notation. For example: items.name. Nested template variables are typically built from data layer list attributes.
Templates	Provide templates to be referenced in Body Data. For more information, see Templates Guide. Templates are injected by name with double curly braces into supported fields. For example: {{SomeTemplateName}}.
API Key Override	Enter an API key or map an attribute for an API key to override the API key specified in the connector configuration.

Action — Send an Email to an Email Address

Parameters

Parameter	Description
Campaign	Campaign ID. For more information, see Iterable: Introduction to Campaigns.
Allow Repeat Marketing Sends	Defaults to True.
Recipient Email	Either Email or User ID must be entered to identify the user. If both are entered, Email takes precedence.
Recipient User ID	User ID that was passed into the updateUser call.
Send At	Schedule the message for up to 365 days in the future. If set in the past, the message is sent immediately. Expected format is YYYY-MM-DD HH:MM:SS. Ensure data is properly formatted. If attribute of the Date type is provided, the connector will convert the value to the appropriate date format, shown above.
Data Fields	Fields to merge into email template.
Metadata	Metadata to pass back via webhooks. Not used for rendering.
Template Variables	Provide template variables as data input. For more information, see Template Variables Guide. Name nested template variables with the dot notation. For example: items.name. Nested template variables are typically built from data layer list attributes.
Templates	Provide templates to be referenced in Body Data. For more information, see Templates Guide. Templates are injected by name with double curly braces into supported fields. For example: {{SomeTemplateName}}.
API Key Override	Enter an API key or map an attribute for an API key to override the API key specified in the connector configuration.

Action — Trigger Workflow

Parameters

Parameter	Description
Workflow ID	ID of workflow to trigger. For more information, see Iterable: Introduction to Workflows.
List	Trigger the workflow for all users in a list.
Email	Trigger workflow for given email address. Trigger only with Email or List.
Data Fields	Additional data associated triggering event.
Template Variables	Provide template variables as data input. For more information, see Template Variables Guide. Name nested template variables with the dot notation. For example: items.name. Nested template variables are typically built from data layer list attributes.
Templates	Provide templates to be referenced in Body Data. For more information, see Templates Guide. Templates are injected by name with double curly braces into supported fields. For example: {{SomeTemplateName}}.
API Key Override	Enter an API key or map an attribute for an API key to override the API key specified in the connector configuration.

Action — Subscribe a User (AS Only)

Parameters

Parameter	Description
Subscription Group	Select Subscription Group.
Subscription Group ID	Provide the ID of the message channel, message type or email list to which you are subscribing the user.
Email	Provide the email address of the user for which you’d like to create a subscription.
User ID	Provide user ID of the user for which you’d like to create a subscription. Either Email or User ID must be specified.
API Key Override	Enter an API key or map an attribute for an API key to override the API key specified in the connector configuration.

Action — Unsubscribe a User (AS Only)

Parameters

Parameter	Description
Subscription Group	Select Subscription Group.
Subscription Group ID	Provide the ID of the message channel, message type or email list from which you are unsubscribing the user.
Email	Provide the email address of the user from which you are unsubscribing the user.
User ID	Provide user ID of the user from which you are unsubscribing the user. Either Email or User ID must be specified.
API Key Override	Enter an API key or map an attribute for an API key to override the API key specified in the connector configuration.

Action — Subscribe User to List

Parameters

Parameter	Description
List	Select list to subscribe user to.
Email	An email must be set unless a profile already exists with a user ID set. In which case, a lookup from User ID to Email is performed.
Merge Nested Objects	Merge top level objects instead of overwriting. The default value is False. For example, if the user profile contains {mySettings:{mobile:true}} and the change contact field contains {mySettings:{email:true}}, the resulting profile would contain {mySettings:{mobile:true,email:true}}.
Prefer User ID	Create a new user with the specified user ID if the user does not exist yet.
User ID	Typically your database generated ID. Either Email or User ID must be specified.
Data Fields	The data fields to store in the user profile.
Template Variables	Provide template variables as data input. For more information, see Template Variables Guide. Name nested template variables with the dot notation. For example: items.name. Nested template variables are typically built from data layer list attributes.
Templates	Provide templates to be referenced in Body Data. For more information, see Templates Guide. Templates are injected by name with double curly braces into supported fields. For example: {{SomeTemplateName}}.
API Key Override	Enter an API key or map an attribute for an API key to override the API key specified in the connector configuration.

Action — Unsubscribe User from List

Parameters

Parameter	Description
List	Select list to unsubscribe user from.
Email	User email.
User ID	Typically your database generated ID. Either Email or User ID must be specified.
Campaign	Attribute unsubscribe to a campaign. For more information, see Iterable: Introduction to Campaigns.
Channel Unsubscribe	Unsubscribe email from list’s associated channel.
API Key Override	Enter an API key or map an attribute for an API key to override the API key specified in the connector configuration.

Action — Update User Email

Parameters

Parameter	Description
New Email	Required. New user email.
Current Email	Current user email.
Current User ID	Typically your database generated ID. Either Email or User ID must be specified.
API Key Override	Enter an API key or map an attribute for an API key to override the API key specified in the connector configuration.

Action — Update Shopping Cart

Parameters

Parameter	Description
Email	User email.
Merge Nested Objects	Merge top level objects instead of overwriting. The default value is False. For example, if the user profile contain {mySettings:{mobile:true}} and the change contact field contains {mySettings:{email:true}}, the resulting profile would contain {mySettings:{mobile:true,email:true}}.
Prefer User ID	Create a new user with the specified User ID if the user does not exist yet.
User ID	Typically your database generated ID. Either Email or User ID must be specified.
User Data Fields	The data fields to store in the user profile.
User Data Fields Template Variables	Provide template variables as data input. For more information, see Template Variables Guide. Name nested template variables with the dot notation. For example: items.name. Nested template variables are typically built from data layer list attributes.
User Data Fields Templates	Provide templates to be referenced in User Data Fields. For more information, see Templates Guide. Templates are injected by name with double curly braces into supported fields. For example: {{SomeTemplateName}}.

Item attributes

Parameter	Description
Item ID	Product item ID.
SKU	Product SKU.
Name	Product name.
Description	Product description.
Category	Product category.
Subcategory	Product subcategory.
Price	Product price.
Quantity	Product quantity.
Image URL	URL for product image.
URL	URL for product page.
Items Data Fields	Additional item properties. Provide Array type attributes to add multiple items. Array type attributes must be of equal length. Items Data Fields arrays and Items Attributes arrays must be of equal length. Single value attributes can be used and will apply to each item.
Items Template Variables	Provide template variables as data input. For more information, see Template Variables Guide. Name nested template variables with the dot notation. For example: items.name. Nested template variables are typically built from data layer list attributes.
Items Template	If you need nested objects support, use this section to define a template. The template expects a JSON array format. When template is defined, then configuration from the Items Attributes section are ignored. Either Items Template or Items Attributes must be specified. For more information, see Templates Guide.
API Key Override	Enter an API key or map an attribute for an API key to override the API key specified in the connector configuration.

Action — Track Purchase

Parameters

Parameter	Description
Total	Required. Total order dollar amount.
Purchase ID	ID of purchase transaction.
Created At	Time event happened. Set to the time event was received if unspecified. Expects a Unix timestamp. If this field is not mapped, it will be initialized with the current timestamp.

User attributes

Parameter	Description
Email	Either Email or User ID must be entered to identify the user. If both are entered, Email takes precedence.
Merge Nested Objects	Merge top level objects instead of overwriting. The default value is False. For example, if the user profile contains {mySettings:{mobile:true}} and the change contact field contains {mySettings:{email:true}}, the resulting profile would contain {mySettings:{mobile:true,email:true}}.
Prefer User ID	Create a new user with the specified User ID if the user does not exist yet.
User ID	Typically your database generated ID. EitherEmailorUser IDmust be specified.
Campaign	Campaign ID. For more information, see Iterable: Introduction to Campaigns.
Project Template	Template ID. For more information, see Iterable: Introduction to Templates.
Data Fields	Additional fields to be tracked.
User Data Fields	The data fields to store in the user profile.
Data Fields Template Variables	Provide template variables as data input ,For more information, see Template Variables Guide. Name nested template variables with the dot notation. For example: items.name. Nested template variables are typically built from data layer list attributes.
Data Fields Templates	Provide templates to be referenced in Data Fields and User Data Fields. For more information, see Templates Guide. Templates are injected by name with double curly braces into supported fields. For example: {{SomeTemplateName}}.

Item attributes

Parameter	Description
Item ID	Product item ID.
SKU	Product SKU.
Name	Product name.
Description	Product description.
Category	Product category.
Subcategory	Product subcategory.
Price	Product price.
Quantity	Quantity of product purchased.
Image URL	URL for product image.
URL	URL for product page.
Items Data Fields	Additional item properties. Provide Array type attributes to add multiple items. Array type attributes must be of equal length. Items Data Fields arrays and Items Attributes arrays must be of equal length. Single value attributes can be used and will apply to each item.
Items Template Variables	Provide template variables as data input. For more information, see Template Variables Guide. Name nested template variables with the dot notation. For example: items.name. Nested template variables are typically built from data layer list attributes.
Items Template	If you need nested objects support, use this section to define a template. The template expects a JSON array format. When template is defined, then configuration from the Items Attributes section are ignored. Either Items Template or Items Attributes must be specified. For more information, see Templates Guide.
API Key Override	Enter an API key or map an attribute for an API key to override the API key specified in the connector configuration.

Merge Customer Data

Source User Parameters

Parameter	Description
Source Email	Identify the source user profile by email. This parameter can be a string or an array. The array size limit is 10.
Source User ID	Identify the source user profile by user ID. This parameter can be a string or an array. The array size limit is 10.

Destination User Parameters

Parameter	Description
Destination Email	Identify the destination user profile by email. This parameter can be a string or an array. The array size limit is 10 and must be the same size as the source parameter.
Destination User ID	Identify the destination user profile by user ID. This parameter can be a string or an array. The array size limit is 10 and must be the same size as the source parameter.
API Key Override	Enter an API key or map an attribute for an API key to override the API key specified in the connector configuration.