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 2021-08-02 15:57:17 -04:00
parent 70f7f5080b
commit fe9cf732a9
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Notify_matrix.md

@ -4,13 +4,13 @@
* **Message Format**: Text * **Message Format**: Text
* **Message Limit**: 1000 Characters per message * **Message Limit**: 1000 Characters per message
By default the notification service references the Matrix server using it's built in API. By default the Apprise Integration of Matrix occurs using it's built in API.
However, [the webhook service](https://matrix.org/docs/projects/bot/matrix-webhook.html) also works for those wishing to use it too. At the time, this is still identified as being in it's _late beta_ state. However, [the webhook service](https://matrix.org/docs/projects/bot/matrix-webhook.html) also works for those wishing to use it too. At the time, this is still identified as being in it's _late beta_ state.
This can be done by specifying **?webhook=matrix** or **?webhook=slack**. Presuming you've [set it up](https://github.com/turt2live/matrix-appservice-webhooks). This can be done by specifying **?webhook=matrix** or **?webhook=slack**. Presuming you've [set it up](https://github.com/turt2live/matrix-appservice-webhooks).
### Syntax ### Syntax
Valid syntaxes are as follows: Valid syntax's are as follows:
* `matrix://{user}:{password}@{matrixhost}/#{room_alias}` * `matrix://{user}:{password}@{matrixhost}/#{room_alias}`
* `matrixs://{user}:{password}@{matrixhost}/!{room_id}` * `matrixs://{user}:{password}@{matrixhost}/!{room_id}`
@ -26,11 +26,11 @@ You can mix and match as many rooms as you wish:
* **!abc123** is internally interpreted as **!abc123:localhost** * **!abc123** is internally interpreted as **!abc123:localhost**
* **!def456:example.com** is not altered and is directly notified as such * **!def456:example.com** is not altered and is directly notified as such
When you specify the **?webhook=** argument you immediately shift entirely how this plugin works and the syntax becomes: When you specify the **?mode=** argument you immediately shift entirely how this plugin works and the syntax becomes:
* `matrix://{user}:{token}@{hostname}?webhook=matrix` * `matrix://{user}:{token}@{hostname}?mode=matrix`
* `matrixs://{token}@{hostname}:{port}?webhook=matrix` * `matrixs://{token}@{hostname}:{port}?mode=matrix`
* `matrix://{user}:{token}@{hostname}?webhook=slack&format=markdown` * `matrix://{user}:{token}@{hostname}?mode=slack&format=markdown`
* `matrixs://{token}@{hostname}?webhook=slack&format=markdown` * `matrixs://{token}@{hostname}?mode=slack&format=markdown`
If you use [**t2bot.io**](https://t2bot.io/), then you can use the following URLs: If you use [**t2bot.io**](https://t2bot.io/), then you can use the following URLs:
* `matrix://{t2bot_webhook_token}` * `matrix://{t2bot_webhook_token}`