@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.2.0

Added

• Added an optional parentNode parameter to appboy.display.hideContentCards that allows you to specify a particular Content Cards feed to hide.

Changed

• Cookies set by the SDK are now renewed when a new session is started. This fixes an issue where the SDK would stop setting cookies that had been deleted or expired when identification information existed in localStorage, preventing cross-subdomain identification from functioning in certain circumstances.
• Increased clickable area of all buttons in the built-in UI to be at least 45x45px to comply with mobile accessibility best-practices. This includes some minor changes to the Content Cards and News Feed UI to accommodate the larger buttons.

Fixed

• Fixed an issue where some network requests fail on websites using certain libraries that overwrite the native Promise object.