Skip to content

Track Events API event forwarding extension

The Braze Track Events API event forwarding extension allows you to leverage data captured in the Adobe Experience Platform Edge Network and send it to Braze in the form of server-side events using the /users/track API.

This document covers the use cases of the extension, how to install it in your event-forwarding libraries, and how to employ its capabilities in an event-forwarding rule.

Use cases

This extension should use data from the Edge Network in Braze to take advantage of its customer analytics and targeting capabilities.

For example, consider a retail organization with a multichannel presence (website and mobile) and capturing transactional or conversational input as event data from their website and mobile platforms.

Using various tag rules, this data is sent to the Edge Network in real-time. From here, the Braze event forwarding extension automatically sends relevant events to Braze from the server side.

Rate limits

API Rate Limits
User Track 50,000 requests per minute.

Refer to the User Track API documentation for details.

Integration

Step 1: Gather required configuration details

To connect the Edge Network to Braze, the following are required:

Key type Description
Braze instance Your Braze instance can be obtained from your Braze onboarding manager or can be found on the API overview page.
Braze REST API key A Braze REST API key with all permissions.

This can be created in the Braze dashboard from Settings > API Keys.

Step 2: Create a secret

Create a new event forwarding secret and set the value to your Braze API key. This will be used to authenticate the connection to your account while keeping the value secure.

Step 3: Install and configure the Braze extension

  1. To install the extension, create an event forwarding property or choose an existing property to edit instead.
  2. Next, select Extensions in the left navigation. In the Catalog tab, select Install on the card for the Braze extension.
  3. On the next screen, input your REST instance and API key and select Save when finished.

Step 4: Create a send event rule

After installing the extension, create a new event forwarding rule and configure its conditions as desired. When configuring the actions for the rule, select the Braze extension, then select Send Event for the action type.

Input Description
External user ID A long, random, and well-distributed UUID or GUID. If you choose a different method to name your user IDs, they must also be long, random, and well-distributed. Learn more about suggested user ID naming convention.
Braze user ID Braze user identifier.
User alias An alias serves as an alternative unique user identifier. Use aliases to identify users along different dimensions than your core user ID.

The user alias object consists of two parts: an alias_name for the identifier itself and an alias_label indicating the type of alias. Users can have multiple aliases with different labels but only one alias_name per alias_label.
Input Description Required
Event name Name of the event. Yes
Event time Date-time as string in ISO 8601 or in yyyy-MM-dd'T'HH:mm:ss:SSSZ format. Yes
App identifier The app identifier or app_id is a parameter associating activity with a specific app in your workspace. It designates which app within the workspace you are interacting with. No
Event Properties A JSON object containing custom properties of the event. No

User attributes can be a JSON object containing fields that will create or update an attribute with the supplied name and value on the specified user profile. The following properties are supported:

User Attribute Description
First Name First name of user.
Last Name Last name of user.
Phone Phone number of user.
Email Email address of user.
Gender One of the following strings: “M”, “F”, “O” (other), “N” (not applicable), “P” (prefer not to say).
City The city of the user.
Country The users country as a string in ISO-3166-1 alpha-2 format.
Language The users language as a string in ISO-639-1 format.
Date of Birth The users data of birth in string in format “YYYY-MM-DD” (for example, 1980-12-21).
Time Zone Time zone name from IANA Time Zone database (for example, ’America/New_York’ or ’Eastern Time (US & Canada)’).
Facebook A hash containing any of id (string), likes (array of strings), num_friends (integer).
Twitter Hash containing any of id (integer), screen_name (string, X (formerly Twitter) handle), followers_count (integer), friends_count (integer), statuses_count(integer).

Step 5: Create a send purchase event rule

After installing the extension, create a new event forwarding rule and configure its conditions as desired. When configuring the actions for the rule, select the Braze extension, then select Send Purchase Event for the action type.

Input Description
External user ID A long, random, and well-distributed UUID or GUID. If you choose a different method to name your user IDs, they must also be long, random, and well-distributed. Learn more about suggested user ID naming convention.
Braze user ID Braze user identifier.
User alias An alias serves as an alternative unique user identifier. Use aliases to identify users along different dimensions than your core user ID.

The user alias object consists of two parts: an alias_name for the identifier itself and an alias_label indicating the type of alias. Users can have multiple aliases with different labels but only one alias_name per alias_label.
Input Description Required
Product ID Identifier for the purchase. (for example, product name or product category) Yes
Purchase time Date-time as a string in ISO 8601 or in yyyy-MM-dd'T'HH:mm:ss:SSSZ format. Yes
Currency Currency as a string in ISO 4217 alphabetic currency code format. Yes
Price The price of the object. Yes
Quantity The quantity purchased. If not provided, the default value will be 1. The maximum value must be lower than 100. No
App identifier The app identifier or app_id is a parameter associating activity with a specific app in your workspace. It designates which app within the workspace you are interacting with. No
Purchase properties A JSON object containing custom properties of the purchase. No

You can choose whether to send attributes with each event within the configuration view.

User attributes can be a JSON object containing fields that will create or update an attribute with the supplied name and value on the specified user profile. The following properties are supported:

User Attribute Description
First name First name of user.
Last name Last name of user.
Phone Phone number of user.
Email Email address of user.
Gender One of the following strings: “M”, “F”, “O” (other), “N” (not applicable), “P” (prefer not to say).
City The city of the user.
Country The users country as a string in ISO-3166-1 alpha-2 format.
Language The users language as a string in ISO-639-1 format.
Date of birth The users data of birth in string in format “YYYY-MM-DD” (for example, 1980-12-21).
Time zone Time zone name from IANA Time Zone database (for example, ’America/New_York’ or ’Eastern Time (US & Canada)’).
Facebook A hash containing any of id (string), likes (array of strings), num_friends (integer).
Twitter Hash containing any of id (integer), screen_name (string, X (formerly Twitter) handle), followers_count (integer), friends_count (integer), statuses_count(integer).

Step 6: Validate data within Braze

If the event collection and Adobe Experience Platform integration were successful, you will see events within the Braze console when viewing user profiles. Specifically, the new event data sent to Braze is reflected in the Purchases or Custom Events section of a particular user’s overview tab.

HOW HELPFUL WAS THIS PAGE?
New Stuff!