Mattermost Notifications
Account Setup
Section titled “Account Setup”To use this plugin, you need to first set yourself up with http://mattermost.com. Download their software and set it up.
From here you’ll need an *Incoming Webhook. This can be done as follows:
- Click on the Integrations option under the channel dropdown and select Incoming Webhook:
- From here you can select Add Incoming Webhook:
- Finally you’ll be able to customize how you want the webhook to act/behave and you can press Save at the bottom when you’re complete.
An example URL you may be provided could look like this:
# The URL provided by Mattermost:http://localhost:8065/hooks/yokkutpah3r3urc5h6i969yima ^ ^ ^ | | | hostname port webhook token
# From here you can do the following to generate your Apprise URL:# - http:// becomes mmost://# - drop /hooks reference# Which gets you:mmost://localhost:8065/yokkutpah3r3urc5h6i969yimaSyntax
Section titled “Syntax”Valid syntax is as follows:
mmost://{hostname}/{token}mmost://{hostname}:{port}/{token}mmost://{botname}@{hostname}/{token}mmost://{botname}@{hostname}:{port}/{token}mmost://{hostname}/{path}/{token}mmost://{hostname}:{port}/{path}/{token}mmost://{botname}@{hostname}/{path}/{token}mmost://{botname}@{hostname}:{port}/{path}/{token}
Secure connections (via https) should be referenced using mmosts:// where as insecure connections (via http) should be referenced via mmost://; they follow the same structure:
mmosts://{hostname}/{token}mmosts://{hostname}:{port}/{token}mmosts://{botname}@{hostname}/{token}mmosts://{botname}@{hostname}:{port}/{token}mmosts://{hostname}/{path}/{token}mmosts://{hostname}:{port}/{path}/{token}mmosts://{botname}@{hostname}/{path}/{token}mmosts://{botname}@{hostname}:{port}/{path}/{token}
Parameter Breakdown
Section titled “Parameter Breakdown”| Variable | Required | Description |
|---|---|---|
| hostname | Yes | The server Mattermost is listening on. |
| token | Yes | The Webhook Token you would have received after setting up the Mattermost Incoming Webhook |
| 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 token. |
| botname | No | An optional botname you can associate with your post |
| image | No | Identify whether or not you want the Apprise image (showing status color) to display with every message or not. By default this is set to yes. |
| channels | No | You can optionally specify as many channels as you want in a comma separated value (as a keyword argument). See example below for how to use this. You must also not restrict your Incoming Webhook to only focus on a specific channel or providing alternatives here will not work. |
Global Parameters
Section titled “Global Parameters”| Variable | Description |
|---|---|
| overflow | This parameter can be set to either split, truncate, or upstream. This determines how Apprise delivers the message you pass it. By default this is set to upstream 👉 upstream: Do nothing at all; pass the message exactly as you received it to the service.👉 truncate: Ensure that the message will fit within the service’s documented upstream message limit. If more information was passed then the defined limit, the overhead information is truncated.👉 split: similar to truncate except if the message doesn’t fit within the service’s documented upstream message limit, it is split into smaller chunks and they are all delivered sequentially there-after. |
| format | This parameter can be set to either text, html, or markdown. Some services support the ability to post content by several different means. The default of this varies (it can be one of the 3 mentioned at any time depending on which service you choose). You can optionally force this setting to stray from the defaults if you wish. If the service doesn’t support different types of transmission formats, then this field is ignored. |
| verify | External requests made to secure locations (such as through the use of https) will have certificates associated with them. By default, Apprise will verify that these certificates are valid; if they are not then no notification will be sent to the source. In some occasions, a user might not have a certificate authority to verify the key against or they trust the source; in this case you will want to set this flag to no. By default it is set to yes. |
| cto | This stands for Socket Connect Timeout. This is the number of seconds Requests will wait for your client to establish a connection to a remote machine (corresponding to the connect()) call on the socket. The default value is 4.0 seconds. |
| rto | This stands for Socket Read Timeout. This is the number of seconds the client will wait for the server to send a response. The default value is 4.0 seconds. |
| emojis | Enable Emoji support (such as providing :+1: would translate to 👍). By default this is set to no. Note: Depending on server side settings, the administrator has the power to disable emoji support at a global level; but default this is not the case. |
| tz | Identify the IANA Time Zone Database you wish to operate as. By default this is detected based on the configuration the server hosting Apprise is running on. You can set this to things like America/Toronto, or any other properly formated Timezone describing your area. |
Examples
Section titled “Examples”Send a secure Mattermost notification to our server
# Assuming our {hostname} is mattermost.server.local# Assuming our {token} is 3ccdd113474722377935511fc85d3dd4
apprise -vv -t "Test Message Title" -b "Test Message Body" \ mmosts://mattermost.server.local/3ccdd113474722377935511fc85d3dd4Send a secure Mattermost notification to our server running on TCP Port 8065
# Assuming our {hostname} is mattermost.server.local# Assuming our secure {port} our server is running on is 8065# Assuming our {token} is 3ccdd113474722377935511fc85d3dd4
apprise -vv -t "Test Message Title" -b "Test Message Body" \ mmosts://mattermost.server.local:8065/3ccdd113474722377935511fc85d3dd4Send an insecure Mattermost notification to server in addition to having to address specific channels:
# Assuming our {hostname} is mattermost.server.local# Assuming our {token} is 3ccdd113474722377935511fc85d3dd4# Assuming our {channels} is #support and #general
# We don't need to provide the '#' (hashtag) prefix:apprise -vv -t "Test Message Title" -b "Test Message Body" \ mmost://mattermost.server.local/3ccdd113474722377935511fc85d3dd4?channels=support,general