PushSubscription

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

 

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

An instance of this interface can be serialized.

Properties

PushSubscription.endpoint Read only
A USVString containing the endpoint associated with the push subscription.
PushSubscription.expirationTime Read only
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 DOMString containing the subscription ID associated with the push subscription.

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 when the current subscription is successfully unregistered.

Example

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

Specifications

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

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidEdge MobileFirefox for AndroidOpera for AndroidSafari on iOSSamsung Internet
Basic support
Experimental
Chrome Full support 42Edge Full support YesFirefox Full support 44
Notes
Full support 44
Notes
Notes Service workers (and Push) have been disabled in the Firefox 45 & 52 Extended Support Releases (ESR).
IE No support NoOpera Full support 29Safari No support NoWebView Android No support NoChrome Android Full support 42Edge Mobile ? Firefox Android Full support 48Opera Android Full support 29Safari iOS No support NoSamsung Internet Android Full support 4.0
endpoint
Experimental
Chrome Full support 42Edge Full support 16Firefox Full support 44
Notes
Full support 44
Notes
Notes Service workers (and Push) have been disabled in the Firefox 45 & 52 Extended Support Releases (ESR).
IE No support NoOpera Full support 29Safari No support NoWebView Android No support NoChrome Android Full support 42Edge Mobile ? Firefox Android Full support 48Opera Android Full support 29Safari iOS No support NoSamsung Internet Android Full support 4.0
expirationTime
Experimental
Chrome Full support 60Edge Full support 16Firefox ? IE No support NoOpera Full support 47Safari No support NoWebView Android No support NoChrome Android Full support 60Edge Mobile ? Firefox Android ? Opera Android Full support 47Safari iOS No support NoSamsung Internet Android No support No
options
Experimental
Chrome Full support 42Edge Full support 16Firefox Full support 44
Notes
Full support 44
Notes
Notes Service workers (and Push) have been disabled in the Firefox 45 & 52 Extended Support Releases (ESR).
IE No support NoOpera Full support 29Safari No support NoWebView Android No support NoChrome Android Full support 42Edge Mobile ? Firefox Android Full support 48Opera Android Full support 29Safari iOS No support NoSamsung Internet Android Full support 4.0
subscriptionId
Experimental
Chrome Full support 42Edge Full support YesFirefox Full support 44
Notes
Full support 44
Notes
Notes Service workers (and Push) have been disabled in the Firefox 45 & 52 Extended Support Releases (ESR).
IE No support NoOpera Full support 29Safari No support NoWebView Android No support NoChrome Android Full support 42Edge Mobile ? Firefox Android Full support 48Opera Android Full support 29Safari iOS No support NoSamsung Internet Android Full support 4.0
getKey
Experimental
Chrome Full support 42Edge Full support 16Firefox Full support 44
Notes
Full support 44
Notes
Notes Service workers (and Push) have been disabled in the Firefox 45 & 52 Extended Support Releases (ESR).
IE No support NoOpera Full support 29Safari No support NoWebView Android No support NoChrome Android Full support 42Edge Mobile ? Firefox Android Full support 48Opera Android Full support 29Safari iOS No support NoSamsung Internet Android Full support 4.0
toJSON
Experimental
Chrome Full support 42Edge ? Firefox ? IE No support NoOpera ? Safari ? WebView Android No support NoChrome Android Full support 50Edge Mobile ? Firefox Android ? Opera Android ? Safari iOS ? Samsung Internet Android Full support 5.0
unsubscribe
Experimental
Chrome Full support 42Edge Full support 16Firefox ? IE No support NoOpera ? Safari ? WebView Android No support NoChrome Android Full support 50Edge Mobile ? Firefox Android ? Opera Android ? Safari iOS ? Samsung Internet Android Full support 5.0

Legend

Full support  
Full support
No support  
No support
Compatibility unknown  
Compatibility unknown
Experimental. Expect behavior to change in the future.
Experimental. Expect behavior to change in the future.
See implementation notes.
See implementation notes.

See also

Document Tags and Contributors

Last updated by: dhurlburtusa,