Braze

The Braze Plugin integrates mobile push notifications and in-app event tracking to boost user engagement and strengthen data analytics. It also supports audience segmentation and targeted messaging by leveraging the Braze iOS SDK and Braze Android SDK.

👍

Developer Demo

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

Why use this plugin

• Push notifications: Enable push messaging workflows in your app.
• Event tracking: Send custom events to Braze for analytics and campaign logic.
• User targeting: Support segmentation and targeted messaging.
• Deep linking support: Open notification links directly in your app when deep linking is configured.

---

Prerequisites

• Access to the Braze plugin settings in the Median App Dashboard (Native Plugins tab).
• Braze credentials and endpoints for your platforms:
  • iosApiKey
  • iosEndpointKey
  • androidApiKey
  • androidEndpointKey
  • firebaseSenderId
• If using automatic prompts, set autoRegister in plugin config.
• If testing with the Median demo page, use https://median.dev/braze/.

---

Implementation Guide

Braze Setup

Enable push notifications through Braze In-App Messaging as documented in the Braze push primer.

App Configuration

Enable the Braze Plugin in the Native Plugins tab as shown below. The plugin does not require the configuration of the following parameters.

• autoRegister - Determines whether the app should automatically ask for push permissions at app launch
• API Keys and Endpoints - as configured in your Braze dashboard (Settings > APIs and Identifiers > API Keys)
• firebaseSenderId - Firebase Cloud Messaging Sender ID

Deep linking

Set up Deep Linking within your app, and notification links will automatically open directly into your app.

JavaScript Bridge Functions

Change User

Logs in an existing user or registers a new user in Braze context.

↔️Median JavaScript Bridge

Javascript

median.braze.changeUser({ userId: "user_123" });

Parameters:

Prompt for Push Notification Permission

Prompts users to enable push notifications.

↔️Median JavaScript Bridge

Javascript

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

Parameters:

Check Push Notification Permission

Checks if push notification permission has been granted.

↔️Median JavaScript Bridge

Javascript

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

Parameters:

Track Custom Events

Sends a custom event to Braze.

Note: Custom Events must be added in the Braze Dashboard.

↔️Median JavaScript Bridge

Javascript

median.braze.logCustomEvent("YOUR-EVENT-NAME", {
  "key1": value1,
  "key2": value2,
  ...
});

Parameters:

Testing Checklist

Use this checklist to validate Braze integration:

• Braze plugin configuration is set (including active, platform API keys, and endpoint keys).
• median.braze.promptNotification() returns a permission result.
• median.braze.notificationEnabled() returns current permission state.
• median.braze.changeUser({ userId }) is called for the active test user.
• median.braze.logCustomEvent() is called with a known event name.
• Test notifications are sent to a test user from Braze (Test tab).
• Notification opens app when configured as Open App.

---

Troubleshooting