Data Subject Request API Version 1 and 2
Data Subject Request API Version 3
Platform API Overview
Accounts
Apps
Audiences
Calculated Attributes
Data Points
Feeds
Field Transformations
Services
Users
Workspaces
Warehouse Sync API Overview
Warehouse Sync API Tutorial
Warehouse Sync API Reference
Data Mapping
Warehouse Sync SQL Reference
Warehouse Sync Troubleshooting Guide
ComposeID
Warehouse Sync API v2 Migration
Bulk Profile Deletion API Reference
Custom Access Roles API
Data Planning API
Group Identity API Reference
Calculated Attributes Seeding API
Pixel Service
Profile API
Events API
mParticle JSON Schema Reference
IDSync
AMP SDK
Initialization
Configuration
Network Security Configuration
Event Tracking
User Attributes
IDSync
Screen Events
Commerce Events
Location Tracking
Media
Kits
Application State and Session Management
Data Privacy Controls
Error Tracking
Opt Out
Push Notifications
WebView Integration
Logger
Preventing Blocked HTTP Traffic with CNAME
Linting Data Plans
Troubleshooting the Android SDK
API Reference
Upgrade to Version 5
Direct URL Routing FAQ
Web
Android
iOS
Initialization
Configuration
Event Tracking
User Attributes
IDSync
Screen Tracking
Commerce Events
Location Tracking
Media
Kits
Application State and Session Management
Data Privacy Controls
Error Tracking
Opt Out
Push Notifications
Webview Integration
Upload Frequency
App Extensions
Preventing Blocked HTTP Traffic with CNAME
Linting Data Plans
Troubleshooting iOS SDK
Social Networks
iOS 14 Guide
iOS 15 FAQ
iOS 16 FAQ
iOS 17 FAQ
iOS 18 FAQ
API Reference
Upgrade to Version 7
Getting Started
Identity
Upload Frequency
Getting Started
Opt Out
Initialize the SDK
Event Tracking
Commerce Tracking
Error Tracking
Screen Tracking
Identity
Location Tracking
Session Management
Initialization
Configuration
Content Security Policy
Event Tracking
User Attributes
IDSync
Page View Tracking
Commerce Events
Location Tracking
Media
Kits
Application State and Session Management
Data Privacy Controls
Error Tracking
Opt Out
Custom Logger
Persistence
Native Web Views
Self-Hosting
Multiple Instances
Web SDK via Google Tag Manager
Preventing Blocked HTTP Traffic with CNAME
Facebook Instant Articles
Troubleshooting the Web SDK
Browser Compatibility
Linting Data Plans
API Reference
Upgrade to Version 2 of the SDK
Getting Started
Identity
Cordova Plugin
Identity
Web
Alexa
Overview
Step 1. Create an input
Step 2. Verify your input
Step 3. Set up your output
Step 4. Create a connection
Step 5. Verify your connection
Step 6. Track events
Step 7. Track user data
Step 8. Create a data plan
Step 9. Test your local app
Overview
Step 1. Create an input
Step 2. Verify your input
Step 3. Set up your output
Step 4. Create a connection
Step 5. Verify your connection
Step 6. Track events
Step 7. Track user data
Step 8. Create a data plan
Overview
Step 1. Create an input
Step 2. Verify your input
Step 3. Set up your output
Step 4. Create a connection
Step 5. Verify your connection
Step 6. Track events
Step 7. Track user data
Step 8. Create a data plan
Step 1. Create an input
Step 2. Create an output
Step 3. Verify output
Node SDK
Go SDK
Python SDK
Ruby SDK
Java SDK
Introduction
Outbound Integrations
Firehose Java SDK
Inbound Integrations
Compose ID
Data Hosting Locations
Glossary
Rules Developer Guide
API Credential Management
The Developer's Guided Journey to mParticle
Create an Input
Start capturing data
Connect an Event Output
Create an Audience
Connect an Audience Output
Transform and Enhance Your Data
The new mParticle Experience
The Overview Map
Introduction
Data Retention
Connections
Activity
Live Stream
Data Filter
Rules
Tiered Events
mParticle Users and Roles
Analytics Free Trial
Troubleshooting mParticle
Usage metering for value-based pricing (VBP)
Introduction
Sync and Activate Analytics User Segments in mParticle
User Segment Activation
Welcome Page Announcements
Project Settings
Roles and Teammates
Organization Settings
Global Project Filters
Portfolio Analytics
Analytics Data Manager Overview
Events
Event Properties
User Properties
Revenue Mapping
Export Data
UTM Guide
Data Dictionary
Query Builder Overview
Modify Filters With And/Or Clauses
Query-time Sampling
Query Notes
Filter Where Clauses
Event vs. User Properties
Group By Clauses
Annotations
Cross-tool Compatibility
Apply All for Filter Where Clauses
Date Range and Time Settings Overview
Understanding the Screen View Event
Analyses Introduction
Getting Started
Visualization Options
For Clauses
Date Range and Time Settings
Calculator
Numerical Settings
Assisted Analysis
Properties Explorer
Frequency in Segmentation
Trends in Segmentation
Did [not] Perform Clauses
Cumulative vs. Non-Cumulative Analysis in Segmentation
Total Count of vs. Users Who Performed
Save Your Segmentation Analysis
Export Results in Segmentation
Explore Users from Segmentation
Getting Started with Funnels
Group By Settings
Conversion Window
Tracking Properties
Date Range and Time Settings
Visualization Options
Interpreting a Funnel Analysis
Group By
Filters
Conversion over Time
Conversion Order
Trends
Funnel Direction
Multi-path Funnels
Analyze as Cohort from Funnel
Save a Funnel Analysis
Export Results from a Funnel
Explore Users from a Funnel
Saved Analyses
Manage Analyses in Dashboards
Dashboards––Getting Started
Manage Dashboards
Organize Dashboards
Dashboard Filters
Scheduled Reports
Favorites
Time and Interval Settings in Dashboards
Query Notes in Dashboards
User Aliasing
The Demo Environment
Keyboard Shortcuts
Analytics for Marketers
Analytics for Product Managers
Compare Conversion Across Acquisition Sources
Analyze Product Feature Usage
Identify Points of User Friction
Time-based Subscription Analysis
Dashboard Tips and Tricks
Understand Product Stickiness
Optimize User Flow with A/B Testing
User Segments
IDSync Overview
Use Cases for IDSync
Components of IDSync
Store and Organize User Data
Identify Users
Default IDSync Configuration
Profile Conversion Strategy
Profile Link Strategy
Profile Isolation Strategy
Best Match Strategy
Aliasing
Overview
Create and Manage Group Definitions
Introduction
Catalog
Live Stream
Data Plans
Blocked Data Backfill Guide
Predictive Attributes Overview
Create Predictive Attributes
Assess and Troubleshoot Predictions
Use Predictive Attributes in Campaigns
Predictive Audiences Overview
Using Predictive Audiences
Introduction
Profiles
Warehouse Sync
Data Privacy Controls
Data Subject Requests
Default Service Limits
Feeds
Cross-Account Audience Sharing
Approved Sub-Processors
Import Data with CSV Files
CSV File Reference
Glossary
Video Index
Single Sign-On (SSO)
Setup Examples
Introduction
Introduction
Introduction
Rudderstack
Google Tag Manager
Segment
Advanced Data Warehouse Settings
AWS Kinesis (Snowplow)
AWS Redshift (Define Your Own Schema)
AWS S3 Integration (Define Your Own Schema)
AWS S3 (Snowplow Schema)
BigQuery (Snowplow Schema)
BigQuery Firebase Schema
BigQuery (Define Your Own Schema)
GCP BigQuery Export
Snowflake (Snowplow Schema)
Snowplow Schema Overview
Snowflake (Define Your Own Schema)
Aliasing
Event
Audience
Event
Audience
Feed
Event
Audience
Cookie Sync
Event
Audience
Audience
Audience
Feed
Event
Event
Event
Audience
Event
Data Warehouse
Event
Event
Event
Event
Audience
Event
Event
Event
Feed
Event
Event
Event
Audience
Event
Event
Feed
Event
Event
Feed
Audience
Event
Event
Custom Feed
Event
Event
Event
Audience
Audience
Audience
Event
Audience
Event
Event
Event
Event
Event
Audience
Audience
Event
Event
Audience
Data Warehouse
Event
Audience
Cookie Sync
Event
Event
Event
Event
Event
Feed
Feed
Event
Event
Audience
Event
Event
Event
Audience
Event
Event
Event
Feed
Audience
Event
Audience
Event
Event
Audience
Audience
Audience
Audience
Event
Audience
Event
Event
Event
Event
Feed
Event
Event
Event
Event
Event
Feed
Audience
Event
Event
Event
Event
Event
Event
Feed
Audience
Event
Event
Custom Pixel
Feed
Event
Event
Event
Event
Event
Audience
Event
Event
Data Warehouse
Event
Event
Audience
Audience
Audience
Event
Audience
Event
Audience
Cookie Sync
Audience
Feed
Event
Audience
Audience
Event
Audience
Event
Event
Event
Cookie Sync
Audience
Audience
Cookie Sync
Feed
Audience
Event
Event
Event
Braze is a comprehensive customer engagement platform that powers relevant experiences between consumers and brands they love. Braze helps brands foster human connection through interactive conversations across channels.
mParticle audiences correspond to Braze’s Segments feature and can be used to target engagement campaigns in Braze.
In order to activate our Braze integration, you’re going to need the API key for each app that you’d like to set up, which can be found by logging into your Braze account and navigating to your app’s settings. You will also need to create an App Group REST API Key in the Developer Console.
Braze maintains several instances. As part of the Configuration Settings, you need to specify which one your data should be forwarded to. You can tell your Braze Instance from the URL of your Braze Dashboard.
Instance | Dashboard URL |
---|---|
US 01 Cluster | https://dashboard-01.braze.com |
US 02 Cluster | https://dashboard-02.braze.com |
US 03 Cluster | https://dashboard-03.braze.com |
US 04 Cluster | https://dashboard-04.braze.com |
US 05 Cluster | https://dashboard-05.braze.com |
US 06 Cluster | https://dashboard-06.braze.com |
US 08 Cluster | https://dashboard-08.braze.com |
EU 01 Cluster | https://dashboard-01.braze.eu |
EU 02 Cluster | https://dashboard-02.braze.eu |
Check with your Braze account manager if you are unsure which Braze instance you are using.
There is also the ability to specify a Custom instance, which allows you to specify separate endpoints for REST, SDK and Javascript.
mParticle will attempt to match users in Braze based on IDFAs, Android Device IDs, and a customizable External User ID field, which uniquely identifies a user in Braze. You can set which Identity Type to use as the External User ID in the Configuration Settings. Your External User ID should be a unique, permanent identifier — usually Customer ID or Email. If you are also using the Event integration, make sure you set the same External User ID across both integrations.
The Braze API does not allow mParticle to directly create and maintain membership of segments in Braze, so the Audience integration works by setting attributes on a user, which you can then use to define a corresponding segment in Braze. Like mParticle, Braze populates it’s Segment Manager based on the actual data points received, so you need to create audiences in mParticle and connect them to Braze first. Then, provided your audience is not empty, the segment membership attributes should become available in the Braze Segment Manager within a few minutes.
mParticle offers seven ways to set segment membership attributes, controlled by the Send Segments As
Configuration Setting. The drop-down has the following options:
These options will be explained in further detail below.
Note that Audience IDs can be found in the main Audience list view.
For example, note the Audience IDs for these three audiences:
This is the default behavior. mParticle creates a single custom attribute in Braze for each user, called SegmentMembership
. The value of this attribute is a comma-separated string of mParticle audience IDs that match the user.
Using the above examples, a user who is a member of Test Audience 1
, Test Audience 2
, and Test Audience 3
will show the attribute SegmentMembership
with a value of "'13053','13052', '13051'"
in Braze.
See the Sample Braze Profile
for an example.
To target members of Test Audience 1
, for example, you need to create a matching segment in Braze using the mParticle Audience ID,
with the filter SegmentMembership
— matches regex
— 13051
. It’s important to choose the matches regex
option, and not equals
, or users with membership in more than one audience will not be matched.
mParticle creates a single custom array attribute in Braze for each user, called SegmentMembershipArray
. The value of this attribute is an array of mParticle audience IDs that match the user.
Using the above examples, a user who is a member of Test Audience 1
, Test Audience 2
, and Test Audience 3
will show the attribute SegmentMembershipArray
with a value of ["13053","13052", "13051"]
in Braze. Note, however, that Braze parses array attributes to make them more readable.
See the Sample Braze Profile
for an example.
To target members of Test Audience 1
, for example, you need to create a matching segment in Braze with the filter SegmentMembershipArray
— includes value
— 13051
mParticle creates a custom attribute in Braze for each audience that a user belongs to, based on the External Name of the audience.
Using the above examples, a user who is a member of audience Test Audience 1
will show the attribute In Test Audience 1
is true
in Braze.
To target members of Test Audience 1
, for example, you need to create a matching segment in Braze with the filter In Test Audience 1
— equals
— true
.
mParticle will send attributes as described by both Single Array Attribute
and Single String Attribute
.
mParticle will send attributes as described by both Single Array Attribute
and One Attribute Per Segment
.
mParticle will send attributes as described by both Single String Attribute
and One Attribute Per Segment
.
mParticle will send attributes as described by Single Array Attribute
, Single String Attribute
and One Attribute Per Segment
.
Here is a sample Braze profile with all options enabled.
Since mParticle does not directly maintain segments in Braze, it will not delete segments when the corresponding mParticle audience connection is deleted or deactivated. When this happens, mParticle will not update the audience user attributes in Braze to remove the audience from each user.
Deleting an audience does not remove the custom attributes in Braze.
Setting Name | Data Type | Default Value | Description |
---|---|---|---|
API Key | string |
Your app’s API Key can be found in your Braze dashboard. | |
API Key Operating System | enum |
Unselected | Select which operating system your Braze API key corresponds to. This selection will limit the types of push tokens that will be forwarded on an audience update. |
Send Segments As | enum |
Single String Attribute | The method of sending audiences to Braze. Audience membership can be uploaded as a custom attribute containing comma-separated audience IDs, a custom array attribute containing audience IDs, and / or one attribute per audience with a boolean value to indicate membership. Warning: If multiple configurations use the same credentials and cluster, options involving single attributes may cause values to be overwritten on Braze’s end. |
App Group REST API Key | string |
The App Group REST API Key can be found in the developer console section of the Braze dashboard. | |
External Identity Type | enum |
Customer ID | The mParticle User Identity type to forward as an External ID to Braze. |
Email Identity Type | enum |
The mParticle User Identity Type to forward as the Email to Braze. | |
Braze Instance | enum |
US 03 Cluster | Specify which cluster your Braze data will be forwarded to. Please ensure you are contractually authorized to use the EU cluster if you select that option. If you choose ‘Custom’, you will need to provide separate endpoints for your SDK, Server, and Web data. |
Forward Push Tokens | bool |
True | If enabled, mParticle will forward user Push Tokens to Braze. |