@braze/web-sdk

Braze SDK for web sites and other JS platforms.


Keywords
Appboy, Braze, customer-engagement, javascript, marketing-automation, sdk, typescript
Licenses
NTP/MIT-feh
Install
npm install @braze/web-sdk@5.2.0

Documentation

lighthouse score

Braze Web SDK

Effective marketing automation is an essential part of successfully scaling and managing your business. Braze empowers you to build better customer relationships through a seamless, multi-channel approach that addresses all aspects of the user life cycle. Braze helps you engage your users on an ongoing basis. We'll have you up and running in no time!

Libraries

Name Description npm CDN URL
Full Full SDK with UI. When using the npm version, Javascript bundlers will remove any unused code including the UI. @braze/web-sdk https://js.appboycdn.com/web-sdk/5.2/braze.min.js
Core Contains the SDK without UI. You will need to implement your own UI for In-App Messaging and Content Cards when using this version of the SDK. Our UI elements are fully customizable via css, so we generally recommend integration of the full library instead. N/A https://js.appboycdn.com/web-sdk/5.2/braze.core.min.js
No-AMD Contains the full SDK without AMD support. This is useful if your site uses RequireJS or another AMD module-loader, but you prefer to load the SDK through the CDN. N/A https://js.appboycdn.com/web-sdk/5.2/braze.no-amd.min.js

Supported Browsers

CDN Version

  • Modern Chromium based browsers (Chrome, Edge, Opera)
  • Firefox
  • Safari

NPM Version

  • Modern Chromium based browsers (Chrome, Edge, Opera)
  • Firefox
  • Safari

Debugging / Troubleshooting

Pass the option enableLogging: true to the initialize function (braze.initialize('YOUR-API-KEY-HERE', { baseUrl: 'YOUR-SDK-ENDPOINT', enableLogging: true });) to cause Braze to log to the javascript console. This is valuable for development but is visible to all users, so remove this option or provide an alternate logger before you release your page to production.

Font Awesome

Braze uses Font Awesome 4.7.0 for in-app message icons. To disable loading Font Awesome, use the doNotLoadFontAwesome initialization option. Check out the cheat sheet to browse available icons.

Questions?

If you have questions, please contact support@braze.com. If you believe you are encountering a bug, feel free to file issues in this repository.