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:23:49 -04:00
parent 1347611d11
commit 2b348d3352
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Notify_mattermost.md

@ -4,7 +4,7 @@
* **Message Format**: Text
* **Message Limit**: 4000 Characters per message
To use this plugin, you need to first set yourself up with http://mattermost.com. Download their software and set it up. The setup is based on Incoming Web Hooks requiring you to generate your own WebHook ID.
To use this plugin, you need to first set yourself up with http://mattermost.com. Download their software and set it up. The setup is based on Incoming Web Hooks requiring you to generate your own Authentication Token (WebHook ID).
### Syntax
Valid syntaxes are as follows:
@ -12,9 +12,9 @@ Valid syntaxes are as follows:
* **mmost**://**{hostname}**:**{port}**/**{authtoken}**
* **mmost**://**{botname}**@**{hostname}**/**{authtoken}**
* **mmost**://**{botname}**@**{hostname}**:**{port}**/**{authtoken}**
* **mmosts**://**{hostname}**/**{webhook_id}**
* **mmosts**://**{hostname}**/**{authtoken}**
* **mmosts**://**{hostname}**:**{port}**/**{authtoken}**
* **mmosts**://**{botname}**@**{hostname}**/**{webhook_id}**
* **mmosts**://**{botname}**@**{hostname}**/**{authtoken}**
* **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://**.
@ -23,7 +23,7 @@ Secure connections (via https) should be referenced using **mmosts://** where as
| Variable | Required | Description
| ----------- | -------- | -----------
| hostname | Yes | The server Mattermost is listening on.
| authtoken | Yes | The Authentication Toekn (the WebHook ID) you would have gotten after setting up the Mattermost server
| authtoken | Yes | The Authentication Token (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**.
| botname | No | An optional botname you can associate with your post