extern/apprise
1
0
Fork 0
mirror of https://github.com/caronc/apprise.git synced 2024-10-05 01:32:08 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated Notify_matrix (markdown)

Chris Caron 2021-12-02 10:55:21 -05:00
parent f1ea901ae3
commit f1b7536de9
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

@ -51,6 +51,7 @@ You can also just use the t2bot URL as they share it with you from their website
| 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.
| msgtype | No | This is optional and allows you to specify a Matrix message type to use. Possible options are **text** and **notice**. By default all messages are sent as **text**.
**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.