Skip to content

Commit 45ff3db

Browse files
authored
Merge pull request #5182 from segmentio/fix-braze-typo
Braze React Plugin Cleanup
2 parents b3ff2d6 + 6ea42d0 commit 45ff3db

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

src/connections/sources/catalog/libraries/mobile/react-native/destination-plugins/braze-react-native.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ strat: react-native
55

66
[Braze](https://www.braze.com/), formerly Appboy, is an engagement platform that empowers growth by helping marketing teams to build customer loyalty through mobile, omni-channel customer experiences.
77

8-
Braze’s destination plugin code is open source and available on GitHub. You can view it [here.](https://github.com/segmentio/analytics-react-native/tree/master/packages/plugins/plugin-braze).
8+
Braze’s destination plugin code is open source [and available on GitHub](https://github.com/segmentio/analytics-react-native/tree/master/packages/plugins/plugin-braze){:target="_blank"}.
99

1010
## Getting Started
1111

1212
1. From the Segment web app, click **Catalog**.
1313
2. Search for "Braze" in the Catalog, select it, and choose which of your sources to connect the destination to.
1414
3. In the Destination Settings, add the **API Key**, found in the Braze Dashboard in *App Settings > Manage App Group*.
15-
4. Set up a new App Group REST API Key in the Braze Dashboard in *App Settings > Developer Console > API Settings*. For more information, see [Creating and Managing REST API Keys](https://www.braze.com/docs/api/basics/#creating-and-managing-rest-api-keys) in the Braze documentation.
15+
4. Set up a new App Group REST API Key in the Braze Dashboard in *App Settings > Developer Console > API Settings*. For more information, see [Creating and Managing REST API Keys](https://www.braze.com/docs/api/basics/#creating-and-managing-rest-api-keys){:target="_blank"} in the Braze documentation.
1616
- Select the `users.track` endpoint in the **User Data** section.
1717

1818
## Installation
@@ -31,13 +31,13 @@ yarn add @segment/analytics-react-native-plugin-braze @braze/react-native-sdk
3131

3232
Run `pod install` after the installation to autolink the Braze SDK.
3333

34-
See [Braze React SDK](https://github.com/braze-inc/braze-react-native-sdk) for more details of this dependency.
34+
See [Braze React SDK](https://github.com/braze-inc/braze-react-native-sdk){:target="_blank"} for more details of this dependency.
3535

3636
## Using the Plugin in your App
3737

38-
Follow the [instructions for adding plugins](https://github.com/segmentio/analytics-react-native#adding-plugins) on the main Analytics client:
38+
Follow the [instructions for adding plugins](https://github.com/segmentio/analytics-react-native#adding-plugins){:target="_blank"} on the main Analytics client:
3939

40-
In your code where you initialize the analytics client call the `.add(plugin)` method with an `BrazePlugin` instance:
40+
In your code where you initialize the analytics client, call the `.add(plugin)` method with a `BrazePlugin` instance:
4141

4242
```ts
4343
import { createClient } from '@segment/analytics-react-native';
@@ -94,7 +94,7 @@ Pass one of the many identifiers that may exist on an anonymous user profile to
9494

9595
Choose an identifier that is available on the user profile at that point in the user lifecycle.
9696

97-
For example, if you pass device_id to the User by Identifier endpoint:
97+
For example, if you pass `device_id` to the User by Identifier endpoint:
9898

9999
```js
100100
{
@@ -131,12 +131,12 @@ Segment's special traits recognized as Braze's standard user profile fields (in
131131
| `address.country` | `country` |
132132
| `gender` | `gender` |
133133

134-
Segment sends all other traits (except Braze's [reserved user profile fields](https://www.braze.com/docs/api/objects_filters/user_attributes_object/#braze-user-profile-fields)) to Braze as custom attributes. You can send an array of strings as trait values but not nested objects.
134+
Except for Braze's [reserved user profile fields](https://www.braze.com/docs/api/objects_filters/user_attributes_object/#braze-user-profile-fields){:target="_blank"}, Segment sends all other traits to Braze as custom attributes. You can send an array of strings as trait values but not nested objects.
135135

136136
## Track
137137

138138
> info "Tip"
139-
> To lower [Data Point](https://www.braze.com/docs/user_guide/onboarding_with_braze/data_points/) use, limit the events you send to Braze to those that are relevant for campaigns and segmentation to the Braze destination. For more information, see [Schema Controls](/docs/protocols/schema/).
139+
> To lower [Data Point](https://www.braze.com/docs/user_guide/onboarding_with_braze/data_points/){:target="_blank"} use, limit the events you send to Braze to those that are relevant for campaigns and segmentation to the Braze destination. For more information, see [Schema Controls](/docs/protocols/schema/).
140140
141141
If you're not familiar with the Segment Specs, take a look to understand what the [Track method](/docs/connections/spec/track/) does. An example call looks like:
142142

@@ -152,7 +152,7 @@ track('View Product', {
152152
When you `track` an event, Segment sends that event to Braze as a custom event.
153153

154154
> note ""
155-
> Braze requires that you include a `userId` or `braze_id` for all calls made in cloud-mode. Segment sends a `braze_id` if `userId` is missing. When you use a device-mode connection, Braze automatically tracks anonymous activity using the `braze_id` if a `userId` is missing.
155+
> Braze requires that you include a `userId` or `braze_id` for all calls made in cloud mode. Segment sends a `braze_id` if `userId` is missing. When you use a device-mode connection, Braze automatically tracks anonymous activity using the `braze_id` if a `userId` is missing.
156156
157157
> note ""
158158
> Segment removes the following custom properties reserved by Braze:
@@ -185,7 +185,7 @@ The example above would have "Purchased Item" as its `productId` and includes tw
185185
- `revenue`
186186
- `currency`
187187

188-
Braze supports currency codes as specified in [their Purchase Object Specification](https://www.braze.com/docs/api/objects_filters/purchase_object/). Be aware that any currency reported other than USD displays in [the Braze UI in USD based on the exchange rate on the date it was reported](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/analytics/logging_purchases/#logging-purchases).
188+
Braze supports currency codes as specified in [their Purchase Object Specification](https://www.braze.com/docs/api/objects_filters/purchase_object/){:target="_blank"}. Any currency reported other than USD displays in [the Braze UI in USD based on the exchange rate on the date it was reported](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/analytics/logging_purchases/#logging-purchases){:target="_blank"}.
189189

190190
You can add more product details in the form of key-value pairs to the `properties` object. The following reserved keys are not passed to Braze if included in your Track call's `properties` object:
191191

0 commit comments

Comments
 (0)