@braze/service-worker

Braze service worker to be used with the Braze Web SDK.

Usage no npm install needed!

<script type="module">
  import brazeServiceWorker from 'https://cdn.skypack.dev/@braze/service-worker';
</script>

README

Install

$ npm install --save @braze/web-sdk # or another version of the Web SDK, such as web-sdk-core
$ npm install --save @braze/service-worker

This will install the Braze Service Worker files into ./node_modules/@braze/service-worker where you can reference them locally. Note that the Braze Service Worker is only meant to be used along with the Braze Web SDK.

Usage

In your build process, copy node_modules/@braze/service-worker/service-worker.js to your web application's public root directory.

Then, using the Web SDK, provide the serviceWorkerLocation initialization option with the path to your service worker.

See our documentation pages for steps to integrate push notifications into your website using the Braze Web SDK.