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 2024-01-27 16:15:08 -05:00
parent 2fe16e6eb7
commit 0b4f4e9fee
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Notify_matrix.md

@ -53,6 +53,8 @@ You can also just use the t2bot URL as they share it with you from their website
| 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**.
| version | No | Optionally over-ride the API version of matrix to use. Possible values are *2* and *3*. By default the version is set to **3**.
**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.
@ -65,6 +67,11 @@ Send a secure Matrix.org notification to our server
# Assuming the {room_alias} we want to notify is #general and #apprise
apprise -vv -t "Test Message Title" -b "Test Message Body" \
matrixs://nuxref:abc123@matrix.example.com/#general/#apprise
# Attachments do not work using the Matrix v3 version; use the
# following to fall back to an earlier API version:
apprise -vv -t "Test Message Title" -b "Test Message Body" \
matrixs://nuxref:abc123@matrix.example.com/#general/#apprise?v=2
```
Send a [**t2bot.io**](https://t2bot.io/webhooks/) request: