Integrating with Iterable

The eduMe integration uses the Iterable data feed feature to pull in the relevant course information and create unique seamless links for each learner.

We would recommend familiarising yourself with the documentation related to this feature before getting started - you can find this here.

What's covered

Prerequisites

Create a data feed in Iterable

Add your data feed to a campaign

Insert the seamless link tag in the campaign


Prerequisites

Before you can set up a data feed in Iterable, there are a couple of things that you will need from eduMe: 

  1. eduMe API key - request your customer API key from support@edume.com
  2. Modify seamless URL template - using the template provided below, update the following parameters for the course you'd like to include as part of a campaign:
    • {{INSERT_GROUP_ID}} - in the admin panel, this is your Team ID*
    • {{INSERT_MODULE_ID}}  - in the admin panel, this is your Module ID*
    • {{email}}  - this is your learner identifier. Choose whichever field in Iterable you'd like to use to track users; this is set to email by default. 

      This identifier will be added to the Other Info field in eduMe and should be the same unique identifier across all campaigns for an individual user

Seamless URL template

http://connect.edume.com/iterable/getCourseLink?moduleId={{INSERT_MODULE_ID}}&groupId ={{INSERT_GROUP_ID}}&externalUserId={{#urlEncode}}{{email}}{{/urlEncode}}

*Where can I find my Team ID and Module ID?

You can find both your Team ID and Module ID by:
> Opening the course you're directing learners to
> Heading to the Delivery tab
> Click the Copy link button for the relevant team
> Click Seamless link to copy the link

Your link will look something like this, with the Module ID (in pink) followed by the Team ID (in blue):

Screenshot 2022-03-03 at 10.58.44

 

Create a data feed in Iterable

Once you have completed the prerequisites, login to your Iterable account to setup your data feed and follow the below steps:

  1. In the main menu, go to Content > Data feeds 
  2. Create a new data feed and give it a name
  3. Copy and paste the edited seamless URL into the URL field
  4. Ensure the format is set to JSON
  5. Add a new custom HTTP header field:
    • Copy and paste x-api-key into the first field
    • Copy and paste the API key from eduMe into the second field

  6. Click Save

 

Add your data feed to a campaign

Now your data feed is set up and ready to go, you can add it to a campaign in Iterable:

  1. In the main menu, go to Content > Templates
  2. Create a new template
  3. Choose the type of channel and template you want to use for the campaign
  4. Click Advanced Options on the template editing screen
  5. Select Enable template generation using data feeds... and select your data feed
  6. Select Merge the data feeds and user contexts

 

Insert the seamless link tag in the campaign

To insert the link into the campaign, you just need to add {{personalisedLink}} in the content of the campaign wherever you would like it to display.

You can test how this link will display to your end-user by going to Preview > Preview with data.

Note: If you are using an Alias, check the Iterable documentation here. When entering your seamless link into your content ensure you follow the format of  {{my_alias.personalisedLink}}

 

For further guidance, watch this video on setting up an Iterable data feed for eduMe:

HubSpot Video