ContextQMD
Back to Content

PushEvent

files/en-us/web/api/pushevent/index.md

latest1.9 KB
Original Source

{{APIRef("Push API")}}{{SecureContext_Header}}{{AvailableInWorkers("service")}}

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 {{domxref("ServiceWorker")}}. It contains the information sent from an application server to a {{domxref("PushSubscription")}}.

{{InheritanceDiagram}}

Constructor

  • {{domxref("PushEvent.PushEvent", "PushEvent()")}}
    • : Creates a new PushEvent object.

Instance properties

Inherits properties from its parent, {{domxref("ExtendableEvent")}}. Additional properties:

  • {{domxref("PushEvent.data")}} {{ReadOnlyInline}}
    • : Returns a reference to a {{domxref("PushMessageData")}} object containing data sent to the {{domxref("PushSubscription")}}.

Instance methods

Inherits methods from its parent, {{domxref("ExtendableEvent")}}.

Examples

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

js
self.addEventListener("push", (event) => {
  if (!(self.Notification && self.Notification.permission === "granted")) {
    return;
  }

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

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

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

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also