Help / Alerts
ntfy
ntfy is a free app that shows push notifications on your phone or computer. You subscribe to a topic in the ntfy app, and HonkWatch sends alerts to that topic.
What you need first
- The ntfy app on your phone, or the ntfy website open on your computer. See the ntfy documentation for where to get it.
- A topic name. On the public server, ntfy.sh, anyone who knows a topic name can read it, so pick a long name that is hard to guess, such as
shop-alerts-7f3k9q2m.
Subscribe in ntfy
- Open the ntfy app.
- Subscribe to a new topic and type your topic name. Leave the server as ntfy.sh unless you run your own.
- Your topic's address is the server followed by the topic name, for example
https://ntfy.sh/shop-alerts-7f3k9q2m.
Add it in HonkWatch
- Open Alerts and go to Add a channel.
- Under Where should alerts go?, choose ntfy.
- In Send to, enter the full topic address, starting with
https://. - If you like, fill in Label (optional), such as "My phone".
- Tick the events to send: Down, Back up, Certificate expiring and Slow.
- Press Add channel.
Every phone or computer subscribed to the same topic gets the alerts. To add another phone, subscribe to the same topic on it.
Send a test
- In the channel list on Alerts, press Send test on the ntfy row.
- A notification about "Test monitor" should appear in the ntfy app shortly.
What an alert looks like
The notification title is the service name in square brackets, then the monitor and what happened, for example "Shop is DOWN". The text gives the monitor's address, the reason and a link to the monitor's page.
Your own ntfy server
You can use your own ntfy server instead of ntfy.sh. Its address must start with https:// and be reachable from the internet. Addresses on a private or local network are refused.
HonkWatch does not send a username, password or access token to ntfy. A topic that needs one to publish will refuse the alerts. Allow anonymous publishing on that topic, or use a hard-to-guess topic name instead.
If it does not work
- You see "That needs an https:// address". Enter the full address, starting with
https://, not just the topic name. - Recently sent shows failed. The ntfy server refused the message or could not be reached. Check the address. On your own server, check that the topic allows publishing without a login.
- Recently sent shows sent, but the phone shows nothing. Check that the ntfy app is subscribed to exactly the same topic name and server, spelled exactly the same way. Also check the phone allows notifications from ntfy and that battery saving is not stopping it.
See also Setting up alerts for which events go where.
Still stuck? Email [email protected] and say which guide you were following.