Bloomreach

The Bloomreach plugin enables native mobile push notifications and customer identity tracking to maximize engagement and audience insight. It integrates the official Bloomreach iOS SDK on iOS and the Bloomreach Android SDK on Android. Both integrations are built on Bloomreach's Exponea SDK core.

This guide covers Bloomreach Engagement project setup, Median App Studio configuration, Android push delivery via Firebase, deep linking, and the Median JavaScript Bridge APIs for permissions and customer identity.

Why use Bloomreach?

• Push permission control: Request and check notification permission from JavaScript.
• Customer identity support: Identify and persist customer state across sessions.
• Customer logout support: Clear customer session state when needed.
• Deep linking readiness: Configure domains to route links into the app.

Prerequisites

• Access to Bloomreach plugin settings in Median App Studio (Native Plugins tab).
• Bloomreach credentials from your Bloomreach Engagement dashboard:
  • apiKey
  • projectToken
  • baseURL
• For Android push, plan Firebase Cloud Messaging (FCM) with google-services.json and Bloomreach; see Android push notifications.
• For deep linking, plan domains for hosts and host platform verification files; see Deep linking setup.

Implementation guide

Bloomreach Engagement setup

Bloomreach Engagement issues one set of SDK credentials per project: a project token, an API key (public key), and a base URL. Median uses these same three values to initialize the native iOS and Android SDKs on your behalf. A manual SDK integration or initialization is not required.

Retrieve your credentials from the Bloomreach Engagement web app under Project settings > Access management > API. For background on how these credentials map to SDK initialization, see the official Configuration for iOS SDK and Configuration for Android SDK references.

App configuration

1. In Median App Studio, open your Native Plugins tab.
2. Find the Bloomreach plugin in your list of 'Added plugins' and activate it as shown below.
3. Rebuild your app to apply the new configuration.

Plugin configuration options

After activating the plugin there are different configuration options available for your team. Below you can find a configuration reference and example.

Example configuration (JSON)

{
  "active": true,
  "autoRegister": false,
  "apiKey": "your-api-key",
  "projectToken": "your-project-token",
  "baseURL": "https://api.eu1.exponea.com",
  "hosts": ["median.dev", "median.com"]
}

Replace each value with the credentials from your Bloomreach Engagement project and your app's own domains.

Android push notifications

Android devices receive Bloomreach Engagement push notifications through Firebase Cloud Messaging (FCM). Complete both of the following:

1. google-services.json — In Median App Studio, open the Build & Deploy tab and upload your Firebase project's google-services.json file so it's embedded in the app binary.
2. Firebase Cloud Messaging integration in Bloomreach Engagement — In the Bloomreach Engagement web app, add a Firebase Cloud Messaging integration under Data & Assets > Integrations, then enable it under Project Settings > Channels > Push notifications.

For Bloomreach-side steps (projects, keys, and campaigns), use Bloomreach’s documentation.

Deep linking setup

Deep links open URLs inside your app instead of the device browser when domains are allowlisted and platform association files are valid and reachable over HTTPS.

1. Plugin configuration — Add every domain you want to open in-app to the hosts array. Do not include https:// or http://; the plugin applies URL schemes as needed.
2. Hosted verification files — On each domain (and subdomain you use), serve the standard association files over HTTPS:
   • Android — /.well-known/assetlinks.json (format and examples: Deep linking). Example host file: https://median.dev/.well-known/assetlinks.json.
   • iOS — /.well-known/apple-app-site-association (or /apple-app-site-association). Example: https://median.dev/.well-known/apple-app-site-association.

Use Median.co's Deep Linking Validator to check your domain configuration, and read Deep linking for background on Universal Links, App Links, and file requirements.

Note: An incorrect deep link setup causes links to open in the mobile device browser instead of the app. Confirm your hosts list and hosted verification files before testing push-triggered links.

JavaScript Bridge functions

All methods are available on the median.bloomreach namespace and should be called after the Median JavaScript Bridge is fully initialized.

Request push notification permission

Prompt for the Push Notification permission, which displays a dialog for users to confirm permission. For Android, the dialog only displays on Android 13 and above. Android 12 and below will always be granted without user intervention.

Provide a callback function or await the returned promise.

median.bloomreach.promptNotification({ callback: function })
// Return value:
{
  "granted": true | false
}

Parameters:

Check push notification permission

Checks whether push permission is currently granted, without prompting the user.

median.bloomreach.notificationEnabled({'callback': function})
// Return value:
{
  "granted": true | false
}

Parameters:

Identify customer

Identifies a customer by a hard identifier and value, so Bloomreach Engagement can associate device activity with a known profile. State persists until logoutCustomer is called.

const params = {
  identifier: "registered",
  value: "[email protected]",
};

const result = await median.bloomreach.identifyCustomer(params);

Parameters:

Optionally, include user properties:

const params = {
  identifier: "registered",
  value: "[email protected]",
  properties: {
    first_name: "John",
    last_name: "Doe",
    age: 25,
  },
};

Logout customer

Clears the current customer session, detaching subsequent tracking and push delivery from the previously identified profile.

median.bloomreach.logoutCustomer({callback: function})
// Return value:
{
  "success": BOOLEAN
}

Parameters:

Usage examples

Prompt for permission only if not already granted

async function ensureBloomreachPermission() {
  const status = await median.bloomreach.notificationEnabled();
  if (!status.granted) {
    const result = await median.bloomreach.promptNotification();
    console.log("Permission granted:", result.granted);
  }
}

Identify a customer, then clear the session on logout

async function setAndClearCustomer() {
  await median.bloomreach.identifyCustomer({
    identifier: "registered",
    value: "[email protected]",
    properties: {
      first_name: "John",
      last_name: "Doe",
      age: 25,
    },
  });

  await median.bloomreach.logoutCustomer();
}

Testing checklist

Use this checklist to validate your Bloomreach integration before release:

Basic Functionality

• Plugin is active and apiKey, projectToken, and baseURL are all set correctly.
• promptNotification displays the native permission dialog and returns a result.
• notificationEnabled accurately reflects the device's current permission state.
• identifyCustomer is called with a valid identifier/value pair, and the profile appears in the Bloomreach Engagement customer list.
• logoutCustomer clears the session and stops further tracking for that profile.

Configuration Testing

• Android build includes google-services.json.
• Bloomreach Engagement's Firebase Cloud Messaging integration is configured with a valid service account private key.

Deep Linking

• hosts includes every intended deep-link domain, without a scheme.
• Association files (assetlinks.json, apple-app-site-association) are hosted and pass Median's Deep Linking Validator.
• Tapping a push notification or campaign link opens the correct screen in-app, not the browser.

Troubleshooting