You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
89 lines
3.7 KiB
89 lines
3.7 KiB
1 year ago
|
|
||
|
|
# Mattermost webhook
|
||
|
|
|
||
|
|
|
||
|
|
This guide describes how to integrate your Zabbix 7.0 installation with Mattermost using the Zabbix webhook feature. This guide will provide instructions on setting up a media type, a user and an action in Zabbix.
|
||
|
|
|
||
|
|
## Setting up a Mattermost bot
|
||
|
|
|
||
|
|
1\. From the **Main menu** of your Mattermost installation, select **Integrations** and click on the **Bot accounts** block.
|
||
|
|
|
||
|
|
[](images/32.png)
|
||
|
|
[](images/31.png)
|
||
|
|
|
||
|
|
2\. Click on the **Add Bot Account** button and fill in the required fields and enable permissions for **post:all** and **post:channels**.
|
||
|
|
|
||
|
|
[](images/30.png)
|
||
|
|
[](images/29.png)
|
||
|
|
[](images/27.png)
|
||
|
|
|
||
|
|
3\. The bot account is created and given an **Access Token** that you need to save. It will not be displayed later.
|
||
|
|
|
||
|
|
[](images/26.png)
|
||
|
|
[](images/25.png)
|
||
|
|
|
||
|
|
* You can always create a new access token with an arbitrary description, but remember that it is only displayed at the creation step.
|
||
|
|
|
||
|
|
[](images/22.png)
|
||
|
|
[](images/23.png)
|
||
|
|
|
||
|
|
4\. Add a **Bot Account** to your **Team** so that it can send messages to the team channels. To do this, click **Invite People** from the **Main menu**.
|
||
|
|
|
||
|
|
[](images/20.png)
|
||
|
|
[](images/19.png)
|
||
|
|
|
||
|
|
5\. The bot can already send messages to **public channels** and **user channels** (direct messages). To send it to a **private channel**, add it as a member.
|
||
|
|
|
||
|
|
[](images/14.png)
|
||
|
|
[](images/13.png)
|
||
|
|
|
||
|
|
|
||
|
|
## Zabbix Webhook configuration
|
||
|
|
|
||
|
|
### Create a global macro
|
||
|
|
|
||
|
|
1\. Before setting up the **Webhook**, you need to setup the global macro **{$ZABBIX.URL}**, which must contain the **URL** to the **Zabbix frontend**.
|
||
|
|
|
||
|
|
[](images/10.png)
|
||
|
|
|
||
|
|
2\. In the **Administration** > **Media types** section, import the [media_mattermost.yaml](media_mattermost.yaml)
|
||
|
|
|
||
|
|
3\. Open the added **Mattermost** media type and set **bot_token** to the previously created token and **mattermost_url** to the **frontend URL** of your **Mattermost** installation.
|
||
|
|
|
||
|
|
[](images/9.png)
|
||
|
|
|
||
|
|
* You can also choose between two notification modes:
|
||
|
|
- **alarm** (default)
|
||
|
|
- Update messages will be attached as replies to Mattermost message thread
|
||
|
|
- Recovery message from Zabbix will update initial message
|
||
|
|
- **event**
|
||
|
|
- Recovery and update messages from Zabbix will be posted as new messages
|
||
|
|
|
||
|
|
|
||
|
|
4\. Click the **Update** button to save the **Webhook** settings.
|
||
|
|
|
||
|
|
5\. To receive notifications in **Mattermost**, you need to create a **Zabbix user** and add **Media** with the **Mattermost** type.
|
||
|
|
|
||
|
|
[](images/8.png)
|
||
|
|
|
||
|
|
The **Send to** field can contain several variants of values:
|
||
|
|
|
||
|
|
- Channel name in **`team_name/#channel_name`** format
|
||
|
|
- Channel name in **`team_name/@user_name`** format for direct messages
|
||
|
|
- Identifier of the channel (for example: **fqzj8ysn8frxu8m9hcjna5uqmc**)
|
||
|
|
|
||
|
|
[](images/2.png)
|
||
|
|
[](images/1.png)
|
||
|
|
[](images/5.png)
|
||
|
|
|
||
|
|
You can view the channel identifier in the channel properties.
|
||
|
|
|
||
|
|
[](images/7.png)
|
||
|
|
[](images/6.png)
|
||
|
|
|
||
|
|
For more information, use the [Zabbix](https://www.zabbix.com/documentation/7.0/manual/config/notifications) and [Mattermost](https://docs.mattermost.com) documentations.
|
||
|
|
|
||
|
|
## Supported Versions
|
||
|
|
|
||
|
|
Zabbix 7.0
|