Web/API/PushManager

The PushManager interface of the Push API provides a way to receive notifications from third-party servers as well as request URLs for push notifications.

This interface is accessed via the ServiceWorkerRegistration.pushManager property.

Note: This interface replaces functionality previously offered by the obsolete PushRegistrationManager interface.

Properties

PushManager.supportedContentEncodings: Returns an array of supported content codings that can be used to encrypt the payload of a push message.

Methods

PushManager.getSubscription(): Retrieves an existing push subscription. It returns a Promise that resolves to a PushSubscription object containing details of an existing subscription. If no existing subscription exists, this resolves to a null value.
PushManager.permissionState(): Returns a Promise that resolves to the permission state of the current PushManager, which will be one of 'granted', 'denied', or 'prompt'.
PushManager.subscribe(): Subscribes to a push service. It returns a Promise that resolves to a PushSubscription object containing details of a push subscription. A new push subscription is created if the current service worker does not have an existing subscription.

Deprecated methods

PushManager.hasPermission() ': Returns a Promise that resolves to the PushPermissionStatus of the requesting webapp, which will be one of granted, denied, or default. Replaced by PushManager.permissionState().
PushManager.register() ': Subscribes to a push subscription. Replaced by PushManager.subscribe().
PushManager.registrations() ': Retrieves existing push subscriptions. Replaced by PushManager.getSubscription().
PushManager.unregister() ': Unregisters and deletes a specified subscription endpoint. In the updated API, a subscription is unregistered by calling the PushSubscription.unsubscribe() method.

Example

this.onpush = function(event) {
  console.log(event.data);
  // From here we can write the data to IndexedDB, send it to any open
  // windows, display a notification, etc.
}

navigator.serviceWorker.register('serviceworker.js').then(
  function(serviceWorkerRegistration) {
    serviceWorkerRegistration.pushManager.subscribe().then(
      function(pushSubscription) {
        console.log(pushSubscription.endpoint);
        // The push subscription details needed by the application
        // server are now available, and can be sent to it using,
        // for example, an XMLHttpRequest.
      }, function(error) {
        // During development it often helps to log errors to the
        // console. In a production environment it might make sense to
        // also report information about errors back to the
        // application server.
        console.log(error);
      }
    );
  });

Specifications

Specification	Status	Comment
Push APIThe definition of 'PushManager' in that specification.	Working Draft	Initial definition.

Browser compatibility

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
`PushManager` Experimental'	Chrome Full support 42	Edge Full support 16 Disabled' Full support 16 Disabled' Disabled' From version 16: this feature is behind the `Enable service workers` preference. Full support 17	Firefox Full support 44 Notes' Full support 44 Notes' Notes' Extended Support Releases (ESR) before Firefox 78 ESR do not support service workers and the Push API.	IE No support No	Opera Full support 29	Safari No support No	WebView Android No support No	Chrome Android Full support 42	Firefox Android Full support 48 Notes' Full support 48 Notes' Notes' Push enabled by default.	Opera Android Full support 29	Safari iOS No support No	Samsung Internet Android Full support 4.0
`getSubscription` Experimental'	Chrome Full support 42	Edge Full support 16 Disabled' Full support 16 Disabled' Disabled' From version 16: this feature is behind the `Enable service workers` preference. Full support 17	Firefox Full support 44 Notes' Full support 44 Notes' Notes' Extended Support Releases (ESR) before Firefox 78 ESR do not support service workers and the Push API.	IE No support No	Opera Full support 29	Safari No support No	WebView Android No support No	Chrome Android Full support 42	Firefox Android Full support 48 Notes' Full support 48 Notes' Notes' Push enabled by default.	Opera Android Full support 29	Safari iOS No support No	Samsung Internet Android Full support 4.0
`hasPermission` Experimental'	Chrome Full support 42	Edge Full support 16 Disabled' Full support 16 Disabled' Disabled' From version 16: this feature is behind the `Enable service workers` preference. Full support 17	Firefox Full support 44 Notes' Full support 44 Notes' Notes' Extended Support Releases (ESR) before Firefox 78 ESR do not support service workers and the Push API.	IE No support No	Opera Full support 29	Safari No support No	WebView Android No support No	Chrome Android Full support 42	Firefox Android Full support 48 Notes' Full support 48 Notes' Notes' Push enabled by default.	Opera Android Full support 29	Safari iOS No support No	Samsung Internet Android Full support 4.0
`permissionState` Experimental'	Chrome Full support 42	Edge Full support 16 Disabled' Full support 16 Disabled' Disabled' From version 16: this feature is behind the `Enable service workers` preference. Full support 17	Firefox Full support 44 Notes' Full support 44 Notes' Notes' Extended Support Releases (ESR) before Firefox 78 ESR do not support service workers and the Push API.	IE No support No	Opera Full support 29	Safari No support No	WebView Android No support No	Chrome Android Full support 42	Firefox Android Full support 48 Notes' Full support 48 Notes' Notes' Push enabled by default.	Opera Android Full support 29	Safari iOS No support No	Samsung Internet Android Full support 4.0
`register` Experimental'	Chrome Full support 42	Edge Full support 16 Disabled' Full support 16 Disabled' Disabled' From version 16: this feature is behind the `Enable service workers` preference. Full support 17	Firefox Full support 44 Notes' Full support 44 Notes' Notes' Extended Support Releases (ESR) before Firefox 78 ESR do not support service workers and the Push API.	IE No support No	Opera Full support 29	Safari No support No	WebView Android No support No	Chrome Android Full support 42	Firefox Android Full support 48 Notes' Full support 48 Notes' Notes' Push enabled by default.	Opera Android Full support 29	Safari iOS No support No	Samsung Internet Android Full support 4.0
`registrations` Experimental'	Chrome Full support 42	Edge Full support 16 Disabled' Full support 16 Disabled' Disabled' From version 16: this feature is behind the `Enable service workers` preference. Full support 17	Firefox Full support 44 Notes' Full support 44 Notes' Notes' Extended Support Releases (ESR) before Firefox 78 ESR do not support service workers and the Push API.	IE No support No	Opera Full support 29	Safari No support No	WebView Android No support No	Chrome Android Full support 42	Firefox Android Full support 48 Notes' Full support 48 Notes' Notes' Push enabled by default.	Opera Android Full support 29	Safari iOS No support No	Samsung Internet Android Full support 4.0
`subscribe` Experimental'	Chrome Full support 42 Notes' Full support 42 Notes' Notes' The `options` parameter with a `applicationServerKey` value is required.	Edge Full support 16 Disabled' Full support 16 Disabled' Disabled' From version 16: this feature is behind the `Enable service workers` preference. Full support 17	Firefox Full support 44 Notes' Full support 44 Notes' Notes' Extended Support Releases (ESR) before Firefox 78 ESR do not support service workers and the Push API. Notes' From Firefox 72 onwards, can only be called in response to a user gesture such as a `click` event.	IE No support No	Opera Full support 29	Safari No support No	WebView Android No support No	Chrome Android Full support 42	Firefox Android Full support 48 Notes' Full support 48 Notes' Notes' Push enabled by default.	Opera Android Full support 29	Safari iOS No support No	Samsung Internet Android Full support 4.0
`supportedContentEncodings` Experimental'	Chrome Full support 60	Edge Full support 16 Disabled' Full support 16 Disabled' Disabled' From version 16: this feature is behind the `Enable service workers` preference. Full support 17	Firefox Full support 44 Notes' Full support 44 Notes' Notes' Extended Support Releases (ESR) before Firefox 78 ESR do not support service workers and the Push API.	IE No support No	Opera Full support 47	Safari No support No	WebView Android No support No	Chrome Android Full support 60	Firefox Android Full support 48 Notes' Full support 48 Notes' Notes' Push enabled by default.	Opera Android Full support 44	Safari iOS No support No	Samsung Internet Android Full support 4.0
`unregister` Experimental'	Chrome Full support 42	Edge Full support 16 Disabled' Full support 16 Disabled' Disabled' From version 16: this feature is behind the `Enable service workers` preference. Full support 17	Firefox Full support 44 Notes' Full support 44 Notes' Notes' Extended Support Releases (ESR) before Firefox 78 ESR do not support service workers and the Push API.	IE No support No	Opera Full support 29	Safari No support No	WebView Android No support No	Chrome Android Full support 42	Firefox Android Full support 48 Notes' Full support 48 Notes' Notes' Push enabled by default.	Opera Android Full support 29	Safari iOS No support No	Samsung Internet Android Full support 4.0

Legend

Full support: Full support
No support: No support
Experimental. Expect behavior to change in the future.': Experimental. Expect behavior to change in the future.
See implementation notes.': See implementation notes.
User must explicitly enable this feature.': User must explicitly enable this feature.