First, you'll need to go to the notification settings under Administration.
Next, choose what alerts you want to notify about.
You can choose to notify based on a single alert, all alerts or alerts that match a pattern.
Then either choose the alert from the list or enter the text you'd like to match with. For example, if you wanted to send notifications of any alert containing the word 'Critical' or 'Low Level'.
Press Add Notification when done.
This sets up the trigger for the notification. Next you need to add one or more actual notifications - where the messages are sent and what they contain.
There are two different events when it comes to alerts - when the alert turns 'on' (becomes active) and when the alert turns 'off' (becomes inactive).
You can add a notification method by opening your newly-created notification type and pressing the '+' button next to either When Active or When Inactive.
There are three parts of an apprise notification - a Title, a Message and a URL.
The URL defines which type of notification is sent, such as choosing between a Discord message or an SMS. The URL will include the destination address (such as phone number, email or server) and options.
See here for the different methods available. Click on the method name for details on what options are available.
The Title (or 'Topic') and Message are text. These control the actual message that appears and can be customised.
In emails, the title is your subject and the message is the content of your mail. However in others, the topic either isn't used or is placed directly before or after the message.
When you add a individual notifications to the list, you'll be prompted for each of these three key elements.
You can also choose from the list of templates for some common, pre-filled Apprise notification defaults.
Leaving the URL blank will prevent any message being sent.
You can substitute content in the topic, content and URL options with curly braces.
For example, you might want to change the message content to fit a normal log format, with…
{time} {name} {status}
The following substitutions are valid…
| Code | Meaning | Example |
|---|---|---|
| name | The name of the alert | Main Pump Offline |
| id | The unique ID of the alert | 22 |
| assetid | The unique ID of the asset | 45 |
| status | Text describing the state | Alert or OK |
| state | A number describing the state | 1 or 0 |
| time | The local time in HH:MM:SS | 10:42:22 |
See some examples.