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.