Integrate Braze

9 min

Note

The terms audiences and segments are interchangeable. Optimizely has updated all segments to audiences on the Audiences page and is updating the UI on other pages. See Understand audiences to get information on audiences.

Sync your Braze customer segments and events to Optimizely Data Platform (ODP) nightly to enrich customer profiles, reports, and segmentation.

You can also sync ODP customer data and events to Braze to enrich your Braze customer data and trigger Braze messaging based on customer events in ODP (like opening an email).

Prerequisites

Braze account

ODP account

You only need to complete the instructions in this section if your app consent setting for the API channel is set to Opted Out. This setting must be set to Opted In for this app to successfully send data.

Go to Settings > App Consent Settings in ODP.

Set the Api app's Default Consent to Opted In.

Click Update Consent in the confirmation prompt.

Enable the integration

Go to Data Setup > App Directory in ODP.

Select the Braze app.

Click Install App.

Enter your Braze REST API Key, select your Braze Instance URL, and click Verify API Key on the Settings tab.

Create a Custom Currents Export in Braze using the endpoint and token provided in ODP. This is required to sync Braze events to ODP.

Expand the Segments section of the Braze app in ODP.

Select the Braze audiences you want to sync to ODP from the Segments to Sync multi-select list.

If you want to sync all segments, select Import All User Profiles.

Important

You must select audiences here (or opt to import all audiences) to import Braze customer profiles. If you do not select any audience, the integration will not import any customer profiles.

Add any additional field mappings you want between Braze and ODP in the Segments section.

Click Save to start syncing data from Braze to ODP.

Map data fields

The app has default data field mappings between Braze and ODP. For example, the Email field in Braze is mapped to the Last Seen Email field in ODP.

If there are additional data fields in Braze that you want to map to ODP, complete the following in the Segments section of the app:

Select the Braze field from the Braze User Data Fields drop-down list.

Select the ODP field from the ODP Customer Fields drop-down list.

Click Save Field Map.

You can also delete any data field mappings that are not required in the Segments section of the app:

Select the field mapping you want to delete from the Field Map drop-down list.

Click Delete Field Map.

Sync data from ODP to Braze

After you configure the app, you can set up an activation in ODP to sync your ODP customer data to Braze.

Go to Activations > Overview.

Click Create New Campaign.

To set up an automated, recurring sync, click Behavioral.

Click Create From Scratch.

Enter a name for your activation that represents the data you are syncing to Braze (for example, Braze Data Sync).

Choose to sync data for customers that match a audience or sync data for customers that trigger an event (like when ODP registers that a customer opens an email) in the Enrollment section.

Customers that match a segment – Select your desired audience and click Apply or click Create New Segment, select your desired audience conditions, and click Save. Expand Enrollment Rules and adjust as desired.

Customers that trigger an event – Expand the Filter drop-down list and select the ODP event that you want to use as the trigger for this data sync to Braze. Expand Automation Rules and adjust as desired.

Expand Touchpoints.

Click to edit Touchpoint 1 and select Braze.

Expand the Targeting section and select the Target Identifier.

Select one of the following options for Add Users To in the Configure section:

Campaign – Add customers to a specific campaign in Braze. After choosing this option, you must select the Braze campaign.

Canvas – Add customers to a specific canvas in Braze. After choosing this option, you must select the Braze canvas.

Profile Update Only – Update only the Braze customer profile.

(Optional) Select the Number of Additional Fields you want to sync to Braze (up to 20). A drop-down list and input field display for the number of additional fields you selected. In each Field # drop-down list, select the Braze field you want to populate. In each corresponding Field # Value, enter the ODP field you want to send to the selected Braze field. For example, if you selected Company Name from the Field # drop-down list, enter for the corresponding Field # Value.

Click Save and then click your activation name in the breadcrumb trail.

Click Select start time and schedule in the Touchpoints section if you selected Customers that match a segment for the enrollment.

. Complete the following settings, then click Apply.

Recurring or Continuous – Select Recurring.

Start Date – Enter the date you want to send the data to Braze.

End – Defaults to Never. If you want to end the Braze data sync on a specific date, set that here.

Repeats – Set to Daily.

Repeat Every – Set to 1 day.

Timing – Enter the time you want to send the data to Braze.

Time Zone – Select the time zone in which you want to send this data.

Click Save and then click Go Live. Your sync starts at your designated start date and time (or when the trigger event occurs).

Troubleshoot the data sync

To ensure data is syncing as expected between ODP and Braze:

Go to Settings > Event Inspector in ODP.

Click Start Inspector. A number displays next to Refresh when data is available in the inspector.

Click Refresh to view the data. The raw data that ODP and Braze send back and forth displays.

Click View Details to see the formatted version of that raw data. Data fields sent from Braze back to ODP start with _braze.

Each data sync is also logged in the ODP activity log:

Go to Settings > Activity Log.

Filter the categories by braze.

Click View Details for a formatted view of the log details, including the number of matches.