https://github.com/webmaxru/node-red-contrib-web-push

A Node-RED node for sending Web Push notifications using VAPID
https://github.com/webmaxru/node-red-contrib-web-push

node-red push-notifications pwa vapid

Last synced: 14 days ago
JSON representation

A Node-RED node for sending Web Push notifications using VAPID

• Host: GitHub
• URL: https://github.com/webmaxru/node-red-contrib-web-push
• Owner: webmaxru
• Created: 2018-08-20T00:24:24.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2021-08-30T14:42:16.000Z (over 3 years ago)
• Last Synced: 2024-12-29T01:41:46.807Z (about 1 month ago)
• Topics: node-red, push-notifications, pwa, vapid
• Language: HTML
• Homepage: https://www.npmjs.com/package/node-red-contrib-web-push
• Size: 794 KB
• Stars: 6
• Watchers: 4
• Forks: 7
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Node-RED Web Push Notification nodes

====================================

`node-red-contrib-web-push` is a [Node-RED](http://nodered.org/) package that allows your Progressive Web Applications to send Web Push notifications using the standard [Web Push Protocol](https://tools.ietf.org/html/draft-ietf-webpush-protocol), while sender authentication can be achieved by implementing [VAPID](https://tools.ietf.org/html/draft-thomson-webpush-vapid). It uses the [web-push](https://github.com/web-push-libs/web-push).

The ```web push``` node is used to send notifications to Chrome, Firefox, Opera, Edge and Samsung Internet browsers. For a list of supported versions of those browsers, check the [web-push](https://github.com/web-push-libs/web-push) page.

Chrome prior 52 and some other old browsers require a GCM Api Key to send notifications, so you will need to configure it in the node.

You can use the ```web-push-notification``` node to set the properties of a notification, or you can send the values in the ```msg.notification``` object.

The device tokens must be provided in the ```msg.subscriptions``` object and they must contain the ```endpoint```, as well as the ```p256dh``` and the ```auth``` keys.

More information available in the ```web``` node info tab.

The ```web``` nodes returns the result in the ```msg.payload``` key.

## Sample flow

You can find an sample flow in ```demo-flow.json```. It contains a simple API to manage the subscriptions and store them in a Flow variable. You can use [PWAtter](https://github.com/webmaxru/pwatter) demo project as a client-side PWA.

## Demo

![Demo GIF](/demo.gif?raw=true "Demo GIF")

## License

Copyright 2018 Maxim Salnikov

Licensed under the Apache License, Version 2.0 (the "License");

you may not use this file except in compliance with the License.

You may obtain a copy of the License at

[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)

Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.

### Credits

This node is based on node-red-contrib-push by Mihail Cristian Dumitru.