parra/ntfy
parra/ntfy
1
0
Fork 0
mirror of https://github.com/binwiederhier/ntfy.git synced 2024-12-27 12:12:28 +01:00
Code Releases Activity

Merge pull request #176 from nickexyz/docs-update

Browse source 
Add Node-RED and Gatus examples.
This commit is contained in:
Philipp C. Heckel 2022-03-18 17:27:57 -04:00 committed by GitHub
commit 3ec8084450
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 50 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

50
docs/examples.md
View file

@ -130,3 +130,53 @@ GitHub have been hopeless. In case it ever becomes available, I want to know imm
It's possible to use custom scripts for all the *arr services, plus SABnzbd. Notifications for downloads, warnings, grabs etc.
Some simple bash scripts to achieve this are available <a href="https://github.com/nickexyz/ntfy-shellscripts">here</a>
## Node-RED
You can use the HTTP request node to send messages with <a href="https://nodered.org">Node-RED</a>, some examples:
Send a message:
<details>
<summary>Flow example</summary>
```
[{"id":"8f09d37dd5773f88","type":"http request","z":"ff3ad4e1.d3415","name":"ntfy","method":"POST","ret":"txt", "paytoqs":"ignore","url":"https://example.com/topic","tls":"","persist":false,"proxy":"","authType":"","senderr":false,"credentials":{},"x":1410,"y":740,"wires":[[]]},{"id":"2603f296b25fe351","type":"function","z":"ff3ad4e1.d3415","name":"data","func":"msg.payload = \"Something happened\";\nmsg.headers = {};\nmsg.headers['tags'] = 'house';\nmsg.headers['X-Title'] = 'Home Assistant';\n\nreturn msg;","outputs":1,"noerr":0,"initialize":"","finalize":"","libs":[],"x":1290,"y":740,"wires":[["8f09d37dd5773f88"]]},{"id":"d2351ed0720a239f","type":"inject","z":"ff3ad4e1.d3415","name":"Manual start","props":[{"p":"payload"},{"p":"topic","vt":"str"}],"repeat":"","crontab":"","once":false,"onceDelay":"20","topic":"","payload":"","payloadType":"date","x":1150,"y":740,"wires":[["2603f296b25fe351"]]}]
```
</details>
Send a picture:
<details>
<summary>Flow example</summary>
```
[{"id":"726d0d75d6c0f70e","type":"http request","z":"ff3ad4e1.d3415","name":"Download jpeg","method":"GET","ret":"bin","paytoqs":"ignore","url":"https://www.google.com/images/branding/googlelogo/1x/googlelogo_color_272x92dp.png","tls":"","persist":false,"proxy":"","authType":"","senderr":false,"credentials":{},"x":1320,"y":780,"wires":[["730dbbc9dbf1ed8a"]]},{"id":"730dbbc9dbf1ed8a","type":"function","z":"ff3ad4e1.d3415","name":"data","func":"msg.payload = msg.payload;\nmsg.headers = {};\nmsg.headers['tags'] = 'house';\nmsg.headers['X-Title'] = 'Home Assistant - Picture';\n\nreturn msg;","outputs":1,"noerr":0,"initialize":"","finalize":"","libs":[],"x":1470,"y":780,"wires":[["592f424b37f76f5c"]]},{"id":"592f424b37f76f5c","type":"http request","z":"ff3ad4e1.d3415","name":"ntfy","method":"PUT","ret":"bin","paytoqs":"ignore","url":"https://example.com/topic","tls":"","persist":false,"proxy":"","authType":"","senderr":false,"x":1590,"y":780,"wires":[[]]},{"id":"8aa06dda3c902f6a","type":"inject","z":"ff3ad4e1.d3415","name":"Manual start","props":[{"p":"payload"},{"p":"topic","vt":"str"}],"repeat":"","crontab":"","once":false,"onceDelay":"20","topic":"","payload":"","payloadType":"date","x":1150,"y":780,"wires":[["726d0d75d6c0f70e"]]}]
```
</details>
## Gatus service health check
An example for a custom alert with <a href="https://github.com/TwiN/gatus">Gatus</a>
```
alerting:
custom:
url: "https://example.com"
method: "POST"
body: |
{
"topic": "mytopic",
"message": "[ENDPOINT_NAME] - [ALERT_DESCRIPTION]",
"title": "Gatus",
"tags": ["[ALERT_TRIGGERED_OR_RESOLVED]"],
"priority": 3
}
default-alert:
enabled: true
description: "health check failed"
send-on-resolved: true
failure-threshold: 3
success-threshold: 3
placeholders:
ALERT_TRIGGERED_OR_RESOLVED:
TRIGGERED: "warning"
RESOLVED: "white_check_mark"
```