SparkLoop’s easy 2-click integration lets you connect SparkLoop to your Iterable account within seconds, no developer or complicated Zapier hacks required!

This is a first and necessary step in setting up your SparkLoop account.

⚠️ Note: Currently, you can only connect one Iterable project per SparkLoop account. The project must be Email-based or Hybrid, as email addresses must be unique on your lists. Your SparkLoop publications and Referral Programs will be connected to Iterable static lists, not specific channels.

SparkLoop needs to access your email list in order to generate unique referral links and referral codes for each individual subscriber, thus ensuring they’re tracked and rewarded properly for referrals.

Don’t worry, however. This is an entirely seamless process and once you’ve selected your ESP and your list.

The steps for Iterable integration

When you sign up for SparkLoop, you will be asked to select your ESP.

From here, choose your ESP and follow the steps to complete the connection.

How long will the integration take?

Once you’ve selected your ESP and chosen your list, you'll need to wait for your list to finish importing.

How long will the import take?

It’s hard to say, but basically, it comes down to the size of your list.

For small lists of up to 50,000 subscribers, it’s unlikely to take more than half an hour, but if you’ve got a million subscribers on your list, then a couple of days (or more) wouldn’t be out of the question.

If it’s been more than 24 hours and your list hasn’t yet finished importing, feel free to contact us on the status. You can do so here.

What happens in Iterable after you import your list

After you create a campaign in SparkLoop and import your list, a bunch of user fields are automatically created in your Iterable account.

These include:

Custom field	Handlebar	Description
`RH_SUBID`	[[RH_SUBID]]	Subscriber's ID.
`RH_CODE`	[[RH_CODE]]	Subscriber's referral code.
`RH_REFLINK`	[[RH_REFLINK]]	Subscriber's referral link.
`RH_ISREF`	[[RH_ISREF]]	Whether or not the subscriber has been referred. "YES" or "NO".
`RH_TOTREF`	[[RH_TOTREF]]	Subscriber's total number of referrals since last reset.
`RH_GLOBREF`	[[RH_GLOBREF]]	Subscriber's all-time total number of referrals.
`RH_COUPON`	[[RH_COUPON]]	Subscriber's most-recently-won coupon code.
`RH_LASTREWARD`	[[RH_LASTREWARD]]	The ID of the last reward won by this subscriber.
`RH_SOURCE`	[[RH_SOURCE]]	The source of the referral, ie: sparkloop-magic or sparkloop-upscribe.
`RH_PARTNER`	[[RH_PARTNER]]	The ID of the partner who referred this subscriber. ie: "partner_abc123"

Before launching, we need to ensure that all of your newsletter subscribers have had their referral links generated and stored in the RH_REFLINK custom field. You can check this by visiting the Lists tab in Iterable, clicking on the name of the list that you selected for your SparkLoop campaign and adding a filtering condition. In this case, the condition will be "Find users that meet none of the following criteria", "Contact Property", where "RH_REFLINK Is Set". Hit "Refresh Results" and it should show no results for your list:

If your subscribers haven’t synced, check out this guide for the reasons why they haven’t, and what you can do about it.

⚠️ Make sure to wait until the list has finished importing completely before running checks.

What happens when subscribers are deleted or unsubscribe?

SparkLoop syncs with your ESP, which means that any new subscribes and unsubscribes are updated in SparkLoop automatically.

⚠️ You need to setup SparkLoop webhook in Iterable for this to work

And that’s it. Once your Iterable account is integrated with SparkLoop, you’re ready to start putting together your referral program.

Setting up webhooks

Go to Iterable System Webhooks settings and click "Create webhook"
Copy the webhook URL from your SparkLoop checklist and paste it in the "Endpoint URL" field and click "Create". Your webhook URL will look like https://hooks.sparkloop.app/teams/team_yourid123/iterable?token=123abc but with an id and token that are specific to your account
Change "Status" to "Enabled"
Don't change the "Authentication". It should be "None"
Check the following "Email" events: : Subscribe, Unsubscribe
Scroll down and click "Save Webhook"

You should read "Successfully updated webhook" in the bottom right corner of the page. If you go back to your System Webhook settings, the new webhook should be listed with "Enabled" status and "2 system events" as trigger.

Adding the referral section to your Iterable template

1. Start by copying the HTML code provided for you by SparkLoop. You can find it in the "Referral Section" page of your campaign.

2. Create a Campaign in Iterable and when editing the content select the "Side by Side" option.

3. Finally, paste the code in the editor that you'll find on the left side of the page. The referral section will be rendered on the right.

You may notice tags that look like [[RH_REFLINK]] within the referral section. Don't worry, if the RH_REFLINK data attribute is complete for your contacts, Iterable will replace the tag for the value stored in that field for each specific contact using Handlebars.