Segment for Currents

Segment is a customer data platform that helps you collect, clean, and activate your customer data. This article will give an overview of the connection between Braze Currents and Segment and describe requirements and processes for proper implementation and usage.

The Braze and Segment integration allows you to leverage Braze Currents to export your Braze events to Segment to drive deeper analytics into conversions, retention, and product usage.

Prerequisites

Requirement	Description
Segment account	A Segment account is required to take advantage of this partnership.
Braze destination	You must have already set up Braze as a destination in your Segment integration. This includes providing the correct Braze data center and REST API key in your connection settings.
Currents	In order to export data back into Segment, you need to have Braze Currents set up for your account.

Integration

Step 1: Obtain Segment write key

In your Segment dashboard, select your Segment source. Next, go to Settings > API keys. Here you will find the Segment Write Key.
In Braze, navigate to Currents > + Create Currents > Create Segment Export.
Next, provide an integration name, contact email, and Segment write key.

The Segment Currents page in Braze. Here, you can find fields for integration name, contact email, and API key.

warning:

It’s important to keep your Segment write key up to date. If your connector’s credentials expire, the connector will stop sending events. If this persists for more than 48 hours, the connector’s events will be dropped, and data will be permanently lost.

Step 2: Export message engagement events

Next, select the message engagement events you would like to export. Reference the following export events and properties table listed. All events sent to Segment will include the user’s external_user_id as the userId. At this time, Braze does not send event data for users who do not have their external_user_id set.

List of all available message engagement events on the Segment Currents page in Braze.

Lastly, select Launch Current.

warning:

If you intend to create more than one of the same Currents connectors (for example, two message engagement event connectors), they must be in different app groups. Because the Braze Segment Currents integration cannot isolate events by different apps in a single app group, failure to do this will lead to unnecessary data deduping and lost data.

To read more, visit Segments documentation.

You can export the following data from Braze to Segment:

Event name	Description
Push Notification Sent	A push notification was successfully sent.
Push Notification Tapped	User opened a push notification.
Push Notification Bounced	Braze was not able to send a push notification to this User.
iOS Foreground Push Opened	User received a push notification on iOS while the app was open.
Email Sent	An email was successfully sent.
Email Delivered	An email was successfully delivered to a User’s mail server.
Email Opened	User opened an email.
Email Link Clicked	User clicked a link in an email. Email click tracking must be enabled.
Email Bounced	Braze attempted to send an email, but the User’s receiving mail server did not accept it.
Email Soft Bounced	Braze attempted to send an email, but the User’s receiving mail server temporarily bounced it. (Reasons may include a full inbox or a downed server, among other things.)
Email Marked As Spam	User marked an email as spam.
Email Unsubscribed	User clicked the unsubscribe link in an email.
SMS Sent	An SMS was sent.
SMS Sent to Carrier	An SMS was sent to the Carrier for delivery.
SMS Delivered	An SMS was delivered successfully.
SMS Delivery Failed	An SMS was unable to be delivered successfully.
SMS Rejected	An SMS was rejected.
SMS Inbound Received	An inbound SMS was received.
Subscription Group State Changed	User’s subscription group state changed to ‘Subscribed’ or ‘Unsubscribed’.
In-App Message Viewed	User viewed an In-App Message.
In-App Message Clicked	User tapped or clicked a button in an In-App Message.
Content Card Sent	A Content Card was sent to a user’s device.
Content Card Viewed	User viewed a Content Card.
Content Card Clicked	User clicked a Content Card.
Content Card Dismissed	User dismissed a Content Card.
News Feed Viewed	User viewed the native Braze News Feed.
News Feed Card Viewed	User viewed a Card within the native Braze News Feed.
News Feed Card Clicked	User clicked on a Card within the native Braze News Feed.
Webhook Sent	A webhook message was sent.
Campaign Converted	User performed a conversion event for a campaign within its conversion window.
Canvas Converted	User performed a conversion event for a Canvas within its conversion window.
Canvas Entered	User was entered into a Canvas.
Campaign Control Group Entered	User was enrolled in a campaign control group.
Application Uninstalled	User uninstalled the App.

The following properties will be included with all Braze Events sent to Segment:

Property Name	Type	Description
`app_id`	`String`	The API Identifier of the App on which a user received a message or performed an action, if applicable.
`send_id`	`String`	The id of the message if specified for the campaign, if applicable.
`dispatch_id`	`String`	The id of the message dispatch (unique id for each ‘transmission’ sent from the Braze platform). Users who are sent a schedule message get the same dispatch_id. Action-based or API-triggered messages get a unique dispatch_id per user.
`campaign_id`	`String`	The API Identifier of the campaign associated with the event, if applicable.
`campaign_name`	`String`	The name of the campaign associated with the event, if applicable.
`message_variation_id`	`String`	The API Identifier of the Message Variation for the campaign associated with the event, if applicable.
`canvas_id`	`String`	The API Identifier of the Canvas associated with the event, if applicable.
`canvas_name`	`String`	The name of the Canvas associated with the event, if applicable.
`canvas_variation_id`	`String`	The API Identifier of the Canvas Variation associated with the event, if applicable.
`canvas_step_id`	`String`	The API Identifier of the Canvas Step associated with the event, if applicable.

The following properties will be included with specific Braze events sent to Segment:

Property Name	Type	Description
`in_control_group`	`String`	For Canvas Entered events, whether or not the user was enrolled in the control group - always either `true` or `false`
`context.traits.email`	`String`	For Email events, the email address that the email was sent to.
`link_url`	`String`	For Email Clicked events, the URL of the link that the user clicked on.
`button_id`	`String`	For In-App Message Clicked events, the index of the button the user clicked on.
`card_id`	`String`	For News Feed Card and Content Card events, the API Identifier of the Card.
`subscription_group_id`	`String`	For Subscription Group State Changed events, the API Identifier of the Subscription Group.
`subscription_status`	`String`	For Subscription Group State Changed events, the status the user changed to, either `Subscribed` or `Unsubscribed`.
`user_agent`	`String`	For Email Click and Email Open events, description of the user’s system and browser for the event.
`link_id`	`String`	For Email Click events, Unique value generated by Braze for the URL. Null unless Link Aliasing is enabled.
`link_alias`	`String`	For Email Click events, alias name set when the message was sent. Null unless Link Aliasing is enabled.
`machine_open`	`String`	For Email Open events, indicator of whether the email was opened by an automated process, such as Apple or Google mail pre-fetching. Currently `true` or null, but additional granularity (e.g., “Apple” or “Google” to indicate which process made the fetch) may be added in the future.