github
/
apprise
mirror of https://github.com/caronc/apprise
1
0
Fork 0
Code Issues Releases Wiki Activity

Updated Notify_mattermost (markdown)

master
Chris Caron 2019-05-20 18:12:35 -04:00
parent 3cdd44294d
commit 1347611d11
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Notify_mattermost.md

@ -8,10 +8,14 @@ To use this plugin, you need to first set yourself up with http://mattermost.com
### Syntax ### Syntax
Valid syntaxes are as follows: Valid syntaxes are as follows:
* **mmost**://**{hostname}**/**{webhook_id}** * **mmost**://**{hostname}**/**{authtoken}**
* **mmost**://**{hostname}**:**{port}**/**{webhook_id}** * **mmost**://**{hostname}**:**{port}**/**{authtoken}**
* **mmost**://**{botname}**@**{hostname}**/**{authtoken}**
* **mmost**://**{botname}**@**{hostname}**:**{port}**/**{authtoken}**
* **mmosts**://**{hostname}**/**{webhook_id}** * **mmosts**://**{hostname}**/**{webhook_id}**
* **mmosts**://**{hostname}**:**{port}**/**{webhook_id}** * **mmosts**://**{hostname}**:**{port}**/**{authtoken}**
* **mmosts**://**{botname}**@**{hostname}**/**{webhook_id}**
* **mmosts**://**{botname}**@**{hostname}**:**{port}**/**{authtoken}**
Secure connections (via https) should be referenced using **mmosts://** where as insecure connections (via http) should be referenced via **mmost://**. Secure connections (via https) should be referenced using **mmosts://** where as insecure connections (via http) should be referenced via **mmost://**.
@ -19,14 +23,15 @@ Secure connections (via https) should be referenced using **mmosts://** where as
| Variable | Required | Description | Variable | Required | Description
| ----------- | -------- | ----------- | ----------- | -------- | -----------
| hostname | Yes | The server Mattermost is listening on. | hostname | Yes | The server Mattermost is listening on.
| webhook_id | Yes | The WebHook ID you would have gotten after setting up the Mattermost server | authtoken | Yes | The Authentication Toekn (the WebHook ID) you would have gotten after setting up the Mattermost server
| port | No | The server port Mattermost is listening on. By default the port is **8065**. | port | No | The server port Mattermost is listening on. By default the port is **8065**.
| botname | No | An optional botname you can associate with your post
#### Example #### Example
Send a secure Mattermost notification to our server Send a secure Mattermost notification to our server
```bash ```bash
# Assuming our {hostname} is mattermost.server.local # Assuming our {hostname} is mattermost.server.local
# Assuming our {webhook_id} is 3ccdd113474722377935511fc85d3dd4 # Assuming our {authtoken} is 3ccdd113474722377935511fc85d3dd4
apprise mmosts://mattermost.server.local/3ccdd113474722377935511fc85d3dd4 apprise mmosts://mattermost.server.local/3ccdd113474722377935511fc85d3dd4
``` ```