PushSubscription

Baseline 2023

Newly available

Since March 2023, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

Note: This feature is available in Web Workers.

The PushSubscription interface of the Push API provides a subscription's URL endpoint and allows unsubscribing from a push service.

An instance of this interface can be serialized.

Instance properties

PushSubscription.endpoint Read only

A string containing the endpoint associated with the push subscription.

PushSubscription.expirationTime Read only

A DOMHighResTimeStamp of the subscription expiration time associated with the push subscription, if there is one, or null otherwise.

PushSubscription.options Read only

An object containing the options used to create the subscription.

PushSubscription.subscriptionId Read only

A string containing the subscription ID associated with the push subscription.

Instance methods

PushSubscription.getKey()

Returns an ArrayBuffer which contains the client's public key, which can then be sent to a server and used in encrypting push message data.

PushSubscription.toJSON()

Standard serializer — returns a JSON representation of the subscription properties.

PushSubscription.unsubscribe()

Starts the asynchronous process of unsubscribing from the push service, returning a Promise that resolves to a boolean value when the current subscription is successfully unregistered.

Example

js
navigator.serviceWorker.ready.then((reg) => {
  reg.pushManager.getSubscription().then((subscription) => {
    subscription
      .unsubscribe()
      .then((successful) => {
        // You've successfully unsubscribed
      })
      .catch((e) => {
        // Unsubscribing failed
      });
  });
});

Specifications

Specification
Push API
# pushsubscription-interface

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Opera Safari Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet WebView Android
PushSubscription 42 17 44 29
16Notifications are supported on macOS Ventura and later.
 42 48 29
16.4Notifications are supported in web apps saved to the home screen.
 4.0 No
endpoint 42 17 44 29
16Notifications are supported on macOS Ventura and later.
 42 48 29
16.4Notifications are supported in web apps saved to the home screen.
 4.0 No
expirationTime 60 17 96 47
16Notifications are supported on macOS Ventura and later.
 60 96 44
16.4Notifications are supported in web apps saved to the home screen.
 8.0 No
getKey 42 17 44 29
16Notifications are supported on macOS Ventura and later.
 42 48 29
16.4Notifications are supported in web apps saved to the home screen.
 4.0 No
options 54 17 44 41
16Notifications are supported on macOS Ventura and later.
 54 48 41
16.4Notifications are supported in web apps saved to the home screen.
 6.0 No
subscriptionId 42 17 No 29 No 42 No 29 No 4.0 No
toJSON 42 17 44 29
16Notifications are supported on macOS Ventura and later.
 50 48 37
16.4Notifications are supported in web apps saved to the home screen.
 5.0 No
unsubscribe 42 17 44 29
16Notifications are supported on macOS Ventura and later.
 50 48 37
16.4Notifications are supported in web apps saved to the home screen.
 5.0 No

See also

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/PushSubscription