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 2019-03-18 18:07:21 -04:00
parent d9b2ddae1d
commit bf75174d5c
1 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Notify_matrix.md

@ -4,7 +4,10 @@
* **Message Format**: Text
* **Message Limit**: 1000 Characters per message
To use this plugin, you need to first set yourself up with your own matrix synapse s
By default the notification service references the Matrix server 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.
This can be done by specifying **?webhook=matrix** or **?webhook=slack**. Presuming you've [set it up](https://github.com/nim65s/matrix-webhook).
### Syntax
Valid syntaxes are as follows:
@ -23,13 +26,19 @@ You can mix and match as many rooms as you wish:
* **!abc123** is internally interpreted as **!abc123:localhost**
* **!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:
* matrix://{user}:{token}@{hostname}?webhook=matrix
* matrix://{token}@{hostname}?webhook=matrix
* matrix://{user}:{token}@{hostname}?webhook=slack&format=markdown
* matrix://{token}@{hostname}?webhook=slack&format=markdown
### Parameter Breakdown
| Variable | Required | Description
| ----------- | -------- | -----------
| hostname | Yes | The matrix server you wish to connect to.
| user | No | The user to authenticate (and/or register) with the matrix server
| password | No | The password to authenticate (and/or register) with the matrix server
| port | No | The server port Matrix is listening on. By default **matrixs://** uses a secure port port of **8448** while **matrix://** uses port **8008**.
| port | No | The server port Matrix is listening on. By default **matrixs://** uses a secure port port of **443** while **matrix://** uses port **80**.
| 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**.