Iterable

​

Overview

​

Prerequisites

​

Use Cases

1. Create and update users in Iterable for future marketing. Learn more >
2. Use Custom Events from your Extole programs in your Iterable Journeys and Campaigns. Learn more >
3. Include a customers share link or share code in your Iterable campaigns. Learn more >

​

Integration

​

Generate an Iterable API Key

1. Log in to your Iterable account and follow Iterable’s support documentation to create a new API Key.
2. Save your API key in a safe place. You will need to paste it into your My Extole account.

​

Set Up the Extole Integration

1. In My Extole, navigate to Security Center and find the Keys section.
2. Click + New Key.
3. Enter a Key Name. You’ll choose the key by this name when you create the webhook.
4. Select Webhook as the Key Type.
5. Set the Algorithm to PASSWORD.
6. Paste your Iterable REST API key into the key field.
7. Click Create Key.

​

Use Case 1: Subscribe Users to Receive Marketing Communications

1. Create your static lists in Iterable. Extole strongly recommends creating separate lists by audience (advocate/friend) and marketing opt-in status (opted-in to email vs. not opted-in to email).
2. Copy the list ID from your newly created list (you’ll need to paste it into your My Extole account).
3. Log in to My Extole and navigate to Tech Center > Outbound Webhooks.
4. Click + New Webhook and fill out the necessary fields.
5. Leave the Type as Generic.
6. Open the Client Key dropdown and select the key you created in Set Up the Extole Integration.
7. Paste in the API URL for Iterable’s List Subscribe API: https://api.iterable.com/api/lists/subscribe. If you use Iterable’s EU Data Center, use https://api.eu.iterable.com/api/docs#lists_subscribe.

8. Work with your Extole CSM to create the request body. Here is where you will need to supply the list ID for the Iterable list you would like to send opt-ins to.
9. Repeat Steps 4–8 for each list.
10. Done! You can now set up Journeys in Iterable to subscribe opted-in participants to marketing communications or to trigger transactional messages.

{
    "listId": <LIST_ID_FROM_STEP_2>,
    "subscribers": [
        {
            "mergeNestedObjects": true,
            "dataFields": {
              "share_link": "https://share.example.com/test10",
            },
            "userId": "",
            "preferUserId": true,
            "email": "test@example.com"
        }
    ]
}

​

Use Case 2: Trigger Iterable Journeys Using Custom Events

1. Make sure you have event handling enabled in your Iterable account.
2. Work with your Extole team to decide which custom events you’d like to send into Iterable, or choose from our standard table below. Your Extole team will then set up a webhook that points to Iterable’s Events API and events will automatically start flowing into Iterable. If you use Iterable’s EU Data Center, use https://api.eu.iterable.com/api/docs#events_track.

​

Choose the Events to Send

• An advocate receives a share link.
• A friend converts.
• A participant’s reward is fulfilled.

{
  "email": "test@example.com",
  "eventName": "extole_advocate_reward_earned",
  "id": "123456",
  "createdAt": 1682974089,
  "dataFields": {
    "first_name":"test",
    "last_name":"user",
    "coupon_code":"RAF12345",
    "reward_face_value":"30",
    "reward_face_value_type":"USD"
  }
}

​

Use Case 3: Include a Customer’s Share Link or Code in Your Iterable Messages

​

Share Links for Existing Users

1. To ensure that all current customers in Iterable have a share link, you can export a list of of customers from Iterable and securely upload them to Extole’s Batch Jobs center. Learn more about Extole’s file formatting standards and uploading files to Extole.
2. Your Extole CSM will then help you generate share links for each of the customers in the uploaded file.
3. Once the share links have been generated, your CSM can either help you run a report in the Extole platform and export the data to then be uploaded into Iterable or they can help you set up a webhook to update Iterable user profiles automatically.

​

Share Links for New Users

1. For all new customers, Extole can generate share links for every new customer and send them to Iterable to automatically update or create user profiles. To set this up, work with your Extole team to set up a webhook using Iterable’s Update User API. Note, if you are using Iterable’s EU Data Center, use https://api.eu.iterable.com/api/docs#users_updateUser.
   1. Note: This connection identifies users in Extole and Iterable based on their email addresses.
   2. Note: If you are using Iterable’s EU Data Center, use https://api.eu.iterable.com/api/docs#users_updateUser.
2. Once the webhook is configured, you will be able to start including share links in your Iterable messages using User Profile Fields!

{
  "email": "test@example.com",
  "dataFields": {
    "share_link":"https://share.yourcompany.com/test"
  }
}

​

Customizations

​

Send Iterable Events to Extole

​

Using this Integration