Adding a Notification
First, 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.
Parts of the Message
There are three parts of an apprise notification - a Topic, 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 Topic and Message are text. These can be customised for different needs.
On and Off Messages
You can customise all three of these for both on messages (an indication that an alert has been triggered) and off messages (an indication that the alert condition is not active anymore). Leaving the 'off' URL blank will prevent any message being sent when the alert condition returns to normal.
Substitutions
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 |
Examples
See some examples.