Ntfy Configuration

A Notifier that sends push notifications via the Ntfy service. Requires the user to have the Ntfy app installed on their phone (e.g. Android or have opened the Progressive Web App. Moreover, it is necessary that the user has subscribed to a specific topic on a Ntfy server.

Class Diagram

diagram

Instantiation

In order to create a new NtfyNotifier, you need to provide the topic that the user has subscribed to on the Ntfy server in use:

NtfyNotifier ntfyNotifier = new NtfyNotifier("friedolyn-es13nsa");

Settings

Note

Javadoc has sadly not recognised the Lombok getters for all fields, but they do exist.

Host

The domain name of the Ntfy server that shall relay the push notifications to the user’s device.

TypeString
JSON keyhost
Defaultntfy.adminforge.de by AdminForge
Examplentfy.sh

URL

The URL of the Ntfy server that shall relay the push notifications to the user’s device.

TypeURL
JSON keyurl
Defaulthttps://ntfy.adminforge.de
Exmaplehttps://ntfy.sh

Topic

The (hopefully unique) topic that the user has subscribed to on the Ntfy server and where all push notifications shall be sent to. Must not be blank.

TypeString
JSON keytopic
Defaultnone (must be provided via constructor)
Examples
  • friedolyn-es13nsa
  • friedolyn-edward-snowden
  • friedolyn-a8e9b939502d0e93