Initial SDK Setup
Integrating the Braze SDK will provide you with basic analytics functionality as well as in-app messages with which you can engage your users. Note that the web SDK file size is 32.3 KB.
Integrate the Braze Library
To integrate the Braze Web SDK, follow the instructions in the “Getting Started” section of the Braze Web SDK Github Repository.
Substitute the API key found within the “App Settings” page (labeled “API Key” in the “Settings for …” block) of your Braze account for
YOUR-API-KEY-HERE. For more detailed technical documentation, refer to the complete JSDocs.
Your Braze representative should have already advised you of the correct endpoint. Reference the endpoint within your initialization snippet, for example:
Enable Error Logging
To enable logging, you can pass the option
enableLogging: true to your initialize function (or call
appboy.setLogger() before you release your page to production.
Initialize Tag Managers
Google Tag Manager
Initializing the SDK
Braze’s SDK can be initialized and controlled within tags configured from Google Tag Manager.
This is instead of directly placing the snippit directly within the <head> section of your website.
Subsequent tags which fire after page load can then reference this. For example
Please also ensure to replace the API key and custom SDK endpoint in the code with your API key.
Braze suggests the tag has the trigger configuration of Page View > DOM Ready. Other Page View triggers can fire the tag, provided that no other Braze related tags are fired to prior to this.
Logging Events and using Braze’s Messaging Channels
For Push, In-App Message, News Feed integration instructions please follow the standard integration instructions.
For Analytics integration, reference
AMD Module Loader
If you are using Google Tag Manager alongside an AMD module loader such as RequireJS to load Braze’s SDK you will need to use the RequireJS-compatible integration snippet in your <head> tag.
For further instruction on this please see the appropriate section of our Braze Web SDK Github Repository.
Tealium iQ offers a basic turnkey Braze integration. To configure the integration, just search for Braze in the Tealium Tag Management interface, and provide the Web SDK API key from your dashboard.
For more details, or in-depth Tealium configuration support, check out our integration documentation or reach out to your Tealium Account Manager.
Other Tag Managers
Braze may also be compatible with other tag management solutions. Please reach out to the a Braze representative if you need help evaluating these solutions.
Upgrading The SDK
When you reference the Braze Web SDK from our content delivery network, for example https://js.appboycdn.com/web-sdk/a.a/appboy.min.js (as recommended by our default integration instructions), your users will receive minor updates (bug fixes and backwards compatible features, versions a.a.a through a.a.z in the above examples) automatically when they refresh your site. When we release major changes however, we require you to upgrade the Braze Web SDK manually to insure that nothing in your integration will be impacted by any breaking changes. Additionally, if you download our SDK and rehost it yourself (which is also a valid integration path), you won’t receive any version updates automatically and should upgrade manually from time-to-time to receive the latest features and bug fixes.
You can keep up-to-date with our latest release following our release feed with the RSS Reader or service of your choice, and see our changelog for a full accounting of our Web SDK release history. To upgrade the Braze Web SDK:
https://js.appboycdn.com/web-sdk/[OLD VERSION NUMBER]/appboy.min.jsin the
<head>of your site to
https://js.appboycdn.com/web-sdk/[NEW VERSION NUMBER]/appboy.min.js
- If you have web push integrated, update the service worker file on your site - by default, this is located at
/service-worker.jsat the root of your site, but the location may be customized in some integrations.
These files must be updated in coordination with each other to ensure proper functionality.