Bloomreach

The Bloomreach Plugin enables the integration of mobile push notifications within your app. With support for audience segmentation and targeted messaging, this plugin leverages the capabilities of the Bloomreach iOS SDK and Bloomreach Android SDK to enhance user engagement.

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.

Integration guide

Plugin setup

Enable the Plugin

1. In the Median App Studio, open Bloomreach plugin settings under Push Notifications.
2. Set active to true.
3. Add required values: apiKey, projectToken, and baseURL.
4. Configure autoRegister for automatic permission prompting on app launch.
5. Add optional hosts values for deep linking support.

Configuration Options

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 values with those from your Bloomreach Engagement project and your app’s domains.

Android push notifications

Android deliver push through Firebase Cloud Messaging (FCM). Configure all of the following:

1. google-services.json — Embed the Firebase config in your build. In Median App Studio, open the Build & Deploy tab and upload your google-services.json so it is included in the app binary.
2. Bloomreach Engagement — In the Bloomreach Engagement web app, enable push for your project and add your FCM server key so Bloomreach can send notifications to your app.

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

Deep linking setup

Deep links open URLs in your app when domains are allowlisted and platform association files are valid.

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, and read Deep linking for Universal Links, App Links, and file requirements.

JavaScript Bridge Functions

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 otherwise return a promise.

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

Parameters:

Check push notification permission

Checks whether push permission is granted.

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

Parameters:

Identify customer

Identifies a customer by identifier and value. State persists until logout.

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.

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

Parameters:

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 and later clear a customer session

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 Bloomreach integration:

Basic Functionality

• Plugin is active and required config values are set.
• promptNotification returns a permission result.
• notificationEnabled returns current permission state.
• identifyCustomer is called with valid identifier/value.
• logoutCustomer clears the current customer session.

Configuration Testing

• Android app includes google-services.json.
• Bloomreach push setup includes FCM server key.
• hosts includes all intended deep-link domains.
• Verification files are hosted for iOS and Android deep linking.

Deep Linking"

• Deep links open in-app for configured domains.
• Deep Linking Validator checks pass.

Troubleshooting