Braze Source

Braze is a marketing automation and customer engagement platform. Growth, Engagement, and Marketing teams use Braze to build great long term relationships with their customers across key digital channels.

Take your company’s marketing and customer engagement to the next level by adding Braze as a Segment Source, via Braze’s Currents product. We’ll automatically collect marketing and analytics events, forward them to your destinations, and load them into your data warehouse.

In your favorite BI or analytics tool, you’ll be able to analyze your mobile, email, and web marketing campaign data in SQL or through drag-and-drop reports. You’ll be able to join your Braze data with the event data you’re already sending through Segment to analyze the impacts of your marketing and engagement programs.

Getting Started

  1. From your workspace Overview page, click Add Source.
  2. Choose Braze
  3. Give the Source a name. The name will be used to identify this source within your workspace. You can name it however you’d like, but we recommend sticking to something that reflects the Source itself, like Braze.
  4. The next page “Overview” will surface your Segment write key for Braze. Copy this write key.
  5. To finish the setup, you need to activate “Currents” in Braze which requires reaching out to Braze Support or your Customer Support Manager. Braze Currents is only available in select Braze packages and cannot be configured within Braze without assistance from your Braze Customer Success representative.

Now when you go back to Segment, click into your Braze Source and you’ll be able to add Destinations where you want to receive your Braze data. Events will now be sent to your destinations and automatically loaded into any warehouses you have enabled.

Braze Events

Below is a table of events that Braze sends to Segment. These are the events that will appear in your warehouse or your destinations, depending on what connections you enable in Segment:

Event NameDescription
Application UninstalledUser uninstalled the App.
Email SentAn email was successfully sent
Email DeliveredAn email was successfully delivered to a User’s mail server.
Email OpenedUser opened an email.
Email Link ClickedUser clicked a link in an email. Email click tracking must be enabled.
Email BouncedBraze attempted to send an email, but the User’s receiving mail server did not accept it.
Email Soft BouncedBraze attempted to send an email, but the User’s receiving mail server temporarily bounced it. (Reasons may include: inbox full, server down, etc.)
Email Marked As SpamUser marked an email as spam.
Email UnsubscribedUser clicked the unsubscribe link in an email.
Subscription Group State ChangedUser’s subscription group state changed to ‘Subscribed’ or ‘Unsubscribed’
Push Notification SentA push notification was successfully sent
Push Notification TappedUser tapped on a push notification.
Push Notification BouncedBraze was not able to send a push notification to this User.
iOS Foreground Push OpenedUser received a push notification on iOS while the app was open.
In-App Message ViewedUser viewed an in-app message.
In-App Message ClickedUser tapped or clicked a button in an in-app message.
News Feed ViewedUser viewed the native Braze News Feed.
News Feed Card ViewedUser viewed a Card within the native Braze News Feed.
News Feed Card ClickedUser tapped or clicked on a Card within the native Braze News Feed.
Webhook SentA webhook message was sent.
Campaign ConvertedUser performed the primary conversion event for a Campaign within its conversion window.
Canvas ConvertedUser performed the primary conversion event for a Canvas within its conversion window.
Canvas EnteredUser was entered into a Canvas.
Campaign Control Group EnteredUser was enrolled in a Campaign control group.

Braze Event Properties

Below is a table of properties that are sent for the events above:

Property NameTypeDescription
app_idstringThe API Identifier of the App on which a user received a message or performed an action, if applicable.
send_idstringThe id of the message if specified for the campaign, if applicable.
campaign_idstringThe API Identifier of the Campaign associated with the event, if applicable.
canvas_idstringThe API Identifier of the Canvas associated with the event, if applicable.
canvas_variation_idstringThe API Identifier of the Canvas Variation associated with the event, if applicable.
canvas_step_idstringThe API Identifier of the Canvas Step associated with the event, if applicable.
context.traits.emailstringFor Email events, the email address that the email was sent to.
button_idstringFor In-App Message Clicked events, the ID of the button the user clicked on.
card_idstringFor News Feed Card Viewed and News Feed Card Clicked events, the API Identifier of the News Feed Card.

NOTE: The Braze Source is currently in Beta. The names of Apps, Campaigns, Canvases (including Canvas Variations and Canvas Steps), and News Feed Cards will be made available as event properties in an upcoming version of the source, in addition to the API Identifiers already listed above.

User Identification

Braze will send the Braze external_user_id as the top level userId field. This is the same userId that Braze originally receives from the downstream destination with Segment. Braze will only send events associated with users who have an external_user_id set.

Send Segment Data to Braze

The entire source with Braze can be even better if you also connect to it as a downstream destination within Segment. With Segment’s Braze destination, you can send user and event data to Braze in order to target customers with messaging campaigns.

Want to start sending website or mobile data to Braze? Head on over to our Braze destination docs.

Questions? Need help? Contact us!
Can we improve this doc?
Email us:!