Overview

Heap’s bi-directional Braze integration allows you to optimize messaging for Marketers. You can use this integration to:

• Automatically capture interesting moments from Braze as events in Heap 
• Send data into Braze as Cohorts so they can be added to Braze Segments 

With this integration, digital marketers can incorporate the granular user behavioral data available from Heap into marketing campaigns without additional engineering effort. Campaigns can be more effectively personalized to better drive critical product and business outcomes, like activation, trial conversion, and retention.

Setup (Source)

These steps will walk you through setting up the integration of data from Braze to Heap using Braze Currents.

Step 1: Set Up Braze System Current

In Braze, navigate to Integrations > Currents and click the Create New Current button in the top right corner. Paste the Endpoint URL that was provided by Sureshot in the corresponding field. 

Farther down the page, check the Select All Message Engagement Events checkbox, as well as boxes for the Events that you’d like to send to Heap.

Below that section, check the boxes for any Customer Behavior and User Events you’d like to send to Heap.

Click the Create Current button once you’re done. You’ll be taken to the Current as listed in the Currents Integration page.

Step 2: Define Events in Heap for Analysis

If you have active campaigns running in Braze, events should begin flowing into Heap within 5 minutes. To analyze these events in Heap, you need to first define a Heap event for each Braze event you want to analyze.

To do so, from within Heap, navigate to Definitions > New definition and select New event.

Add a name and criteria for your event. For example, if we want to set up a Braze purchase event, you might define the event like this.

Once your definition is set, click the Define event button to save it.

Data Format

Based on the events you selected in step 2, you should expect to see the following Braze events when defining an event in Heap:

• Customer Behavior events (see Braze doc for full list)
• Message Engagement events (see Braze doc for full list)
• Custom Events: the value for the “Name” property in Custom Events will be used as the Event Name in Heap. For example, if the event is defined as “Invite” in Braze:

Then it will be named Invite in Heap.

Setup (Destination) (Braze Data Connector)

Prerequisites

to set up the Heap to Braze integration, please provide the following information to Heap when requesting that we enable the integration.

• Endpoint
• API key
• Cohort Import Key (aka Secret)

Here’s where you can find this information in Braze:

The API Key can be found under Settings > Developer Console.

The proper permissions for this API Key need to be applied. Here is an example of the necessary permissions:

Cohort Import key (aka Secret) and Endpoint can be found under Integrations > Technology Partners > search for Heap.

Once Heap is selected, the Cohort Key (secret) and Endpoint will be displayed. If one does not exist, click the Generate New Key button to create one. (note that this will replace any previous key if one already existed).

Step 1: Enable Braze Destination in Heap

To set this up, navigate to Integrations > Developer Hub and click Create New Integration.

In the Webhook URL, enter the URL that Sureshot has provided. Set OAuth Redirect URL = blank, and provide a value for how users are identified (i.e. email, user ID). Typically, this will be the user ID.

Click Save to confirm your integration setup.

Step 2: Sync Heap Segments to Braze

Now you can toggle on any defined segment to sync into Braze as Cohorts. To do so, navigate to Definitions > Segments, click on any segment, then in the Integrations section, click the toggle next to Braze by Sureshot.

You can choose to Sync Now or set Recurring Sync to continually sync the Segment to Braze.

The segment will begin syncing immediately, and you should see a Cohort in Braze with the same segment name within 2-5 minutes. We only allow you to have 30 segments recurrently syncing to Braze at one time. After the first sync completes, the segment will update every 4 hours.

Once synced to Braze, a Cohort is created in Braze using the same name as the Heap Segment.  All users that belong to the Heap Segment will be added to the Braze Cohort.  If users are removed from the Heap segment due to the Heap segment criteria, they will be removed from the Braze Cohort during the next sync.

Creating Segment in Braze using the new Cohort

Step 1: Create Segment in Braze

In Braze, navigate to Segments and click the Create Segment button. On the page that appears, provide a Segment name and optionally a description.

Step 2: Add the Filter to the segment that uses the new Cohort

To pull up the details for any Segment in Braze, click on it from the Segments page. From the details page, under the Filters section, search for Heap Cohort.

Next, search for a Cohort value. Because the Cohort will be created with the same name as the Heap segment, search for the Heap segment name here.

You can also add any additional filter criteria that you’d like to complete the Braze Segment.  

Frequently Asked Questions

Can you connect more than one Braze project?

At this point, you can only connect one Braze project to one Heap environment. However, we’re open to feedback to improve this integration, so please let us know if you need to connect more than one Braze project to one Heap environment.