Iterable

Why combine Iterable and Purchasely?

Pre-requisites

The minimal version of the Purchasely SDK supporting this integration is v//TODO: Kevin & Mathieu. If the Purchasely SDK integrated in your app is under the minimal version, please update it.

The Iterable SDK also needs to be integrated inside the app.

Subscription events

General overview

Iterable is a cross-channel marketing platform that powers unified customer experiences and empowers you to create, optimize and measure every interaction across the entire customer journey.

This integration will allow you to get all Purchasely subscription events to Iterable making you able to trigger automated communication based on those events, messages that could be linked to a Purchasely powered paywall to engage, upsell, retain customers.

Purchasely provides a unified dataset to track the subscription events for all stores. These events are generated by the Purchasely Backend and can be sent to Iterable.

Subscription events generated by Purchasely will be sent to Iterable using a server-to-server integration. As a result, you will be able to //TODO: Yoann

Events

The following events are the main ones that can be sent to Iterable by Purchasely. See the full list here.

Event	Description
SUBSCRIPTION_STARTED	Sent when the user purchased a product wether it is the start of a trial or a regular purchase of a consumable product.
SUBSCRIPTION_RENEWED	Sent when a subscription renews
SUBSCRIPTION_EXPIRED	Sent when the subscription actually ends
SUBSCRIPTION_REACTIVATED	Sent when an expired subscription is reactivated. This event is particularly useful for win-back & retargeting campaigns
SUBSCRIPTION_REFUNDED_REVOKED	Sent when the subscription actually ends
RENEWAL_DISABLED	Sent when the user deactivates the renewal of a subscription wether it is in trial period or not.
RENEWAL_ENABLED	Sent when the user reactivates
TRIAL_STARTED	Sent when a trial starts
TRIAL_CONVERTED	Sent when a user converts from a free trial to a normal paid-period
TRIAL_NOT_CONVERTED	Sent when a user finishes it's trial period without renewing to a paid-period

The names of events sent to Iterable can be overriden when setting up the integration.

Integrating Purchasely with Iterable

The integration requires 2 steps:

1. Associate the user to events by providing the Iterable User ID or your user's email (depending on which you use with Iterable) to the Purchasely SDK

2. Activate the Iterable integration in the Purchasely Console

1. Associating users to events

See the Iterable Documentation for more information

Swift

Purchasely.setAttribute(.iterableUserId, value: "userId")
//or use email
Purchasely.setAttribute(.iterableUserEmail, value: "[e-mail]")

Kotlin

Purchasely.setAttribute(Attribute.ITERABLE_USER_ID, "userId")
//or use email
Purchasely.setAttribute(Attribute.ITERABLE_USER_EMAIL, "[e-mail]")

Java

Purchasely.setAttribute(Attribute.ITERABLE_USER_ID, "userId");
//or use email
Purchasely.setAttribute(Attribute.ITERABLE_USER_EMAIL, "[e-mail]");

React Native

Purchasely.setAttribute(Attributes.ITERABLE_USER_ID,  "userId");
//or use email
Purchasely.setAttribute(Attributes.ITERABLE_USER_EMAIL,  "[e-mail]");

---

2. Activating the Iterable integration

The activation requires 2 steps:

1. Setting up a new ServerSide Integration API Key in the Iterable Dashboard

2. Enabling the Iterable integration in the Purchasely Console

a. Retrieve your Iterable API Key from the Iterable Dashboard

1. Follow the Iterable documentation

2. Write down your API Key

b. Enabling the Iterable integration in the Purchasely Console

1. Go in the "External integrations" section, and open the edition form for Iterable:

//TODO: Thomas: add screenshot

2. Enable the integration

3. Set your Iterable API Key

//TODO: Thomas: add screenshot

4. Enable the events you want to be sent to Iterable

5. (Optional) Override the names of the events that will be sent to Iterable

//TODO: Thomas: add screenshot

6. Save

Testing your integration

To test your integration, you can perform a set of in-app purchases in a Sandbox environment (eg: TestFlight for the App Store) and verify your events are received in the Iterable dashboard https://app.iterable.com/login.

If your events do not appear, check in your Iterable Projects Settings (https://app.iterable.com/settings/project) that your event is listed under Existing custom events or that Allow new custom events into the system is enabled.