github
/
apprise
mirror of https://github.com/caronc/apprise
1
0
Fork 0
Code Issues Releases Wiki Activity

Updated Notify_matrix (markdown)

master
Chris Caron 2019-04-03 20:54:15 -04:00
parent 0e1f3952b2
commit f93af2c657
1 changed files with 1 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Notify_matrix.md

@ -42,6 +42,7 @@ When you specify the **?webhook=** argument you immediately shift entirely how t
| room_alias | No | The room alias you wish to join (if not there already) and broadcast your notification. For ambiguity purposes _you should_ prefix these locations with a pound/hashtag symbol **#** although it is not required.
| room_id | No | The room id you wish to join (if not there already) and broadcast your notification. For ambiguity purposes, _you MUST_ prefix these locations with a exclamation symbol **!** (_otherwise it is interpreted as a room_alias instead_)
| thumbnail | No | Displays an image before each notification is sent that identifies the notification type (warning, info, error, success). By default this option is set to **False**.
| mode | No | This is optional and allows you to specify a webhook mode instead. Setting this to **matrix** or **slack** allows you to leverage [this webhook service](https://matrix.org/docs/projects/bot/matrix-webhook.html) instead of directly communicating with the matrix server. By default no webhooks are used.
**Note**: If neither a **{room_alias}** or a **{room_id}** is specified on the URL then upon connecting to the matrix server, a list of currently joined channels will be polled. Each and every channel the account is currently part of will automatically be notified.