Skip to content

Commit 742a1c9

Browse files
authored
Add Matrix endpoint documentation
1 parent 983b654 commit 742a1c9

1 file changed

Lines changed: 11 additions & 1 deletion

File tree

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ options:
195195

196196
## Alerts
197197

198-
The included dashboard template contains two alerts which will trigger when either a power outage occurs, or a loss of Vuegraf data. There are various reasons why alerts can be helpful. See the below screenshots which help illustrate how a fully functioning alert and notification rule might look. Note that the included alerts do not send out notifications. To enable outbound notifactions, such as to Slack, you can create a Notification Endpoint and Notification Rule.
198+
The included dashboard template contains two alerts which will trigger when either a power outage occurs, or a loss of Vuegraf data. There are various reasons why alerts can be helpful. See the below screenshots which help illustrate how a fully functioning alert and notification rule might look. Note that the included alerts do not send out notifications. To enable outbound notifications, such as to Matrix or Slack, you can create a Notification Endpoint and Notification Rule.
199199

200200
This alert was edited via the text (Flux) interface since the alert edit UI does not yet accommodate advanced alerting inputs.
201201

@@ -207,6 +207,16 @@ This notification rule provides an example of how you can have several alerts ch
207207

208208
![Influx Notification Rule](https://github.com/jertel/vuegraf/blob/master/screenshots/notification_rule.png?raw=true "Influx Notification Rule")
209209

210+
To send alerts to a Matrix chat room hosted on a Synapse server, use a [Hookshot bot](https://github.com/matrix-org/matrix-hookshot) with appropriate URL path routing (via a reverse proxy), and in InfluxDB, specify the Alert Endpoint as follows:
211+
- Destination: HTTP
212+
- HTTP Method: POST
213+
- Auth Method: None
214+
- URL: https://my-matrix-host.net/webhook/1234abcd-4321-1234-abcd-abcdef123456
215+
216+
In the above example, /webhook/ routes to the Hookshot server. Then edit the Alert Notification Rule, and change the `body` variable assignment as follows:
217+
```
218+
body = {text: "🔴 ${r._notification_rule_name} -> ${r._check_name}"}
219+
```
210220

211221
# Additional Topics
212222

0 commit comments

Comments
 (0)