Segment.io for Currents
Segment.io is a customer data platform that helps you collect, clean, and activate your customer data. This reference article will give an overview of the connection between Braze Currents and Segment.io and describe requirements and processes for proper implementation and usage.
The Braze and Segment.io integration allows you to leverage Braze Currents to export your Braze events to Segment.io to drive deeper analytics into conversions, retention, and product usage.
Prerequisites
Requirement | Description |
---|---|
Segment.io account | A Segment.io account is required to take advantage of this partnership. |
Braze destination | You must have already set up Braze as a destination in your Segment.io 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.io, you need to have Braze Currents set up for your account. |
Integration
Step 1: Obtain Segment.io write key
- In your Segment.io dashboard, select your Segment.io source. Next, go to Settings > API keys. Here you will find the Segment.io Write Key.
- In Braze, navigate to Currents > + Create Currents > Create Segment.io Export.
- Next, provide an integration name, contact email, Segment.io write key, and Segment.io region.
It’s important to keep your Segment.io 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.io 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.
Lastly, select Launch Current.
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 workspaces. Because the Braze Segment.io Currents integration cannot isolate events by different apps in a single workspace, failure to do this will lead to unnecessary data deduping and lost data.
To read more, visit Segment.io documentation.
Supported Currents events
Braze supports exporting the following data listed in the Currents user behavior and message engagement event glossaries to Segment.io:
Behaviors
- Uninstall:
users.behaviors.Uninstall
- App (news feed impression)
users.behaviors.app.NewsFeedImpression
- Subscription (global state change):
users.behaviors.subscription.GlobalStateChange
- Subscription group (state change):
users.behaviors.subscriptiongroup.StateChange
Campaigns
- Abort:
users_campaigns_abort
- Conversion:
users.campaigns.Conversion
- EnrollinControl:
users.campaigns.EnrollInControl
Canvas
- Abort:
users_canvas_abort
- Conversion:
users.canvas.Conversion
- Entry:
users.canvas.Entry
- Exit (matched audience, performed event)
users.canvas.exit.MatchedAudience
users.canvas.exit.PerformedEvent
- Experiment Step (conversion, split entry)
users.canvas.experimentstep.Conversion
users.canvas.experimentstep.SplitEntry
Messages
- Content Card (abort, click, dismiss, impression, send)
users.messages.contentcard.Abort
users.messages.contentcard.Click
users.messages.contentcard.Dismiss
users.messages.contentcard.Impression
users.messages.contentcard.Send
- Email (abort, bounce, click, delivery, markasspam, open, send, softbounce, unsubscribe)
users.messages.email.Abort
users.messages.email.Bounce
users.messages.email.Click
users.messages.email.Delivery
users.messages.email.MarkAsSpam
users.messages.email.Open
users.messages.email.Send
users.messages.email.SoftBounce
users.messages.email.Unsubscribe
- In-app message (abort, click, impression)
users.messages.inappmessage.Abort
users.messages.inappmessage.Click
users.messages.inappmessage.Impression
- News Feed card (abort, click, impression)
users.messages.newsfeedcard.Abort
users.messages.newsfeedcard.Click
users.messages.newsfeedcard.Impression
- Push notification (abort, bounce, iOSforeground, open, send)
users.messages.pushnotification.Abort
users.messages.pushnotification.Bounce
users.messages.pushnotification.IosForeground
users.messages.pushnotification.Open
users.messages.pushnotification.Send
- SMS (abort, carrier send, delivery, delivery failure, inbound recieve, rejection, send, short link click)
users.messages.sms.Abort
users.messages.sms.CarrierSend
users.messages.sms.Delivery
users.messages.sms.DeliveryFailure
users.messages.sms.InboundReceive
users.messages.sms.Rejection
users.messages.sms.Send
users.messages.sms.ShortLinkClick
- Webhook (abort, send)
users.messages.webhook.Abort
users.messages.webhook.Send
- WhatsApp (abort, delivery, failure, inbound recieve, read, send)
users.messages.whatsapp.Abort
users.messages.whatsapp.Delivery
users.messages.whatsapp.Failure
users.messages.whatsapp.InboundReceive
users.messages.whatsapp.Read
users.messages.whatsapp.Send