@braze/web-sdk

What is @braze/web-sdk?

@braze/web-sdk is a JavaScript library that allows developers to integrate Braze's customer engagement platform into web applications. It provides functionalities for user tracking, messaging, and analytics, enabling personalized and targeted communication with users.

What are @braze/web-sdk's main functionalities?

User Identification

This feature allows you to identify and track users by setting a unique user ID. This is essential for personalizing user experiences and tracking user-specific data.

Braze.changeUser('user_id');

Custom Events

This feature allows you to log custom events that users trigger within your application. These events can be used for analytics and to trigger personalized messaging.

Braze.logCustomEvent('event_name', { property1: 'value1', property2: 'value2' });

In-App Messaging

This feature enables you to display in-app messages to users. These messages can be used for announcements, promotions, or any other type of user communication.

Braze.showInAppMessage();

Push Notifications

This feature allows you to handle push notifications within your web application. You can subscribe to and manage incoming push notifications to engage users effectively.

Braze.subscribeToInAppMessage((message) => { console.log(message); });

User Attributes

This feature allows you to set user attributes, which can be used to personalize user experiences and segment users for targeted messaging.

Braze.setUserAttributes({ firstName: 'John', lastName: 'Doe', email: '[e-mail]' });

Other packages similar to @braze/web-sdk

mixpanel-browser

Mixpanel is an analytics platform that provides similar functionalities for tracking user interactions and events. It also offers advanced analytics and user segmentation features, making it a strong alternative to Braze.

firebase

Firebase is a comprehensive app development platform that includes analytics, messaging, and user engagement tools. It offers similar functionalities to Braze for tracking user behavior and sending targeted messages, but also includes additional services like real-time databases and authentication.

README

Install

$ npm install --save @braze/web-sdk

This will install the Braze Web SDK files into ./node_modules/@braze/web-sdk where you can reference them locally. Note that the Braze Web SDK is meant to be used client-side in a web application and may not work as expected in a Node.js server environment.

Usage

var appboy = require('@braze/web-sdk');
appboy.initialize('YOUR-API-KEY');
appboy.display.automaticallyShowNewInAppMessages();
appboy.openSession();

See the Public Github Repo for getting started instructions or our documentation pages for use-case based documentation.

Changelog

2.6.0

Added

• Introduced new NPM packages under the @braze scope. The core and full versions of the SDK as well as the service worker are now published in their own packages, resulting in a drastically reduced install size compared to the appboy-web-sdk package. This is not a breaking change for existing NPM integrations and we will continue to publish the appboy-web-sdk package to maintain backwards compatibility. See the README for integration details.
• Added appboyBridge.getUser().setLanguage(language) to HTML In-App Messages.

Changed

• The new HTML In-App Message type now allows multiple clicks to be logged for a given message.

Fixed

• Made push-related methods more defensive against edge-cases where Notification is not defined.
• Fixed an issue where unexpected backend responses could result in a javascript error.
• Fixed an issue in recent versions of Safari where calling appboy.registerAppboyPushMessages would throw a javascript error if the user did not allow websites to ask for permission to send notifications.