PushEvent

Experimental: 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

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
PushEvent
42
17
44
Extended Support Releases (ESR) before Firefox 78 ESR do not support service workers and the Push API.
No
37
No
No
42
44
48
Push enabled by default.
37
No
4.0
PushEvent
42
17
44
Extended Support Releases (ESR) before Firefox 78 ESR do not support service workers and the Push API.
No
37
No
No
42
44
48
Push enabled by default.
37
No
4.0
data
57
17
44
Extended Support Releases (ESR) before Firefox 78 ESR do not support service workers and the Push API.
No
44
No
No
57
44
48
Push enabled by default.
43
No
4.0

See also

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