Notify_mattermost

Mattermost Notifications

• Source: https://mattermost.com/
• Icon Support: Yes
• 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 Authentication Token (WebHook ID).

Syntax

Valid syntaxes are as follows:

• mmost://{hostname}/{authtoken}
• mmost://{hostname}:{port}/{authtoken}
• mmost://{botname}@{hostname}/{authtoken}
• mmost://{botname}@{hostname}:{port}/{authtoken}
• mmosts://{hostname}/{authtoken}
• mmosts://{hostname}:{port}/{authtoken}
• mmosts://{botname}@{hostname}/{authtoken}
• mmosts://{botname}@{hostname}:{port}/{authtoken}
• mmosts://{hostname}/{path}/{authtoken}
• mmosts://{hostname}:{port}/{path}/{authtoken}
• mmosts://{botname}@{hostname}/{path}/{authtoken}
• mmosts://{botname}@{hostname}:{port}/{path}/{authtoken}

Secure connections (via https) should be referenced using mmosts:// where as insecure connections (via http) should be referenced via mmost://.

Parameter Breakdown

Variable	Required	Description
hostname	Yes	The server Mattermost is listening on.
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.
path	No	You can identify a sub-path if you wish. The last element of the path must be the authtoken.
botname	No	An optional botname you can associate with your post

Example

Send a secure Mattermost notification to our server

# Assuming our {hostname} is mattermost.server.local
# Assuming our {authtoken} is 3ccdd113474722377935511fc85d3dd4

apprise -vv -t "Test Message Title" -b "Test Message Body" \
   mmosts://mattermost.server.local/3ccdd113474722377935511fc85d3dd4