You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
> **Good to know**: This page is about the [Actions-framework](/docs/connections/destinations/actions/) Braze Segment destination. There's also a page about the [non-Actions Braze destination](/docs/connections/destinations/catalog/braze/). Both of these destinations receives data _from_ Segment. There's also the [Braze source](/docs/connections/sources/catalog/cloud-apps/braze//), which sends data _to_ Segment!
20
20
21
-
## Benefits of Braze CloudMode (Actions) vs Braze Classic
21
+
## Benefits of Braze Cloud-Mode (Actions) vs Braze (Classic)
22
22
23
-
Braze Cloud Mode (Actions) provides the following benefit over Braze Classic:
23
+
Braze cloud-mode (Actions) provides the following benefit over Braze (Classic):
24
24
25
-
-**E-commerce mappings**. Segment implementations that don't follow the e-commerce spec due to incompatible event names (for example, Trip Booked vs Order Completed) can use Event Triggers to log purchases in Braze Cloud Mode (Actions).
25
+
-**E-commerce mappings**. Segment implementations that don't follow the e-commerce spec due to incompatible event names (for example, Trip Booked vs Order Completed) can use Event Triggers to log purchases in Braze cloud-mode (Actions).
26
26
27
-
## Getting Started
27
+
## Getting started
28
28
29
-
1. From the Segment web app, click **Catalog**.
30
-
2. Search for "Braze" in the Catalog, select **Braze Cloud Mode (Actions)**, and choose which of your sources to connect the destination to.
31
-
3. Add the following Connection Settings:
29
+
1. From the Segment web app, navigate to **Connections > Catalog**.
30
+
2. Search for "Braze" in the Catalog in the Destinations Catalog and select **Braze**.
31
+
3. Choose which of your sources to connect the destination to and follow the steps to create your destination.
32
+
4. In the **Settings** tab, add the following Connection Settings:
32
33
-**API Key**: Created under Developer Console in the Braze Dashboard.
33
34
-**App ID**: The app identifier used to reference specific Apps in requests made to the Braze API. Created under Developer Console in the Braze Dashboard.
34
35
-**REST Endpoint**: Your Braze REST Endpoint. For more information, see [API Overview](https://www.braze.com/docs/api/basics/){:target="_blank"} in the Braze documentation.
35
36
36
37
> info ""
37
38
> Braze now supports sending `email` as an identifier. Braze requires that you include `userId`, `braze_id`, or `email` for all calls made in cloud-mode. Segment sends a `braze_id` if the `userId` is missing. When you use a device-mode connection, Braze automatically tracks anonymous activity using the `braze_id` if a `userId` is missing.
38
39
39
-
40
40
## Actions v2
41
41
42
-
Segment’s introduced the following v2 Actions to add additional functionality to the Braze Cloud Mode (Actions) destination:
42
+
Segment’s introduced the following v2 Actions to add functionality to the Braze cloud-mode (Actions) destination:
43
43
-[Update User Profile v2](#update-user-profile-v2)
44
44
-[Track Event v2](#track-event-v2)
45
45
-[Identify User v2](#identify-user-v2)
@@ -71,8 +71,10 @@ Keep the following in mind if you plan to move to Braze (Actions) from the class
71
71
72
72
## Troubleshooting
73
73
74
-
### Missing required fields
75
-
Braze requires one of either `external_id`, `user_alias`, or `braze_id` to be present in all events sent. If events are failing to send, please check your event mappings to make sure these fields are resolving to valid values.
74
+
##### Missing required fields
75
+
Braze requires one of either `external_id`, `user_alias`, or `braze_id` to be present in all events sent. If events are failing to send, check your event mappings to make sure these fields are resolving to valid values.
76
+
77
+
#### Missing events
78
+
When an event is sent under an alias, it might appear to be missing if the alias cannot be found in Braze. This might be due to an incorrect search for the alias in Braze.
76
79
77
-
### Missing events
78
-
When an event is sent under an alias, the event may seem to be missing when the alias cannot be found in Braze. This may be due to incorrect search for the alias in Braze. To search for an alias in Braze, use the format "Alias Label:Alias Name". For example, if the "Alias Label" field is set as email and "Alias Name" field is set as email address (for example: "[email protected]"), use "email:test@email.com" to search for the alias in Braze.
80
+
To search for an alias in Braze, use the format `Alias Label:Alias Name`. For example, if the "Alias Label" field is set as email and "Alias Name" field is set as email address, for example: "[email protected]", you should search for the alias using "email:test@email.com".
[Braze](https://www.braze.com/){:target="_blank"}, formerly Appboy, is an engagement platform that empowers growth by helping marketing teams to build customer loyalty through mobile, omni-channel customer experiences.
18
18
19
-
## Benefits of Braze WebMode (Actions) vs Braze Classic
19
+
## Benefits of Braze Web-Mode (Actions) vs Braze (Classic)
20
20
21
-
Braze Web Mode (Actions) provides the following benefits over Braze Classic:
21
+
Braze web-mode (Actions) provides the following benefits over Braze (Classic):
22
22
23
-
-**E-commerce mappings**. Users who can't follow the e-commerce spec due to incompatible event names (for example, Trip Booked vs Order Completed) can log purchases in Braze Web Mode (Actions).
23
+
-**E-commerce mappings**. Users who can't follow the e-commerce spec due to incompatible event names (for example, Trip Booked vs Order Completed) can log purchases in Braze web-mode (Actions).
24
24
25
25
## Getting Started
26
26
27
-
1. From the Segment web app, click **Catalog**.
28
-
2. Search for "Braze" in the Catalog, select **Braze Web Mode (Actions)**, and choose which of your sources to connect the destination to.
29
-
3. Configure the Connection Settings. **API Key** and **SDK Endpoint** are required settings.
27
+
1. From the Segment web app, navigate to **Connections > Catalog**.
28
+
2. Search for "Braze" in the Catalog in the Destinations Catalog and select **Braze**.
29
+
3. Choose which of your sources to connect the destination to and follow the steps to create your destination.
30
+
4. In the **Settings** tab, configure the connection settings. **API Key**, **SDK Endpoint**, and **REST Endpoint** are required settings.
30
31
31
-
After setting up your Braze Web Mode (Action) destination in the Segment app, Segment's Analytics.js library starts asynchronously loading the Braze SDK on your page and sending data. Data appears in the Segment CDN in about 45 minutes.
32
+
After setting up your Braze web-mode (Action) destination in the Segment app, Segment's Analytics.js library starts asynchronously loading the Braze SDK on your page and sending data. Data appears in the Segment CDN in about 45 minutes.
32
33
33
34
> info ""
34
35
> If you're using a device-mode connection, Braze's SDK assigns a `device_id` and a backend identifier, `braze_id`, to every user. This allows Braze to capture anonymous activity from the device by matching on those identifiers instead of `userId`. This applies to _device-mode connections_.
@@ -38,11 +39,11 @@ After setting up your Braze Web Mode (Action) destination in the Segment app, Se
38
39
39
40
## Other features
40
41
41
-
Braze Web Mode (Actions) can use the following features of Braze.
42
+
Braze web-mode (Actions) can use the following features of Braze.
42
43
43
-
### In-app Messaging
44
+
### In-app messaging
44
45
45
-
Once configured, you can trigger in-app message display as a result of several different event types. By default, all In-App Messages that a user is eligible for are automatically delivered to the user upon a session start event. A new session automatically starts when a user loads your site. If you'd like to force a new session for a user, make an Identify call with the corresponding [userId](/docs/connections/spec/identify/#user-id) for that user.
46
+
Once configured, you can trigger in-app message display as a result of several different event types. By default, all In-App Messages that a user is eligible for are automatically delivered to the user upon a session start event. A new session automatically starts when a user loads your site. If you'd like to force a new session for a user, make an [Identify](/docs/connections/spec/identify/) call with the corresponding [userId](/docs/connections/spec/identify/#user-id) for that user.
46
47
47
48
If you don't want your site to display new In-App Messages as they're received, disable automatic display and register your own display subscribers. To do this:
48
49
@@ -66,21 +67,21 @@ The `inAppMessages` parameter will be an array of [`appboy.ab.InAppMessage`](htt
66
67
67
68
68
69
69
-
### Push Notifications
70
+
### Push notifications
70
71
71
-
1. To support push notifications on Chrome, you'll need to enable FCM/GCM as well as configure your site. Check out steps [one and two here for detailed instructions on both](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/initial_sdk_setup#step-1-to-support-chrome-enable-fcmgcm){:target="_blank"}.
72
+
1. To support push notifications on Chrome, you must enable FCM/GCM and configure your site. See steps [one and two in the Braze docs for detailed instructions on both](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/initial_sdk_setup#step-1-to-support-chrome-enable-fcmgcm){:target="_blank"}.
72
73
73
-
2. Browser Registration. In order for a browser to receive push notifications, you must register it for push by calling:
74
+
2.**Browser Registration**: For a browser to receive push notifications, you must register it for push by calling:
74
75
75
76
```js
76
77
analytics.ready(function() {
77
78
window.appboy.registerAppboyPushMessages();
78
79
});
79
80
```
80
81
81
-
**Note:** Place this snippet outside of your [Segment Snippet](/docs/connections/sources/catalog/libraries/website/javascript/quickstart/#step-2-copy-the-segment-snippet) within your `script` tag.
82
+
**Note**: Place this snippet outside of your [Segment Snippet](/docs/connections/sources/catalog/libraries/website/javascript/quickstart/#step-2-copy-the-segment-snippet) within your `script` tag.
82
83
83
-
**Note:** This requests push permission from the user.
84
+
**Note**: This requests push permission from the user.
84
85
85
86
To show your own push-related UI to the user before requesting push permission (known as a soft push prompt), you can test to see if the user's browser supports push by calling:
1.Follow [stepone](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/push_notifications/soft_push_prompt/#step-1-create-a-push-primer-campaign){:target="_blank"} to create a "Prime for Push" in-app messaging Campaign on the Braze dashboard.
112
+
1.Follow [stepone](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/push_notifications/soft_push_prompt/#step-1-create-a-push-primer-campaign){:target="_blank"} detailed in the Braze docs, to create a "Prime for Push" in-app messaging Campaign on the Braze dashboard.
112
113
113
114
2.Addthefollowingsnippettoyoursite:
114
115
@@ -162,24 +163,24 @@ For more details on this snippet, see Braze's [Soft push prompt](https://www.bra
162
163
});
163
164
```
164
165
165
-
### EnableSDKAuthentication
166
+
### EnableSDKauthentication
166
167
167
168
When"Enable SDK Authentication"isenabled, SegmentwillsetBraze's `enableSdkAuthentication` to `true`. When this feature is enabled, the Braze SDK will append the current user’s last known JWT to network requests made to Braze Servers.
168
169
169
170
170
-
## Important differences from the classic Braze destination
171
-
- Braze Web Mode (Actions) supports the Braze [Web](https://github.com/segment-integrations/analytics.js-integration-appboy){:target="_blank"} integration. [Braze CloudMode (Actions)](/docs/connections/destinations/catalog/actions-braze-cloud) supports server and mobile sources, but to use mobile sources in device-mode, use the Braze Classic destination.
171
+
## Important differences from Braze (Classic) destination
172
+
- Braze web-mode (Actions) supports the Braze [Web](https://github.com/segment-integrations/analytics.js-integration-appboy){:target="_blank"} integration. [Braze Cloud-Mode (Actions)](/docs/connections/destinations/catalog/actions-braze-cloud) supports server and mobile sources, but to use mobile sources in device-mode, use the Braze Classic destination.
172
173
173
174
174
-
## Migration from Braze Classic
175
+
## Migration from Braze (Classic)
175
176
176
177
Keep the following in mind if you plan to move to Braze (Actions) from the classic Braze destination.
177
178
{% include components/actions-map-table.html name="braze-web" %}
178
179
179
180
180
-
## FAQ
181
+
## FAQs
181
182
182
-
### How does the Debounce Middleware Action work?
183
+
#### How does the Debounce Middleware Action work?
183
184
184
185
The following [Debounce Middleware](/docs/connections/destinations/catalog/actions-braze-web/#debounce-middleware) logic is executed at the source-level:
0 commit comments