Braze Destination
UpdatedAbout this integration
Braze is a platform that helps you send messages across multiple platforms to engage customers and foster loyalty. The source data that you send to Braze adds and updates users. You can take advantage of user data and the source events sent to braze to trigger and personalize messages.
Web only mode
You can set up this integration in “web” mode. When set up this way, our JavaScript client will load the Braze SDK and send data directly to Braze, bypassing Customer.io entirely.
We don’t typically recommend setting things up this way, because:
- You won’t capture data in Customer.io.
- As the name suggests, you cannot use this mode with other sources of data (mobile SDKs, server-side libraries, and so on).
- It can be hard to debug this sort of implementation.
Otherwise, there are very few functional differences besides the sources they support.
Getting started
Go to Data & Integrations > Integrations and select the Braze entry in the Directory tab.
(Optional) Select the data sources that you want to connect to your outbound integration. You can always connect data sources later. We’ll only show you data sources that work with your integration.
Configure your integration.
Api Key: Created under Developer Console in the Braze Dashboard.
App Id: The app identifier used to reference specific Apps in requests made to the Braze API. Created under Developer Console in the Braze Dashboard.
Endpoint: Your Braze REST endpoint. See more details
Click Enable Destination.
Identifiers in Braze
Braze calls require an external_id or a braze_id. We map userId from source events to Braze’s external_id. The braze_id is essentially Braze’s anonymous ID.
So, if you haven’t identified a user by userId, we use the braze_id—which is just Braze’s anonymous Identifier. Otherwise, when you’ve identified someone, we’ll use the external_id.
Actions
When you’re done setting things up, you can go to the Actions tab to see how we map incoming data to your integration.
Update User Profile
Default Trigger: type = “identify”
Update a user’s profile attributes in Braze
Track Event
Default Trigger: type = “track” and event != “Order Completed”
Record custom events in Braze
Track Purchase
Default Trigger: event = “Order Completed”
Record purchases in Braze
Create Alias
Default Trigger: event = “Create Alias”
Create new user aliases for existing identified users, or to create new unidentified users.
Identify User
Identifies an unidentified (alias-only) user. Use alongside the Create Alias action, or with user aliases you have already defined.
Getting started: web mode
Go to Data & Integrations > Integrations and select the Braze entry in the Directory tab.
(Optional) Select the data sources that you want to connect to your outbound integration. You can always connect data sources later. We’ll only show you data sources that work with your integration.
Configure your integration. See Configuration Settings below for information about individual configuration parameters.
Click Enable Destination.
Web mode settings
| Setting | Default | Description |
|---|---|---|
| Sdk Version | 4.6 | The version of the Braze SDK to use |
| Api Key | Found in the Braze Dashboard under Manage Settings → Apps → Web | |
| Endpoint | sdk.iad-01.braze.com | Your Braze SDK endpoint. See more details |
| Allow Crawler Activity | Allow Braze to log activity from crawlers. See more details | |
| Allow User Supplied Javascript | To indicate that you trust the Braze dashboard users to write non-malicious Javascript click actions, set this property to true. If enableHtmlInAppMessages is true, this option will also be set to true. See more details | |
| Defer Until Identified | 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. | |
| App Version | Version to which user events sent to Braze will be associated with. See more details | |
| Content Security Nonce | Allows Braze to add the nonce to any <script> and <style> elements created by the SDK. See more details | |
| Device Property Allowlist | 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 Maintenance | 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 Awesome | Braze automatically loads FontAwesome 4.7.0 from the FontAwesome CDN. To disable this behavior set this option to true. | |
| Enable Logging | Set to true to enable logging by default | |
| Enable Sdk Authentication | Set to true to enable the SDK Authentication feature. | |
| In App Message Z Index | 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. | |
| Localization | en | 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. |
| Automatically Display Messages | true | 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. |
| Manage Service Worker Externally | 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 Seconds | 30 | Provide a value to override the default interval between trigger actions with a value of your own. See more details |
| No Cookies | 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 Tab | 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 Tab | 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 Dismissal | 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 Id | 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"). | |
| Service Worker Location | 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 Seconds | 1800 | 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. |
Web mode actions
When you’re done setting things up, you can go to the Actions tab to see how we map incoming data to your integration.
You may need to add actions for this integration
While we often have default triggers for actions, we don't always add those actions as defaults. You may need to add actions to make sure that you're sending all the data that you want to send to your integration. See our actions page for help setting up actions.
Update User Profile
Default Trigger: type = “identify” or type = “group”
Updates a users profile attributes in Braze
Track Event
Default Trigger: type = “track” and event != “Order Completed”
Reports that the current user performed a custom named event.
Track Purchase
Default Trigger: type = “track” and event = “Order Completed”
Reports that the current user made an in-app purchase.
Debounce Middleware
Default Trigger: type = “identify” or type = “group”
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.
