Why use push notifications?
Notifications present small chunks of information to a user. Web apps can use notifications to tell users about important, time-sensitive events, or actions the user needs to take.
The look-and-feel of notifications varies between platforms. For example:
Traditionally, web browsers had to initiate the exchange of information between server and client by making a request. Web push technology, on the other hand, lets you configure your server to send notifications when it makes sense for your app. A push service creates unique URLs for each subscribed service worker. Sending messages to a service worker's URL raises events on that service worker, prompting it to display a notification.
Push notifications can help users to get the most out of your app by prompting them to re-open it and use it based on the latest information.
Creating and sending notifications
Create notifications using the Notifications API. A Notification
object has a title
string and an options
object. For example:
let title = 'Hi!';
let options = {
body: 'Very Important Message',
/* other options can go here */
};
let notification = new Notification(title, options);
The title
is displayed in bold when the notification is active, while the body
contains additional text.
Get permission to send notifications
To display a notification, your app must get permission from the user to do so:
Notification.requestPermission();
How do push notifications work?
The real power of notifications comes from the combination of service workers and push technology:
Service workers can run in the background and display notifications even when your app isn't visible on screen.
Push technology lets you configure your server to send notifications when it makes sense for your app. A push service creates unique URLs for each subscribed service worker. Sending messages to a service worker's URL raises events on that service worker, prompting it to display a notification.
In the following example flow, a client registers a service worker and subscribes to push notifications. Then, the server sends a notification to the subscription endpoint.
The client and service worker use vanilla JavaScript with no extra libraries. The server is built with the express
npm package on Node.js, and uses the web-push
npm package to send notifications. To send information to the server, the client makes a call to a POST URL that the server has exposed.
Part 1: Register a service worker and subscribe to Push
A client app registers a service worker with
ServiceWorkerContainer.register()
. The registered service worker will continue to run in the background when the client is inactive.Client code:
navigator.serviceWorker.register('sw.js');
The client requests permission from the user to send notifications.
Client code:
Notification.requestPermission();
To enable push notifications, the service worker uses
PushManager.subscribe()
to create a push subscription. In the call toPushManager.subscribe()
, the service worker supplies the app's API key as an identifier.Client code:
navigator.serviceWorker.register('sw.js').then(sw => { sw.pushManager.subscribe({ /* API key */ }); });
Push services like Firebase Cloud Messaging operate on a subscription model. When a service worker subscribes to a push service by calling
PushManager.subscribe()
, the push service creates a URL unique to that service worker. The URL is known as a subscription endpoint.The client sends the subscription endpoint to the app server.
Client code:
navigator.serviceWorker.register('sw.js').then(sw => { sw.pushManager.subscribe({ /* API key */ }).then(subscription => { sendToServer(subscription, '/new-subscription', 'POST'); }); });
Server code:
app.post('/new-subscription', (request, response) => { // extract subscription from request // send 'OK' response });
Part 2: Send a notification
The web server sends a notification to the subscription endpoint.
Server code:
const webpush = require('web-push'); let options = { /* config info for cloud messaging and API key */ }; let subscription = { /* subscription created in Part 1*/ }; let payload = { /* notification */ }; webpush.sendNotification(subscription, payload, options);
Notifications sent to the subscription endpoint fire push events with the service worker as the target. The service worker receives the message and displays it to the user as a notification.
Service worker code:
self.addEventListener('push', (event) => { let title = { /* get notification title from event data */ } let options = { /* get notification options from event data */ } showNotification(title, options); })
The user interacts with the notification, making the web app active if it wasn't already.
Next steps
As a next step, implement push notifications!
We've created a series of codelabs to guide you through each step of the process.