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 using 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.

This is an Event Cloud Source which can not only export data into your Segment warehouse, but can also federate the exported data into other enabled Segment Destinations.

This source is maintained by Braze. For any issues with the source, you may contact their team.

This document was last updated on October 03, 2019. If you notice any gaps, outdated information or simply want to leave some feedback to help us improve our documentation, please let us know!

NOTE: If you are interested in using Braze, please reach out to your Braze Customer Success Manager. Braze Currents is only available in select Braze packages and cannot be configured within Braze without assistance from their team.

Getting Started

  1. From the Segment Sources page click Add Source.
  2. Search for “Braze” in the Sources Catalog and confirm by clicking “Connect”.
  3. Give the Source a nickname and follow the setup steps to “Add Source”. The nickname is used as a label for the source in your Segment interface, and Segment creates a related schema name. The schema name is the namespace you’ll query against in a warehouse. The nickname can be anything, but we recommend sticking to something that reflects the source itself and distinguishes amongst your environments (for example, Braze_Prod, Braze_Staging, Braze_Dev).
  4. The next page “Overview” shows the Segment write key for Braze. Copy this write key.
  5. To finish set up, contact Braze Support or your Customer Support Manager to activate “Currents” in Braze. Braze Currents is only available in select Braze packages and cannot be configured within Braze without assistance from your Braze Customer Success representative.
  6. Go back to Segment, click into the Braze Source and you can add Destinations where you want to receive your Braze data. Events are now sent to these destinations and automatically loaded into any warehouses you have enabled.

Components

Stream Braze uses our stream Source component to send events to Segment. These events are then available in any Destination that accepts server-side events, including your data warehouse.

Events

Below is a table of events that Braze sends to Segment. These events show up as tables in your Warehouse, and as regular events in your other Destinations.

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 are tables outlining the properties included in the events listed 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.

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.

Adding Destinations

Now that your Source is set up, you can connect it with Destinations.

Log in to your downstream tools and make sure that the events are populating in your Debugger, and that they contain all of the properties you expect. If something isn’t working as you expect, see the Destination docs for troubleshooting.

If there are problems with how the events arrive to Segment, contact the Braze team.

Sending Data To Braze

The Braze Source works better when you also connect Braze as a Destination. With the Braze Destination, you can use Segment to send event data to Braze in order to target customers with messaging campaigns. Want to start sending data TO Braze? Head on over to our Braze docs.



Questions? Need help? Contact us!
Can we improve this doc?
Email us: docs-feedback@segment.com!