Overview

Heap’s 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 

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.

How to send Braze data to Heap

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

Step 1: Collect prerequisite information 

1. Confirm that your Braze account allows you to add Currents
2. Write down your Heap App Id (Account > Manage > Account Settings)
3. Decide if you want to have the “braze-” value appended to the beginning of event and property names in Heap
   1. This appended text will help you more easily identify any data that is synced from your Braze system. You may want to have this so you can better identify the large volume of data being sent by Braze into Heap. Below is an example of what the data may look like when it is added to your Heap instance.
4. Review the values you will use to match users between the two platforms. Decide which Braze user attribute you want to use: external_user_id or user_id
   • Importing events into Heap utilizes the Heap Identity value. This is a requirement that can not be changed. 
   • Braze gives you two user attributes to choose from: external_user_id or user_id. To ensure that your syncs are linking to existing users, one of these Braze attributes is required to match the Heap Identity value for a given user. Determine which of these Braze user attributes corresponds to the values you assign as identities in Heap.

Step 2: Contact your Heap Customer Sucess Manager

Contact your Heap Customer Success Manager and provide them with the prerequisite information from Step 1. If you do not have a Customer Success Manager, email sales@heap.io. From there, we will work with our partner Sureshot to set up your integration.

Step 3: Set Up Braze system current

Once the integration has been initiated, your Customer Success Manager will provide you with a URL that will use to create a new current. 

In your Braze account:

1. Navigate to Integrations > Currents
2. Click the Create New Current button
3. Paste the Endpoint URL that was provided by Heap in the corresponding field

4. Farther down the page, check the Events that you’d like to have sent to Heap

5. Click the Create Current button once you’re done.

You’ll be taken to the Current as listed in the Currents Integration page.  If you ever need to stop the integration, simply click the Stop icon next to the Current that you just enabled.

Data Format

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

• Customer Behavior and Message Engagement events (see Braze's documentation 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: