https://github.com/braze-inc/braze-cordova-sdk
Public repo for the Braze Cordova SDK
https://github.com/braze-inc/braze-cordova-sdk
android braze cordova ios javascript marketing-automation sdk
Last synced: 3 months ago
JSON representation
Public repo for the Braze Cordova SDK
- Host: GitHub
- URL: https://github.com/braze-inc/braze-cordova-sdk
- Owner: braze-inc
- License: other
- Created: 2016-02-05T22:12:27.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2025-05-28T20:12:00.000Z (5 months ago)
- Last Synced: 2025-07-02T15:16:18.978Z (3 months ago)
- Topics: android, braze, cordova, ios, javascript, marketing-automation, sdk
- Language: Kotlin
- Homepage: https://www.braze.com
- Size: 120 MB
- Stars: 23
- Watchers: 50
- Forks: 66
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Braze Cordova SDK
Effective marketing automation is an essential part of successfully scaling and managing your business. Braze empowers you to build better customer relationships through a seamless, multi-channel approach that addresses all aspects of the user life cycle. Braze helps you engage your users on an ongoing basis. View the following resources for details and we'll have you up and running in no time!
See our instructions for [Integrating the Braze Cordova SDK](https://www.braze.com/docs/developer_guide/platforms/cordova/sdk_integration) into your Cordova app.
## Minimum version requirements
| Braze Plugin | Cordova Android | Cordova iOS |
| ------------ | --------------- | ----------- |
| 10.0.0+ | >= 13.0.0 | >= 5.0.0 |
| 2.31.0+ | >= 12.0.0 | >= 5.0.0 |
This SDK additionally inherits the requirements of its underlying Braze native SDKs. Be sure to also adhere to the lists below:
* [Android SDK requirements](https://github.com/braze-inc/braze-android-sdk?tab=readme-ov-file#version-information)
* [Swift SDK requirements](https://github.com/braze-inc/braze-swift-sdk?tab=readme-ov-file#version-information)
## Installing the SDK
#### ⚠ Only add the Braze Cordova SDK using the methods below. Do not attempt to install using other methods as it could lead to a security breach. ⚠
```
# To use the base SDK functionality, install using the `master` branch.
cordova plugin add https://github.com/braze-inc/braze-cordova-sdk#master
# To use location collection and geofences in addition to the base SDK functionality, install using `geofence-branch`.
cordova plugin add https://github.com/braze-inc/braze-cordova-sdk#geofence-branch
```
## Running the sample application
```
cordova plugin remove cordova-plugin-braze
cordova plugin add https://github.com/braze-inc/braze-cordova-sdk#master
# To run android
cordova run android
# To run iOS
cordova run ios
```