Iterable

The Iterable plugin connects your app to Iterable’s iOS and Android SDKs (Overview of Iterable's iOS and Android SDKs) for push delivery, audience targeting, and user identification. Configure the plugin in the Median dashboard (including API key and optional data region), then use the JavaScript Bridge to initialize the SDK when needed, register for push, request permission, and identify users by email or user ID.

Why use Iritable

• Push delivery: Send Iterable campaigns to devices through the native push channel.
• Segmentation and targeting: Align push with Iterable audiences and campaign logic.
• Flexible initialization: Supply apiKey in App Studio for automatic setup, or call initialize at runtime when you need dynamic configuration.
• User identification: Tie devices to Iterable profiles with setEmail or setUserId, then refresh the push token with registerPush as documented by Iterable.

👍

Developer Demo

Display our demo page in your app to test during development https://median.dev/iterable/

Prerequisites

• A Median.co app with JavaScript Bridge enabled
• Access to Push Notifications → Iterable in the Median App Dashboard
• An Iterable API key and (if applicable) a data region such as EU
• Deep linking enabled in the app if notification URLs should open in-app

When to use this plugin

Iterable is essential for apps that need to:

What you'll do

Use this section as a fast navigation map into the full setup and implementation details:

1. Configure Iterable in Median: Complete Plugin setup and Enable the plugin, including deep linking if you need in-app URLs.
2. Tune dashboard settings: Review Configuration options for active, autoRegister, apiKey, and dataRegion.
3. Wire the JavaScript Bridge: Implement JavaScript bridge functions—initialize (if not using dashboard auto-init), check isInitialized, register push, request permission, and identify users.
4. Validate end-to-end: Run through Testing checklist and use Troubleshooting if something fails.

Important considerations

• If autoRegister is true, the app may prompt for notification permission automatically; otherwise control timing with requestPermission and your own UX.
• After setEmail or setUserId, call registerPush so Iterable receives an updated token for that user.
• Set dataRegion when your Iterable workspace uses a non-default region (for example EU).

Integration Guide

Plugin setup

Enable the plugin

1. Navigate to Push Notifications: In the Median.co dashboard, open the Push Notifications tab and select Iterable.
2. Enable Iterable: Turn the plugin on and paste your Iterable API key (and data region if required).
3. Configure settings: Adjust active, autoRegister, and related fields to match your rollout. Enable Deep linking in the app so notification links open in-app rather than only in the device browser.

Configuration options

Example configuration:

{
  "active": true | false,
  "autoRegister": true | false, // optional, if true push permission will be requested automatically
  "apiKey": STRING, // if specified initialization will initiate automatically, otherwise provide when initializing at runtime via JavaScript Bridge
  "dataRegion": STRING // if specified (e.g. 'EU') the app will use region-specific endpoints, can also be provided when initializing at runtime via JavaScript Bridge
}

Note: If you omit apiKey from dashboard config, call median.iterable.initialize() from your web layer with the same key and optional dataRegion before relying on other bridge methods.

JavaScript bridge functions

Initialize

Manually initializes the Iterable SDK when you are not relying on automatic initialization from App Studio config.

↔️Median JavaScript Bridge

JavaScript

median.iterable.initialize({
  'apiKey': STRING,
  'dataRegion': STRING, // optional, e.g. 'EU'
  'callback': function // optional otherwise returns promise
});
// Return value:
{
  "success": true | false
}

Parameters:

Is initialized

Returns whether the Iterable SDK has been initialized and, when initialized, echoes the active apiKey and dataRegion.

↔️Median JavaScript Bridge

JavaScript

median.iterable.isInitialized({'callback': function});
// Return value:
{
  'initialized': true | false,
  'apiKey': STRING, // available only if initialized is true
  'dataRegion': STRING // available only if initialized is true
}

Parameters:

Register push

Registers the current user for push notifications and refreshes the device token.

↔️Median JavaScript Bridge

JavaScript

median.iterable.registerPush({'callback': function});
// Return value:
{
  "success": true | false
}

Parameters:

Request permission

Prompts the user for push notification permission.

↔️Median JavaScript Bridge

JavaScript

median.iterable.requestPermission({'callback': function});
// Return value:
{
  "granted": true | false
}

Parameters:

Set email

Identifies the current user by email in Iterable. After a successful call, invoke registerPush to generate a new token for that profile.

↔️Median JavaScript Bridge

JavaScript

median.iterable.setEmail({
  'email': STRING,
  'callback': function // optional otherwise returns promise
});
// Return value:
{
  "success": true | false
}

Parameters:

Set user ID

Identifies the current user by user ID. After a successful call, invoke registerPush to generate a new token for that profile.

↔️Median JavaScript Bridge

JavaScript

median.iterable.setUserId({
  'userId': STRING,
  'callback': function
});
// Return value:
{
  "success": true | false
}

Parameters:

Testing checklist

Use this checklist to ensure Iterable is working correctly in your app:

Troubleshooting

📘

Still having issues?

For issues related to Iretable's own configuration, permissions, or platform-specific behavior outside of Median.co, refer to Iretable's integration documentation.