Android SDK

Successful marketing automation is essential to the future of your mobile app. Braze helps you engage your users beyond the download. Visit the following links for details and we'll have you up and running in no time!

• Braze User Guide
• Braze Developer Guide
• KDoc

Version Information

• The Braze Android SDK supports Android 7.1.1+ / API 25+ (Nougat and up).
  • ⚠️ As of September 30, 2024, Let's Encrypt discontinued support for cross-signed certificates. Users who do not upgrade to Android 7.1.1 or higher may experience issues accessing sites secured by Let's Encrypt certificates. Full certificate compatibility here.
• Last Target SDK Version: 35
• Kotlin version: org.jetbrains.kotlin:kotlin-stdlib:2.0.20
• Last Compiled Firebase Cloud Messaging Version: 24.1.0
• Braze uses Font Awesome 4.3.0 for in-app message icons. Check out the cheat sheet to browse available icons.

Components

• android-sdk-base - the Braze SDK base analytics library.
• android-sdk-ui - the Braze SDK user interface library for in-app messages, push, and the news feed.
• android-sdk-location - the Braze SDK location library for location and geofences.
• android-sdk-jetpack-compose - the Braze SDK location library for Jetpack Compose support.
• droidboy - a sample app demonstrating how to use Braze in-depth.
• android-sdk-unity - a library that enables Braze SDK integrations on Unity.
• samples - a folder containing several sample apps for various integration options.

Remote repository for gradle

The version should match the git version tag, or the most recent version noted in the changelog. An example dependency declaration is:

Our SDK is now hosted in Maven Central. You can remove https://braze-inc.github.io/braze-android-sdk/sdk from your build.gradle and make sure you have mavenCentral() as a repository.

dependencies {
  implementation 'com.braze:android-sdk-ui:35.0.+'
  implementation 'com.braze:android-sdk-location:35.0.+'
  ...
}

Installing android-sdk-ui to Your Local Maven Repository

To install the UI library as an AAR file to your local maven repository, run the install task with ./gradlew install. You can reference it with groupId com.braze and artifactId android-sdk-ui. The version should match the git version tag, or the most recent version noted in the changelog. An example dependency declaration is:

repositories {
  mavenLocal()
  ...
}

dependencies {
  implementation 'com.braze:android-sdk-ui:35.0.+'
}

Questions?

If you have questions, please contact support@braze.com.