Skip to main content

Push Notifications

Push messages enable your gateway to send notifications on desktop and mobile devices even when the users are not active.

To implement push notifications, you need to:

  1. Create a Service Worker
  2. Ask the user for permission to send push notifications
  3. Send the client identifier information to our notification server
  4. Add logic to display the notifications
Example

Check our working example at https://github.com/near-examples/BOS-notifications

Create the Service Worker​

Push notifications work by having a service worker on the client side that listens for messages from the NEAR notifications server.

Browsers readily provide native support for service workers, so you can easily check if a service worker exists, and create one if not.

Subscribe to our Notifications​

In order to have the service worker display notifications, you need to subscribe it to a notifications server.

A notification server is identified by its public key, constraining that only the server holding the private counterpart can push notifications to the user.

Permission

When you subscribe to the service, the user will be asked for permission to be sent notifications.

Create a Stream in our Server​

After you subscribe the user to a notifications server, share it with us so we can start sending you notifications!

For this, make a post request to our server, add which account you want to be notified for, and a URL identifying your gateway.

tip

The gateway parameter is there just to help us keep track of who receives notifications.

Handle Notifications​

When the user receives a notification, the service worker will be triggered, and you can add logic to display the notification.

Feel free to personalize the notification as you wish, and to add logic on what to do once the notification is clicked. In our example, we just open the Post page.

Was this page helpful?
Need some help? Chat with us or check our Dev Resources!
Twitter
Telegram
Discord
Zulip