Documentation

Get the SDK


Our Web Push SDK currently supports the following browsers and platforms:

  • Firefox: Windows / Mac / Android
  • Chrome: Windows / Mac / Android
  • Safari: Currently unsupported

Important: Your website must be served over HTTPS for Web Push integration to work.

Import the SDK


Import version 1.0.0 of the SDK by adding the following line to the <head> tag:

<script src="https://sdk.pushy.me/web/1.0.0/pushy-sdk.js"></script>

Alternatively, download pushy-sdk.js and host it on your own servers. If you're interested, check out the full changelog to see what's new in the latest version of the Pushy Web Push SDK.

Create Service Worker


Create a file called service-worker.js in the root directory of your website with the following contents:

// Import Pushy Service Worker 1.0.0
importScripts('https://sdk.pushy.me/web/1.0.0/pushy-service-worker.js');

This file must be accessible at https://example.com/service-worker.js, where example.com is your website hostname.