https://github.com/braze-inc/braze-web-sdk
Public repo for the Braze Web SDK
https://github.com/braze-inc/braze-web-sdk
braze customer-engagement javascript marketing-automation sdk typescript
Last synced: about 1 month ago
JSON representation
Public repo for the Braze Web SDK
- Host: GitHub
- URL: https://github.com/braze-inc/braze-web-sdk
- Owner: braze-inc
- License: other
- Created: 2015-05-12T15:34:56.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2025-03-18T20:09:13.000Z (3 months ago)
- Last Synced: 2025-05-06T07:08:58.624Z (about 1 month ago)
- Topics: braze, customer-engagement, javascript, marketing-automation, sdk, typescript
- Language: HTML
- Homepage: https://www.braze.com
- Size: 842 KB
- Stars: 75
- Watchers: 33
- Forks: 27
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 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!
- [Braze User Guide](https://www.braze.com/docs/user_guide/introduction)
- [Initial Web SDK Setup](https://www.braze.com/docs/developer_guide/platform_integration_guides/web/initial_sdk_setup/)
- [Braze Web SDK Documentation](https://js.appboycdn.com/web-sdk/5.8/doc/modules/braze.html)
## 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.8/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.8/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.8/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](https://js.appboycdn.com/web-sdk/5.8/doc/modules/braze.html#setlogger) before you release your page to production.
## Font Awesome
Braze uses [Font Awesome](http://fortawesome.github.io/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](http://fortawesome.github.io/Font-Awesome/cheatsheet/) to browse available icons.
## Questions?
If you have questions, please contact [[email protected]](mailto:[email protected]). If you believe you are encountering a bug, feel free to file issues in this repository.