Initial SDK Setup
Installing the Braze SDK will provide you with analytics functionality, as well as push and in-app messages.
Note: As of SDK version 2.1.0, use of the iOS SDK requires XCode 8 or above.
Step 1: Get the SDK
Download the SDK from github and run
cordova plugin add path_to_repo/appboy-cordova-sdk/ from the root your project.
Alternatively, if you are running Cordova 6 or earlier, you could install directly from github, like
cordova plugin add https://github.com/appboy/appboy-cordova-sdk#master.
Configure the plugin
In your config.xml, add a
preference element under the iOS
platform element that contains your Braze API key with the name
<platform name="ios"> <preference name="com.appboy.api_key" value="YOUR_API_KEY" /> ... </platform>
Set up your applications to have the appropriate certificates for push, via the iOS push documentation.
Note: By default we instrument registering for push automatically in this SDK, so push is a 0-touch integration.
Removing automatic push setup (iOS)
If you want to turn off iOS automatic push registration, add the preference
com.appboy.ios_disable_automatic_push_registration with a value of
Initial Setup Complete
Once the initial setup is complete, you can access the