This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The subscribe() method of the PushManager interface 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.


​PushManager.subscribe(options).then(function(pushSubscription) { ... } );


options Optional
An object containing optional configuration parameters. It can have the following properties:
  • userVisibleOnly: A boolean indicating that the returned push subscription will only be used for messages whose effect is made visible to the user.
  • applicationServerKey: A Base64-encoded DOMString or ArrayBuffer containing an ECDSA P-256 public key that the push server will use to authenticate your application server. If specified, all messages from your application server must use the VAPID authentication scheme, and include a JWT signed with the corresponding private key. This key IS NOT the same ECDH key that you use to encrypt the data. For more information, see "Using VAPID with WebPush".

Note: This parameter is required in some browsers like Chrome and Edge.


A Promise that resolves to a PushSubscription object.


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


// Use serviceWorker.ready to ensure that you can subscribe for push
  function(serviceWorkerRegistration) {
    var options = {
      userVisibleOnly: true,
      applicationServerKey: applicationServerKey
      function(pushSubscription) {
        // 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.


Specification Status Comment
Push API
The definition of 'subscribe()' in that specification.
Working Draft Initial definition.

Browser compatibility

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support421



443 No29 No
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support No42 Yes48429 No4.0

1. The options parameter with a applicationServerKey value is required.

2. From version 16: this feature is behind the Enable service workers preference.

3. Service workers (and Push) have been disabled in the Firefox 45 and 52 Extended Support Releases (ESR.)

4. Push enabled by default.

Document Tags and Contributors

Last updated by: erikadoyle,