This article describes how to set up the Iterable connector in your Customer Data Hub account.
In this article:
Table of Contents Placeholder
Connector Actions
Action Name |
AudienceStream |
EventStream |
Track Event |
✗ |
✓ |
Add or Update User |
✓ |
✗ |
Subscribe User to List |
✓ |
✗ |
Unsubscribe User from List |
✓ |
✗ |
Send Email to a Specific Email Address |
✓ |
✗ |
Configure Settings
Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector.
After adding the connector, configure the following settings:
- API Key
Go to the left navigation menu in the Iterable interface and click Integrations > API Keys to find your API key.
Action Settings - Parameters and Options
Click Next or go to the Actions tab. This is where you configure connector actions.
This section describes how to set up parameters and options for each action.
Action - Track Event
Parameters
Parameter |
Description |
Email |
- Either email or userID must be passed in to identify the user
- If both are passed in, email takes precedence
- For additional information, see the following vendor documentation:
|
Event Name |
|
Created At |
- Time event happened
- Set to the time event was received if unspecified
- Expects a Unix timestamp
|
User ID |
- User ID that was passed into the
updateUser call
|
Campaign ID |
- Campaign tied to conversion
|
Template ID |
|
Data Fields |
- Additional data associated with event, for example: item id, item amount, city, state, etc..
|
Action - Add or Update User
Parameters
Parameter |
Description |
Email |
- An email must be set unless a profile already exists with a User ID set
- If a profile already exists with a User ID set, a lookup from User ID to email is performed
- For more information, see the following vendor documentation:
|
User ID |
- Optional User ID
- This is typically your database-generated ID
|
Data Fields |
- Data fields to store in the user profile
|
Action - Subscribe User to List
Parameters
Parameter |
Description |
List ID |
- ID of the list you to subscribe the user to
- For more information, see the following vendor documentation:
|
Email |
- Email address of the user
|
User ID |
- Unique User ID of the user
|
Data Fields |
- Data fields to store in the user profile
|
Action - Unsubscribe User from List
Parameters
Parameter |
Description |
List ID |
- The ID of the list you want to unsubscribe the user from
- For additional information, see the following vendor documentation:
|
Email |
- The email address of the user
|
Campaign ID |
- Attribute unsubscribe to a campaign
|
Channel Unsubscribe |
- Unsubscribe email from list's associated channel
- This parameter is essentially a global unsubscribe
- Possible values:
true or false
- The default value is
false
|
Action - Send Email to a Specific Email Address
Parameters
Parameter |
Description |
Campaign ID |
- The ID of the campaign to trigger
|
Recipient Email |
- The recipient's email address
|
Data Fields |
- Fields to merge into email template
|
Send At |
- Schedule the message for up to 365 days in the future.
- If set in the past or if left blank, email is sent immediately.
- Format is
YYYY-MM-DD HH:MM:SS in UTC.
|