- TLC Home Home
- Discussions & Ideas Discussions & Ideas
- Product Guides Product Guides
- Knowledge Base Knowledge Base
- Developer Docs Developer Docs
- Education Education
- Blog Blog
- Support Desk Support Desk
This article describes how to set up the Iterable connector.
In this article:
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 | ✓ | ✗ |
Navigate 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:
Click Done when you are finished configuring the connector.
Click Continue to configure the connector actions. Enter in a name for the action and then select the action type from the drop-down menu.
The following section describes how to set up parameters and options for each action.
This action uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following thresholds is met:
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. |
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. See Introduction to Campaigns for more information about campaigns. |
Project Template | Template ID. See Introduction to Templates for more information about templates. |
Data Fields | Additional data associated with the event (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 (See Template Variables Guide). Name nested template variables with the dot notation (Example: items.name ).Nested template variables are typically built from data layer list attributes. |
Templates | Provide templates to be referenced in Body Data (see: Templates Guide). Templates are injected by name with double curly braces into supported fields (Example: {{SomeTemplateName}} ). |
This action uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following thresholds is met:
Parameter | Description |
---|---|
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 (Default: False). For example, if user profile has data: {mySettings:{mobile:true}} and change contact field has data: {mySettings:{email:true}} , the resulting profile: {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 | Data fields to store in the user profile. |
Template Variables | Provide template variables as data input (see: Template Variables Guide). Name nested template variables with the dot notation (Example: items.name ).Nested template variables are typically built from data layer list attributes. |
Templates | Provide templates to be referenced in Body Data (See: Templates Guide). Templates are injected by name with double curly braces into supported fields (Example: {{SomeTemplateName}} ). |
Parameter | Description |
---|---|
Provide user email if you want to delete the specified user's data from the Iterable project and prevent future data collection about them. |
Parameter | Description |
---|---|
Campaign | Campaign ID. See Introduction to Campaigns for more information about 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 (See: Template Variables Guide). Name nested template variables with the dot notation (Example: items.name ).Nested template variables are typically built from data layer list attributes. |
Templates | Provide templates to be referenced in Body Data (see: Templates Guide). Templates are injected by name with double curly braces into supported fields (Example: {{SomeTemplateName}} ). |
Parameter | Description |
---|---|
Campaign | Campaign ID. See Introduction to Campaigns for more information about 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 (See: Template Variables Guide). Name nested template variables with the dot notation (Example: items.name ).Nested template variables are typically built from data layer list attributes. |
Templates | Provide templates to be referenced in Body Data (see: Templates Guide). Templates are injected by name with double curly braces into supported fields (Example: {{SomeTemplateName}} ). |
Parameter | Description |
---|---|
Workflow ID | ID of workflow to trigger. See Introduction to Workflows for more information about workflows. |
List | Trigger the workflow for all users in a list. |
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 (See: Template Variables Guide). Name nested template variables with the dot notation (Example: items.name ).Nested template variables are typically built from data layer list attributes. |
Templates | Provide templates to be referenced in Body Data (See: Templates Guide). Templates are injected by name with double curly braces into supported fields (Example: {{SomeTemplateName}} ). |
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. |
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. |
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. |
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. |
Parameter | Description |
---|---|
List | Select list to subscribe user to. |
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 (Default: False). For example, if user profile has data: {mySettings:{mobile:true}} and change contact field has data: {mySettings:{email:true}} , the resulting profile: {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 | Data fields to store in the user profile. |
Template Variables | Provide template variables as data input (See: Template Variables Guide). Name nested template variables with the dot notation (Example: items.name ).Nested template variables are typically built from data layer list attributes. |
Templates | Provide templates to be referenced in Body Data (See: Templates Guide). Templates are injected by name with double curly braces into supported fields (Example: {{SomeTemplateName}} ). |
Parameter | Description |
---|---|
List | Select list to unsubscribe user from. |
User email. | |
User ID | Typically your database generated ID. Either Email or User ID must be specified. |
Campaign | Attribute unsubscribe to a campaign. See Introduction to Campaigns for more information about campaigns. |
Channel Unsubscribe | Unsubscribe email from list's associated channel. |
Copyright All Rights Reserved © 2008-2022