This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for usage in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the specification changes.

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 public key your push server will use to send messages to client apps via a push server. This value is part of a signing key pair generated by your application server and usable with elliptic curve digital signature (ECDSA) over the P-256 curve. This can be a DOMString (including Base64-encoded values) or an ArrayBuffer.


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.

  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

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support 42.0 44.0 (44.0)[1] No support ? No support
applicatonServerKey 52.0     39  
Feature Android Android Webview Firefox Mobile (Gecko) Firefox OS IE Mobile Opera Mobile Safari Mobile Chrome for Android
Basic support No support No support 48.0 (48)[2] No support No support No support No support 42.0
applicatonServerKey No support No support       52.0   52.0

Document Tags and Contributors

 Last updated by: chrisdavidmills,