PushEvent

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

The PushEvent interface of the Push API represents a push message that has been received. This event is sent to the global scope of a ServiceWorker. It contains the information sent from an application server to a PushSubscription.

Constructor

PushEvent.PushEvent()
Creates a new PushEvent object.

Properties

Inherits properties from its parent, ExtendableEvent. Additional properties:

PushEvent.data Read only
Returns a reference to a PushMessageData object containing data sent to the PushSubscription.

Methods

Inherits methods from its parent, ExtendableEvent.

Examples

The following example takes data from a PushEvent and displays it on all of the service worker's clients.

self.addEventListener('push', function(event) {
  if (!(self.Notification && self.Notification.permission === 'granted')) {
    return;
  }

  var data = {};
  if (event.data) {
    data = event.data.json();
  }
  var title = data.title || "Something Has Happened";
  var message = data.message || "Here's something you might want to check out.";
  var icon = "images/new-notification.png";

  var notification = new self.Notification(title, {
    body: message,
    tag: 'simple-push-demo-notification',
    icon: icon
  });

  notification.addEventListener('click', function() {
    if (clients.openWindow) {
      clients.openWindow('https://example.blog.com/2015/03/04/something-new.html');
    }
  });
});

Specifications

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

Browser Compatibility

DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidFirefox for AndroidOpera for AndroidSafari on iOSSamsung Internet
PushEvent
Experimental
Chrome Full support 42Edge 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 NoOpera Full support 37Safari No support NoWebView Android No support NoChrome Android Full support 42Firefox Android Full support 44
Full support 44
Full support 48
Notes
Notes Push enabled by default.
Opera Android Full support 37Safari iOS No support NoSamsung Internet Android Full support 4.0
PushEvent() constructor
Experimental
Chrome Full support 42Edge 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 NoOpera Full support 37Safari No support NoWebView Android No support NoChrome Android Full support 42Firefox Android Full support 44
Full support 44
Full support 48
Notes
Notes Push enabled by default.
Opera Android Full support 37Safari iOS No support NoSamsung Internet Android Full support 4.0
data
Experimental
Chrome Full support 57Edge 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 NoOpera Full support 44Safari No support NoWebView Android No support NoChrome Android Full support 57Firefox Android Full support 44
Full support 44
Full support 48
Notes
Notes Push enabled by default.
Opera Android Full support 43Safari iOS No support NoSamsung 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.

See also