mirror of https://github.com/caronc/apprise
Created Notify_matrix (markdown)
parent
a3672b0620
commit
a5e57a8aff
|
@ -0,0 +1,31 @@
|
||||||
|
## Matrix Notifications
|
||||||
|
* **Source**: https://matrix.org/
|
||||||
|
* **Icon Support**: No
|
||||||
|
* **Message Format**: Text
|
||||||
|
* **Message Limit**: 1000 Characters per message
|
||||||
|
|
||||||
|
To use this plugin, you need to first set yourself up with https://matrix.org.
|
||||||
|
|
||||||
|
### Syntax
|
||||||
|
Valid syntaxes are as follows:
|
||||||
|
* **matrix**://**{token}**
|
||||||
|
* **matrix**://**{token}**?**mode=slack**
|
||||||
|
* **matrix**://**{user}**@**{token}**?**mode=slack**
|
||||||
|
|
||||||
|
Both **matrix://** and **matrixs://** are both handled in a secure fashion.
|
||||||
|
|
||||||
|
### Parameter Breakdown
|
||||||
|
| Variable | Required | Description
|
||||||
|
| ----------- | -------- | -----------
|
||||||
|
| token | Yes | The token you would have gotten after setting up the matrix.org
|
||||||
|
| user | No | The user to associate with the webhook created on matrix.org. By default, this is set to **apprise**
|
||||||
|
| port | No | The server port Matrix is listening on. By default the port is **443**.
|
||||||
|
|
||||||
|
#### Example
|
||||||
|
Send a secure Matrix.org notification to our server
|
||||||
|
```bash
|
||||||
|
# Assuming our {token} is 3ccdd113474722377935511fc85d3dd4
|
||||||
|
# Assuming our {user} is caronc
|
||||||
|
|
||||||
|
apprise matrix://caronc@3ccdd113474722377935511fc85d3dd4
|
||||||
|
```
|
Loading…
Reference in New Issue