You're in the right place! Segment documentation is now part of Twilio Docs. The content you are used to is still here—just in a new home with a refreshed look.

Braze Web-Mode (Actions) Destination

Destination Info

Accepts Page, Group, Identify and Track calls.
Refer to it as Braze Web Mode (Actions), or Braze Web Device Mode (Actions) in the Integrations object
This destination is not compatible with Destination Insert Functions.

(information)

Additional versions of this destination are available

This page is about the Braze Web-Mode (Actions) Destination. See below for information about other versions of the Braze destination:

Braze, formerly Appboy, is an engagement platform that empowers growth by helping marketing teams to build customer loyalty through mobile, omni-channel customer experiences.

Benefits of Braze Web-Mode (Actions) vs Braze (Classic)

Braze web-mode (Actions) provides the following benefits over Braze (Classic):

E-commerce mappings. Users who can't follow the e-commerce spec due to incompatible event names (for example, Trip Booked vs Order Completed) can log purchases in Braze web-mode (Actions).

Getting Started

From the Segment web app, navigate to Connections > Catalog.
Search for "Braze" in the Catalog in the Destinations Catalog and select Braze.
Choose which of your sources to connect the destination to and follow the steps to create your destination.

(warning)

Mapping settings

Some events require specific property names to map correctly into Braze. For example, purchase events must use a products array with product_id and price. See Braze-web settings mappings for "Device-web" for the full list of requirements before setting up mappings.

In the Settings tab, configure the connection settings. API Key, SDK Endpoint, and REST Endpoint are required settings.

After setting up your Braze web-mode (Action) destination in the Segment app, Segment's Analytics.js library starts asynchronously loading the Braze SDK on your page and sending data. Data appears in the Segment CDN in about 45 minutes.

(information)

Info

If you're using a device-mode connection, Braze's SDK assigns a device_id and a backend identifier, braze_id, to every user. This allows Braze to capture anonymous activity from the device by matching on those identifiers instead of userId. This applies to device-mode connections.

Destination Settings

Property nameTypeRequiredDescription

Allow Crawler Activityboolean

Optional

Allow Braze to log activity from crawlers. See more details

Allow User Supplied Javascriptboolean

Optional

To indicate that you trust the Braze dashboard users to write non-malicious Javascript click actions, set this property to true. See more details

API Keystring

required

Found in the Braze Dashboard under Manage Settings → Apps → Web

App Versionstring

Optional

Version to which user events sent to Braze will be associated with. See more details

Automatically Send In-App Messagesboolean

Optional

When this is enabled, all In-App Messages that a user is eligible for are automatically delivered to the user. If you'd like to register your own display subscribers or send soft push notifications to your users, make sure to disable this option.

Content Security noncestring

Optional

Allows Braze to add the nonce to any <script> and <style> elements created by the SDK. See more details

Only Track Known Usersboolean

Optional

If enabled, this setting delays initialization of the Braze SDK until the user has been identified. When enabled, events for anonymous users will no longer be sent to Braze.

Device Property Allow Listarray

Optional

By default, the Braze SDK automatically detects and collects all device properties in DeviceProperties. To override this behavior, provide an array of DeviceProperties. See more details

Disable Push Token Maintenanceboolean

Optional

By default, users who have already granted web push permission will sync their push token with the Braze backend automatically on new session to ensure deliverability. To disable this behavior, set this option to true

Do Not Load Font Awesomeboolean

Optional

Braze automatically loads FontAwesome 4.7.0 from the FontAwesome CDN. To disable this behavior set this option to true.

Enable Loggingboolean

Optional

Set to true to enable logging by default

Enable SDK Authenticationboolean

Optional

Set to true to enable the SDK Authentication feature.

SDK Endpointselect

required

Your Braze SDK endpoint. See more details

In-App Message Z Indexnumber

Optional

By default, the Braze SDK will show In-App Messages with a z-index of 1040 for the screen overlay, 1050 for the actual in-app message, and 1060 for the message's close button. Provide a value for this option to override these default z-indexes.

Localizationstring

Optional

By default, any SDK-generated user-visible messages will be displayed in the user's browser language. Provide a value for this option to override that behavior and force a specific language. The value for this option should be a ISO 639-1 Language Code.

Manage Service Worker Externallyboolean

Optional

If you have your own service worker that you register and control the lifecycle of, set this option to true and the Braze SDK will not register or unregister a service worker. See more details

Minimum Interval Between Trigger Actions in Secondsnumber

Optional

Provide a value to override the default interval between trigger actions with a value of your own. See more details

No Cookiesboolean

Optional

By default, the Braze SDK will store small amounts of data (user ids, session ids), in cookies. Pass true for this option to disable cookie storage and rely entirely on HTML 5 localStorage to identify users and sessions. See more details

Open Cards In New Tabboolean

Optional

By default, links from Card objects load in the current tab or window. Set this option to true to make links from cards open in a new tab or window.

Open In-App Messages In New Tabboolean

Optional

By default, links from in-app message clicks load in the current tab or a new tab as specified in the dashboard on a message-by-message basis. Set this option to true to force all links from in-app message clicks open in a new tab or window.

Require Explicit In-App Message Dismissalboolean

Optional

By default, when an in-app message is showing, pressing the escape button or a click on the greyed-out background of the page will dismiss the message. Set this option to true to prevent this behavior and require an explicit button click to dismiss messages.

Safari Website Push IDstring

Optional

If you support Safari push, you must specify this option with the website push ID that you provided to Apple when creating your Safari push certificate (starts with "web", e.g. "web.com.example.domain").

SDK Versionselect

required

The version of the Braze SDK to use

Service Worker Locationstring

Optional

By default, when registering users for web push notifications Braze will look for the required service worker file in the root directory of your web server at /service-worker.js. If you want to host your service worker at a different path on that server, provide a value for this option that is the absolute path to the file, e.g. /mycustompath/my-worker.js. VERY IMPORTANT: setting a value here limits the scope of push notifications on your site. For instance, in the above example, because the service ,worker file is located within the /mycustompath/ directory, appboy.registerAppboyPushMessages MAY ONLY BE CALLED from web pages that start with http://yoursite.com/mycustompath/.

Session Timeout in Secondsnumber

Optional

By default, sessions time out after 30 minutes of inactivity. Provide a value for this configuration option to override that default with a value of your own.

Available Presets

Braze Web Device Mode (Actions) has the following presets

Preset Name	Trigger	Default Action
Order Completed calls	Event type = "track" and event = "Order Completed"	Track Purchase
Track Calls	Event type = "track" and event != "Order Completed"	Track Event
Identify Calls	Event type = "identify", Event type = "group"	Update User Profile

Available Actions

Build your own Mappings. Combine supported triggers with the following Braze Web Device Mode-supported actions:

(information)

Mapping limits per destination

Individual destination instances have support a maximum of 50 mappings.

Debounce Middleware

When enabled, it ensures that only events where at least one changed trait value are sent to Braze, and events with duplicate traits are not sent. Debounce functionality requires a frontend client to work. Therefore, it cannot be used with server-side libraries or with Engage.

Debounce Middleware is a Web action. The default Trigger is type = "identify" or type = "group"

This action does not have any fields.

Track Event

Reports that the current user performed a custom named event.

Track Event is a Web action. The default Trigger is type = "track" and event != "Order Completed"

Property nameTypeRequiredDescription

Event NameSTRING

required

The identifier for the event to track.

Event PropertiesOBJECT

Optional

Hash of properties for this event.

Update User Profile

Updates a users profile attributes in Braze

Update User Profile is a Web action. The default Trigger is type = "identify" or type = "group"

Property nameTypeRequiredDescription

External User IDSTRING

Optional

The unique user identifier

CountrySTRING

Optional

The country code of the user

Current LocationOBJECT

Optional

The user's current longitude/latitude.

Custom AttributesOBJECT

Optional

Sets a custom user attribute. This can be any key/value pair and is used to collect extra information about the user.

Date of BirthDATETIME

Optional

The user's date of birth

EmailSTRING

Optional

The user's email

Email SubscribeSTRING

Optional

The user's email subscription preference: “opted_in” (explicitly registered to receive email messages), “unsubscribed” (explicitly opted out of email messages), and “subscribed” (neither opted in nor out).

First NameSTRING

Optional

The user's first name

Last NameSTRING

Optional

The user's last name

GenderSTRING

Optional

The user's gender: “M”, “F”, “O” (other), “N” (not applicable), “P” (prefer not to say) or nil (unknown).

Home CitySTRING

Optional

The user's home city.

Image URLSTRING

Optional

URL of image to be associated with user profile.

LanguageSTRING

Optional

The user's preferred language.

Phone NumberSTRING

Optional

The user's phone number

Push SubscribeSTRING

Optional

The user's push subscription preference: “opted_in” (explicitly registered to receive push messages), “unsubscribed” (explicitly opted out of push messages), and “subscribed” (neither opted in nor out).

Subscription GroupsOBJECT

Optional

A list of subscription group IDs and states to set. Subscription group states can be either "subscribed" or "unsubscribed". Subscription Group IDs are found in the Braze dashboard.

Track Purchase

Reports that the current user made an in-app purchase.

Track Purchase is a Web action. The default Trigger is type = "track" and event = "Order Completed"

Property nameTypeRequiredDescription

Purchase PropertiesOBJECT

Optional

Hash of properties for this purchase. Keys are limited to 255 characters in length, cannot begin with a $, and can only contain alphanumeric characters and punctuation. Values can be numeric, boolean, Date objects, strings 255 characters or shorter, or nested objects whose values can be numeric, boolean, Date objects, arrays, strings, or null. Total size of purchase properties cannot exceed 50KB.

ProductsOBJECT

Optional

List of products purchased by the user

Other features

Braze web-mode (Actions) can use the following features of Braze.

In-app messaging

Once configured, you can trigger in-app message display as a result of several different event types. By default, all In-App Messages that a user is eligible for are automatically delivered to the user upon a session start event. A new session automatically starts when a user loads your site. If you'd like to force a new session for a user, make an Identify call with the corresponding userId for that user.

If you don't want your site to display new In-App Messages as they're received, disable automatic display and register your own display subscribers. To do this:

Create your subscriber by calling:

1analytics.ready(function() {
2  window.appboy.subscribeToNewInAppMessages(function(inAppMessages) {
3      // Display the first in-app message. You could defer display here by pushing this message to code      within in your own application.
4      // If you don't want to use Appboy's built-in display capabilities, you could alternatively pass      the in-app message to your own display code here.
5      window.appboy.display.showInAppMessage(inAppMessages[0]);
6
7    // Return an array with any remaining, unhandled messages to appboy's internal queue.
8    // These will be part of the inAppMessages param the next time this subscriber is invoked.
9      return inAppMessages.slice(1);
10    });
11});

The inAppMessages parameter will be an array of appboy.ab.InAppMessage subclass or appboy.ab.ControlMessage objects, each of which has various lifecycle event subscription methods.

Push notifications

To support push notifications on Chrome, you must enable FCM/GCM and configure your site. See steps one and two in the Braze docs for detailed instructions on both.

Browser Registration: For a browser to receive push notifications, you must register it for push by calling:

1analytics.ready(function() {
2  window.appboy.registerAppboyPushMessages();
3});

Note: Place this snippet outside of your Segment Snippet within your script tag.

Note: This requests push permission from the user.

To show your own push-related UI to the user before requesting push permission (known as a soft push prompt), you can test to see if the user's browser supports push by calling:

1analytics.ready(function() {
2  if (window.appboy.isPushSupported()) {
3    // Add your push logic
4  }
5 });

Braze recommends checking to see if this returns true since not all browsers can receive push notifications. See Soft Push Prompts for instructions on setting up a soft push prompt using Braze In-App Messages.

To unsubscribe a user, call:

1analytics.ready(function() {
2  window.appboy.unregisterAppboyPushMessages();
3});

Set your GCM/FCM server API key and SenderID on the Braze dashboard. You can find more details for this in Braze's Initial SDK setup for web documentation.
To support push notifications on Safari, add your Website Push ID into your Segment Settings UI and Segment sends it when the Braze Web SDK initializes. To get your Website Push ID, follow the first two bullet points in these instructions.

Soft push prompts

Follow step one detailed in the Braze docs, to create a "Prime for Push" in-app messaging Campaign on the Braze dashboard.
Add the following snippet to your site:

1analytics.ready(function() {
2  window.appboy.subscribeToNewInAppMessages(function(inAppMessages) {
3    var message = inAppMessages[0];
4    if (message != null) {
5      var shouldDisplay = true;
6
7      if (message instanceof appboy.ab.inAppMessage) {
8        // Read the key/value pair for msg-id
9        var msgId = message.extras["msg-id"];
10
11        // If this is our push primer message
12        if (msgId == "push-primer") {
13          // We don't want to display the soft push prompt to users on browsers that don't support push, or if the user
14          // has already granted/blocked permission
15          if (!appboy.isPushSupported() || appboy.isPushPermissionGranted() || appboy.isPushBlocked())     {
16            shouldDisplay = false;
17          }
18          // Prompt the user when the first button is clicked
19          message.buttons[0].subscribeToClickedEvent(function() {
20            appboy.registerAppboyPushMessages();
21          });
22        }
23      }
24
25      // Display the message
26      if (shouldDisplay) {
27        appboy.display.showInAppMessage(message);
28      }
29     }
30
31    // Remove this message from the array of IAMs and return whatever's left
32    return inAppMessages.slice(1);
33   });
34 });

For more details on this snippet, see Braze's Soft push prompt documentation.

(information)

Info

Place this snippet outside of your Segment Snippet within your script tag.

When you'd like to display the Soft Push to a user, call:

1 analytics.ready(function() {
2  window.appboy.logCustomEvent("prime-for-push")
3 });

Enable SDK authentication

When "Enable SDK Authentication" is enabled, Segment will set Braze's enableSdkAuthentication to true. When this feature is enabled, the Braze SDK will append the current user's last known JWT to network requests made to Braze Servers.

Important differences from Braze (Classic) destination

Braze web-mode (Actions) supports the Braze Web integration. Braze Cloud-Mode (Actions) supports server and mobile sources, but to use mobile sources in device-mode, use the Braze Classic destination.

Migration from Braze (Classic)

Keep the following in mind if you plan to move to Braze (Actions) from the classic Braze destination.

Braze-web settings mapping

Braze-web Classic Destination Setting	How to enable in Braze-web (Actions)
CONNECTION SETTINGS
App Identifier clouddevice-web	Global Setting The setting is called App ID
REST API Key cloud	This setting is renamed API Key in the Braze Web Mode (Actions) Connection Settings.
Appboy Datacenter cloud	This setting is covered by the SDK Endpoint in Braze Web Mode (Actions) Connection Settings.
Log Purchase when Revenue is present device-web	Modify the Trigger for the Track Purchase action to recreate this behavior in Braze (Actions). By default, events named "Order Completed" trigger this action, but you can update the Trigger to check for a property named `revenue`. The event must have a `products` array with `product_id` and `price`.
Safari Website Push ID device-web	This setting is available in the Braze Web Mode (Actions) Connection Settings.
Braze Web SDK Version device-web	Available in the SDK Version Connection Setting. Defaults to version 3.3.
Connection Mode clouddevice-web	Choose the version of the Braze (Actions) destination that matches your connection mode.
IN-APP MESSAGING
Do Not Load Font Awesome device-web	Available in the Braze Web Mode (Actions) Connection Settings.
Open In-App Messages in New Tab device-web	Available in the Braze Web Mode (Actions) Connection Settings.
PAGE
Track All Pages device-web	Create a Track Event subscription and update the Event Trigger to specify `Event Type is Page` and `Event Property 'name' exists`. Update the Event Name field for the Track Event action to "Viewed Page {name}". Use the Event Variables selector to select the `name` variable.
Track Only Named Pages device-web	Create a Track Event subscription and update the Event Trigger to specify `Event Type is Page` and. Update the Event Name field for the Track Event action to "Viewed Page {name}". Use the Event Variables selector to select the `name` variable.
OTHER SETTINGS
Allow Crawler Activity device-web	Available in the Braze Web Mode (Actions) Connection Settings.
Enable Logging device-web	Available in the Braze Web Mode (Actions) Connection Settings.
Minimum Interval Between Trigger Actions in Seconds device-web	Available in the Braze Web Mode (Actions) Connection Settings.
Open News Feed Cards in New Tab device-web	Available in the Braze Web Mode (Actions) Connection Settings.
Service Worker Location device-web	Available in the Braze Web Mode (Actions) Connection Settings.
Session Timeout in Seconds device-web	Available in the Braze Web Mode (Actions) Connection Settings.

FAQs

How does the Debounce Middleware Action work?

The following Debounce Middleware logic is executed at the source-level:

When an Identify call is fired on a website, Segment first caches and compares the user traits object.

If the user traits differ from what was previously cached, the data flows through destination filters, insert functions, and then through destination mappings.
If user traits are the same as what's cached, Segment assumes that that data was already sent to Braze and a does not make a new request to Braze.