@braze/web-sdk-core

Install

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

This will install the Braze Web SDK files into ./node_modules/@braze/web-sdk-core 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

Note that this core version of the SDK does not contain any of Braze's built-in UI capabilities (any appboy.display methods). You will need to implement your own UI for In-App Messaging and Content Cards. Note that our UI elements are fully customizable via css, so we generally recommend integration of the complete library instead.

var appboy = require('@braze/web-sdk-core');
appboy.initialize('YOUR-API-KEY', { baseUrl: 'YOUR-SDK-ENDPOINT' });
appboy.openSession();

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

Changelog

3.3.0

Added

• Introduced support for new SDK Authentication feature.
• Introduced an inAppMessageZIndex initialization option that allows you to easily customize the z-index of In-App Messages displayed by the built-in UI.
• Added successCallback and errorCallback parameters to requestContentCardsRefresh.
• The SDK now logs deprecation warnings for deprecated methods and initialization options when logging is enabled.
• Added support for brazeBridge, which has the same API as appboyBridge. appboyBridge is now deprecated but will continue to function.
• Introduced support for the upcoming nested properties feature in appboy.logCustomEvent and appboy.logPurchase.

Changed

• Removed appboyQueue replay snippet from the npm publication of the SDK. This avoids possible race conditions when referencing the SDK simultaneously from npm and the CDN, and removes use of eval from the npm package
• appboy.logCustomEvent and appboy.logPurchase now impose a 50KB limit on custom properties. If the supplied properties are too large, the event is not logged.
• Deprecated the trackLocation method in favor of using the native Geolocation API and passing the location data to 'User.setLastKnownLocation`. See our public docs for more information.
• Deprecated the enableHtmlInAppMessages initialization option in favor of allowUserSuppliedJavascript. These options are functionally equivalent and no other changes are required.

Fixed

• Fixed incorrect typing for User.setCountry.
• Added missing dismissed property to TypeScript definition and docs for Card subclasses.