@segment/analytics-react-native-plugin-braze

DestinationPlugin for Braze. Wraps @braze/react-native-sdk. This Plugin should be used with a Device Mode connection to Braze. To connect to Braze with a Cloud Mode connection use the Braze Middleware Plugininstead. It is not possible to use both plugins in one Analytics React Native instance.

Installation

You need to install the @segment/analytics-react-native-plugin-braze and the @braze/react-native-sdk dependency.

Using NPM:

npm install --save @segment/analytics-react-native-plugin-braze @braze/react-native-sdk

Using Yarn:

yarn add @segment/analytics-react-native-plugin-braze @braze/react-native-sdk

Run pod install after the installation to autolink the Braze SDK.

See Braze React SDK for more details of this dependency.

Usage

Follow the instructions for adding plugins on the main Analytics client:

In your code where you initialize the analytics client call the .add(plugin) method with an BrazePlugin instance:

import { createClient } from '@segment/analytics-react-native';

import { BrazePlugin } from '@segment/analytics-react-native-plugin-braze';

const segmentClient = createClient({
  writeKey: 'SEGMENT_KEY'
});

segmentClient.add({ plugin: new BrazePlugin() });

Support

Please use Github issues, Pull Requests, or feel free to reach out to our support team.

Integrating with Segment

Interested in integrating your service with us? Check out our Partners page for more details.

License

MIT License

Copyright (c) 2021 Segment

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.