ntfy integration

ntfy delivers push notifications to a topic that you subscribe to from a phone, browser, or the command line. It works with the hosted ntfy.sh service or your own self-hosted server.

Pick a topic

1. Choose a topic name, for example checkmate-alerts. Anyone who knows the topic can read it, so use a hard-to-guess name on public servers.
2. Subscribe to the topic in the ntfy app or at https://ntfy.sh/<your-topic>.

Add the notification in Checkmate

1. Open Notifications in the sidebar.
2. Click Create notification and pick ntfy.
3. Enter:
   • Server URL — https://ntfy.sh or the address of your self-hosted server.
   • Topic — the topic name you chose.
4. Click Test, then Save.

Test messages and incident alerts publish to <server>/<topic> with the monitor name, URL, type, and current status in the body.

Authenticated topics

Since v3.11.0 Checkmate can publish to protected topics. Two schemes are supported:

• Access token — sent as a Bearer token. Generate one in ntfy with ntfy token add.
• Username and password — sent as HTTP basic auth.

As of v3.11.0 these are set through the notification API (ntfyAuthType of token or basic, plus the credential fields); the create-channel form in the UI exposes the server URL and topic.

See also

• Testing notifications
• Pushover integration