Braze Destination

Segment makes it easy to send your data to Braze (and lots of other destinations). Once you've tracked your data through our open source libraries we'll translate and route your data to Braze in the format they understand. Learn more about how to use Braze with Segment.


Supported Sources and Connection Modes

WebMobileServer
📱 Device-based
☁️ Cloud-based

To learn more about about Connection Modes and what dictates which we support, see here.

We offer an optional Cloud-based Connection Mode for Web data with Braze. As a reminder, this removes the Braze javascript library from your site, improving performance. However, there are a few disparities between the Cloud-based and Device-based connection modes to keep in mind brefore enabling it in the Segment app. When you enable the Cloud-based destination mode, here’s what happens:

  • You will no longer be able to use the following Appboy Web features: Push Notifications, Soft Push Prompts, and In-App Messaging.
  • You will no longer be able to use the following Appboy Mobile features: Push Notifications and In-App Messaging.

Segment offers an optional Device-based Connection Mode for Mobile data with Braze. If you’d like to use those features that require client-based functionality, follow the steps above to ensure you have packaged the Braze SDK with Segment’s.

Settings

Segment lets you change these destination settings via your Segment dashboard without having to touch any code.

API Key

The API key found in your Appboy dashboard, used to identify your application as the app identifier.

App Group Identifier

The App Group Identifier can be found in your Appboy dashboard under App Settings > Developer Console

Automatically Send In-App Messages

Web Only: When this is enabled, all In-App Messages that a user is eligible for are automatically delivered to the user. If you’d like to register your own display subscribers or send soft push notifications to your users, make sure to disable this option.

Custom API Endpoint

If you’ve been assigned an API endpoint by the Appboy team specifically for use with their Mobile or Javascript SDKs, please input that here. It should look something like: sdk.api.appboy.eu. Otherwise, leave this blank.

Appboy Datacenter

Choose your Appboy Gateway (ie. US 01, US 02, EU 01, etc.).

Enable HTML In-App Messages

Web only: Enabling this option will allow Appboy dashboard users to write HTML In-App messages. Check out Appboy’s Documentation for more information on this setting.

Custom REST API Endpoint

If you’ve been assigned an API endpoint by the Appboy team specifically for use with their REST API, please input that here. It should look something like: https://rest.api.custom.endpoint. Otherwise, leave this blank.

Safari Website Push ID

Web Only: To send push notifications on Safari, Appboy needs your Website Push Id. To get your Webite Push ID, check out the first two bullet points here.

Track All Pages

This will send all page calls to Appboy as a Loaded/Viewed a Page event. This option is disabled by default since Appboy isn’t generally used for page view tracking.

Track Only Named Pages

This will send only page calls to Appboy that have a name associated with them. For example, page('Signup') would translate to Viewed Signup Page in Appboy.

Update Existing Users Only

Server Side only: A flag to determine whether to update existing users only, defaults to false


If you have any questions or see anywhere we can improve our documentation, please let us know or kick off a conversation in the Segment Community!