Skip to main content

​
Overview

This document outlines the technical procedure for Zeotap to directly trigger specific, pre-defined marketing campaigns in Iterable for targeted users in real-time. In this model, Zeotap handles user segmentation and workflow logic, determining when and which campaign should be sent. Iterable’s primary role is the creation, management, and execution of these campaigns upon receiving an API instruction from Zeotap. The goal is for Zeotap to make an API call to Iterable to immediately activate a designated campaign for a user when a corresponding event or condition is met within Zeotap.

​
Pre-requisites

  1. Iterable Account Access:
    • Administrative or relevant permissions in your Iterable project to create and manage API keys.
    • Complete all prerequisites asked by the platform to send a campaign
    • API-Triggered Campaigns: The specific marketing campaigns to be triggered must already be created within Iterable and configured as “API-Triggered Campaigns.” Each such campaign will have a unique campaignId which is required for the API call.
    • API triggered campaigns should be activated and set as Running
    • For creating a subscriber list make sure you have the list ID. Note: The list gets appended every time you add a new user. If any of the identifiers is the same other fields will be updated.
    • Iterable project’s primary user identifier as email.
  2. User Identification Strategy:
    • A consistent user identifier (e.g., email address or a unique customer ID) must be available in Zeotap at the time of the trigger and must correspond to the user profiles in Iterable.

​
Authentication

Interaction with the Iterable API requires an API key.

​
Creating an Access Key (API Key)

1
Sign in to an Iterable project as an org admin or as a member that has the Manage Integrations project permission.
2
Navigate to Integrations > API Keys. This screen lists information about each of the API keys that have been created for the project, but it does not display the full API keys.
3
Click New API Key.
4
In the Create API Key window, enter a name for the key and select the type of API key you’d like to generate. It’s a good idea to create a descriptive name for the API key so you know what the key is used for. This can be helpful if you have security reasons to disable or delete keys later, or for when you simply need to find and update a key later.
5
(Client-side only) If you have selected a client-side key type, you will see additional settings:a. Event Creation - Block creation of new event definitions, or allow them for up to 14 days in the future. For more information on this setting, see Event creation above.b. JWT Authentication - this is selected by default and highly recommended. To learn more about why this is encouraged, see JWT authentication above.
6
When you have finished, click Create.
7
In the Copy Your New API Key window, copy the API key:
If your API key requires JWT authentication, also copy the JWT Secret your server should use when generating per-user JSON Web Tokens:
Store the values displayed on this screen in a secure location. After you close the window, Iterable cannot display them again. If you lose them, you’ll need to create a new API key.

​
Create a Destination for Iterable - Campaign Trigger

Perform the following steps to create a Destination for Iterable - Campaign Trigger:
1
Log into the Zeotap CDP App and go to the DESTINATIONS application.
2
Click + Create Destination.
3
Under the All Destinations section, search for Iterable - Campaign Trigger.
4
Click Iterable - Campaign Trigger. A screen appears displaying details about the particular destination towards the left. On the right-hand side of the screen find a list of fields that are required for the integration to be established. Enter the required details as mentioned in the following steps:a. Enter a name for the Destination.
b. Enter the API Key, and Data Center (com for US, eu for Europe) of your Iterable instance. The steps to get the API key is mentioned in the Authentication section of this document.c. Review all the values entered above and then click Next to proceed.
5
In the new screen that appears, choose the appropriate action and mapping as explained below. Under Choose your Action, choose Campaign Trigger/ Update Subscriber List as the action.You can map the following fieldsi. Identifier Email (for Update Subscriber List)ii. Any other custom field using the +Add Mapping button
6
Click Create Destination. The created Destination gets listed in the Journeys application, which can be linked to any particular journey.

​
Activate the Destination on Journeys

After creating a destination, next, you need to link it in the Send to Destination node within the workflow, as explained below.
1
In the workflow, click + and choose Send to Destinations.
2
Choose the destination from the list of available destinations by using the search feature.
3
Under the Destination Details tab, the API key and data center fields are automatically populated based on the value that you have entered while creating the destination.
4
Under the Destination Settings tab, choose the List ID (String, we don’t support multiple list ID’s as of now), Campaign ID (String) and allow repeat marketing sends (true/false) as per your requirement.
Note:While attaching a destination Campaign ID might be required field even if you are just trying to update subscriber list. You can add any value to it. It will not be used.
5
Upon clicking Save Destination. The destination is attached as shown in the image below.
Last modified on February 26, 2026