Segment makes it easy to send your data to Braze-IBM (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-IBM in the format they understand. Learn more about how to use Braze-IBM with Segment.
For user-property destinations, an identify call will be sent to the destination for each user being added and removed. The property name will be the snake_cased version of the audience name you provide with a true/false value. For example, when a user first completes an order in the last 30 days, we will send an identify call with the property
order_completed_last_30days: true, and when this user no longer satisfies we will set that value to
When the audience is first created an identify call is sent for every user in the audience. Subsequent syncs will only send updates for those users which were added or removed since the last sync.
Supported Sources and Connection Modes
To learn more about about Connection Modes and what dictates which we support, see here.
- 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-IBM. If you’d like to use those features that require client-based functionality, follow the steps above to ensure you have packaged the Braze-IBM SDK with Segment’s.
Segment lets you change these destination settings via your Segment dashboard without having to touch any code.
Allow Crawler Activity
Web Only: By default, the Braze Web SDK ignores activity from known spiders or web crawlers, such as Google, based on the user agent string. This saves datapoints, makes analytics more accurate, and may improve page rank. However, if you want Braze to log activity from these crawlers instead, you may set this option to true.
The API key found in your Braze dashboard, used to identify your application as the app identifier. (Formerly ‘API Key’)
REST API Key
This can be found in your Braze dashboard under App Settings > Developer Console. (Formerly ‘App Group Identifier’)
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
Choose your Appboy Gateway (ie. US 01, US 02, EU 01, etc.).
Do Not Load Font Awesome
Web Only: Braze uses FontAwesome for in-app message icons. By default, Braze will automatically load FontAwesome from https://maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css. To disable this behavior (e.g. because your site uses a customized version of FontAwesome), set this option to true. Note that if you do this, you are responsible for ensuring that FontAwesome is loaded on your site - otherwise in-app messages may not render correctly. This setting is only applicable if you are using version 2 of the Braze Web SDK.
Enable HTML In-App Messages
Web only: Enabling this option will allow Braze dashboard users to write HTML In-App messages. Check out Braze Documentation for more information on this setting. This setting is only applicable if you are using version 2 of the Braze Web SDK.
Minimum Interval Between Trigger Actions In Seconds
Web Only: By default, a trigger action will only fire if at least 30 seconds have elapsed since the last trigger action. Provide a value for this configuration option to override that default with a value of your own. We do not recommend making this value any smaller than 10 to avoid spamming the user with notifications. This setting is only applicable if you are using version 2 of the Braze Web SDK.
Open In-App Messages In New Tab
By default, links from in-app message clicks load in the current tab or a new tab as specified in the dashboard on a message-by-message basis. Set this option to true to force all links from in-app message clicks open in a new tab or window. This setting is only applicable if you are using version 2 of the Braze Web SDK.
Open News Feed Cards In New Tab
By default, links from news feed cards load in the current tab or window. Set this option to true to make links from news feed cards open in a new tab or window. This setting is only applicable if you are using version 2 of the Braze Web SDK.
Custom REST API Endpoint
If you’ve been assigned an API endpoint by the Braze team specifically for use with their REST API, please input that here. It should look something like “https://foo.bar.braze.com“. Otherwise, leave this blank.
Safari Website Push ID
Web Only: To send push notifications on Safari, Braze needs your Website Push Id. To get your Webite Push ID, check out the first two bullet points here.
Session Timeout In Seconds
Web Only: By default, sessions time out after 30 minutes of inactivity. Provide a value for this configuration option to override that default with a value of your own. This setting is only applicable if you are using version 2 of the Braze Web SDK.
Track All Pages
This will send all
page calls to Braze as a Loaded/Viewed a Page event. This option is disabled by default since Braze isn’t generally used for page view tracking.
Track Only Named Pages
This will send only
page calls to Braze that have a
name associated with them. For example,
page('Signup') would translate to Viewed Signup Page in Braze.
Update Existing Users Only
Server Side only: A flag to determine whether to update existing users only, defaults to false
Braze Web SDK Version
Web Only: The major version of the Braze web SDK you would like to use. Please reference their changelog for more info. Please ensure you read this section of our documentation carefully before changing this setting.
If you have any questions, or see anywhere we can improve our documentation, please let us know!