Skip to content

SDK overview for developers

Before you begin to integrate the Braze SDKs, you may find yourself wondering what exactly you’re building and integrating. You may be curious about how you can customize the SDK to further to meet your needs. This article can help you answer all of your SDK questions. You can also check out our Technical Integration Checklists and Toolkits course on Braze Learning.

Are you a marketer looking for a basic rundown of the SDK? Check out our marketer overview, instead.

In brief, the Braze SDK:

  • Collects and syncs user data into a consolidated user profile
  • Automatically collects session data, device info, and push tokens
  • Captures marketing engagement data and custom data specific to your business
  • Powers push notifications, in-app messages, and Content Card messaging channels

App performance

Braze should have no negative impact on your app’s performance.

The Braze SDKs have a very small footprint. We automatically change the rate that we flush user data depending on the quality of the network, in addition to allowing manual network control. We automatically batch API requests from the SDK to make sure that data is logged quickly while maintaining maximum network efficiency. Lastly, the amount of data sent from the client to Braze within each API call is extremely small.

SDK compatibility

The Braze SDK is designed to be very well-behaved, and not interfere with other SDKs present in your app. If you are experiencing any issues you think might be due to incompatibility with another SDK, reach out to Braze Support.

Default analytics and session handling

Certain user data is collected automatically by our SDK—for example, First Used App, Last Used App, Total Session Count, Device OS, etc. If you follow our integration guides to implement our SDKs, you will be able to take advantage of this default data collection. Checking this list can help you avoid storing the same information about users more than once. With the exception of session start and end, all other automatically tracked data does not count toward your data point allotment.

Device properties

These properties are collected by the Web SDK upon proper integration.

Name Description
BROWSER The name of the browser.
BROWSER_VERSION The version of the browser.
OS The name of the operating system.
RESOLUTION The screen resolution of the device. The format of this value is “<width>x<height>”.
LANGUAGE The language the browser is set to use.
TIME_ZONE The time zone of the device.
USER_AGENT The user agent string of the browser.
See the Mozilla developer docs for more information.

These properties are collected by the Android SDK upon proper integration.

Name Description
The version of the Android OS installed on the device.
CARRIER The mobile carrier.
MODEL The specific hardware of the device.
RESOLUTION The screen resolution of the device. The format of this value is “<width>x<height>”.
LOCALE The default locale of the device. The format of this value is “<language>_<COUNTRY>” (e.g., “en_US”).
The device time zone.
Whether this app has notifications enabled.

These properties are collected by the iOS SDK upon proper integration.

Name Description
Device Resolution
The screen resolution of the device. The format of this value is “<width>x<height>”.
Device Carrier
The reported mobile carrier.
Device Locale
The default locale of the device.
Device Model
The specific hardware of the device.
Device OS Version
The version of the iOS OS installed on the device.
Device IDFV
Device identifier for vendors. IDFV collection is now optional on our iOS SDK v5.7.0+
Device IDFA
(if supplied) Device identifier for advertisers.
Device Push Enabled
Whether this app has push notifications enabled.
Device Timezone
The reported time zone of the device.
Device Push Authorization Status
Whether this app has push authorization for the device.
Device Ad Tracking Enabled
Whether this app has Ad Tracking enabled.

Data upload and download

The Braze SDK caches data (sessions, custom events, etc.) and uploads it periodically. Only after the data has been uploaded will the values be updated on the dashboard. The upload interval takes into account the state of the device and is governed by the quality of the network connection:

Network Connection Quality Data Flush Interval
Great 10 Seconds
Good 30 Seconds
Poor 60 Seconds

If there is no network connection, data is cached locally on the device until the network connection is re-established. When the connection is re-established, the data will be uploaded to Braze.

Braze sends data to the SDK at the beginning of a session based on which segments the user falls into at the time of the session. The new in-app messages will not be updated during the session. However, user data during the session will be continually processed as it is sent from the client. For example, a lapsed user (last used the app more than 7 days ago) will still receive content targeted at lapsed users on their first session back in the app.

Blocking data collection

It is possible (though not suggested) to block the automatic collection of certain data from your SDK integration, or allowlist processes that do so.

Blocking data collection is not recommended because removing analytical data reduces your platform’s capacity for personalization and targeting. For example:

  • If you choose not to fully integrate for location on one of the SDKs, you will not be able to personalize your messaging based on language or location.
  • If you choose not to integrate for time zone, you might not be able to send messages within a user’s time zone.
  • If you choose to not integrate for specific device visual information, message content might not be optimized for that device.

We highly recommend completely integrating the SDKs to take full advantage of our product’s capabilities.

You may either simply not integrate certain parts of the SDK, or use disableSDK for a user. This method will sync data logged prior to when disableSDK() was called, and will cause all subsequent calls to the Braze Web SDK for this page and future page loads to be ignored. If you wish to resume data collection at a later point in time, you can use the enableSDK() method in the future to resume data collection. You can learn more about this in our Disabling Web Tracking article.

You can use setDeviceObjectAllowlist to configure the SDK to only send a subset of the device object keys or values according to a set allowlist. This must be enabled via setDeviceObjectAllowlistEnabled.

You can pass an appboyOptions value for ABKDeviceAllowlistKey to specify an allowlist for device fields that are collected by the SDK. Fields are defined in ABKDeviceOptions. To turn off the collection of all device fields, set the value of this key to ABKDeviceOptionNone. Refer to Appboy.h for appboyOptions key documentation.

To specify allowlisted device fields, assign the bitwise OR of desired fields to ABKDeviceAllowlistKey in the appboyOptions object passed to startWithApiKey.

New Stuff!