Carthage Integration

You can integrate the Braze SDK using Carthage by including the following in your Cartfile:

1
github "Appboy/Appboy-iOS-SDK" "<BRAZE_IOS_SDK_VERSION>"

Make sure to replace <BRAZE_IOS_SDK_VERSION> with the latest version of the Braze iOS SDK in “x.y.z” format. Release versions are available here.

For further instructions using Carthage, please refer to their user guide on Github.

Once you’ve synced the Braze SDK release artifacts (we support Carthage via a zip of release artifacts attached to our Github releases), integrate the Appboy_iOS_SDK.framework and SDWebImage.framework into your project. Then, in your Application delegate do:

Add the following line of code to your AppDelegate.m file:

1
#import <Appboy-iOS-SDK/AppboyKit.h>

Within your AppDelegate.m file, add the following snippet within your application:didFinishLaunchingWithOptions method:

1
2
3
[Appboy startWithApiKey:@"YOUR-API-KEY"
         inApplication:application
     withLaunchOptions:launchOptions];

If you are integrating the Braze SDK with CocoaPods or Carthage, add the following line of code to your AppDelegate.swift file:

1
import Appboy_iOS_SDK

For more information about using Objective-C code in Swift projects, please see the Apple Developer Docs.

In AppDelegate.swift, add following snippet to your application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool:

1
Appboy.start(withApiKey: "YOUR-API-KEY", in:application, withLaunchOptions:launchOptions)

Note: Braze’s sharedInstance singleton will be nil before startWithApiKey: is called, as that is a prerequisite to using any Braze functionality.

Dependency-Free Integration

If you want to use SDWebImage in your project along with the Braze SDK, you can install a thin version of the Braze Carthage framework. To do so, include the following lines in your Cartfile:

1
2
binary "https://raw.githubusercontent.com/Appboy/appboy-ios-sdk/master/appboy_ios_sdk.json"
github "rs/SDWebImage"

Core Only Integration

If you want to use the Core SDK without any UI components, you can install the core version of the Braze Carthage framework by including the following line in your Cartfile:

1
2
binary "https://raw.githubusercontent.com/Appboy/appboy-ios-sdk/master/appboy_ios_sdk_core.json"

Specifying Your Custom Endpoint or Data Cluster

Your Braze representative should have already advised you of the correct endpoint.

If given a pre-existing custom endpoint…

  • Starting with Braze iOS SDK v3.0.2, you can set a custom endpoint using the Info.plist file. Add the Appboy dictionary to your Info.plist file. Inside the Appboy dictionary, add the Endpoint string subentry and set the value to your custom endpoint URLs authority (for example, sdk.iad-01.braze.com, not https://sdk.iad-01.braze.com).

Runtime Endpoint Configuration

If given a pre-existing custom endpoint…

  • Starting with Braze iOS SDK v3.17.0+, you can override set your endpoint via the ABKEndpointKey inside the appboyOptions parameter passed to startWithApiKey:inApplication:withLaunchOptions:withAppboyOptions:. Set the value to your custom endpoint URLs authority (for example, sdk.iad-01.braze.com, not https://sdk.iad-01.braze.com).

Implementation Example

See the AppDelegate.m file in the Stopwatch sample app.

WAS THIS PAGE HELPFUL?
New Stuff!