Mattermost Integration with Zabbix

This guide describes how to integrate Zabbix 4.4 with Mattermost using the Zabbix Webhook feature and provides instructions on setting up a media type, a user and an action in Zabbix.

Setting up a Mattermost bot

From the Mattermost Main menu, select Integrations > Bot Accounts.

Mattermost Integrations

Click on the Add Bot Account button, fill in the required fields, enable permissions for post:all and post:channels and click Create Bot Account.

Creating Bot Account

After the Bot Account is created, it is given an Access Token.

Note. An Access Token is only displayed at the creation step so you need to copy and save it.

You can always create a new access token with an arbitrary description. To do that, on the Bot Accounts page find your Zabbix Bot Account, click Delete > Create New Token, type a new token description in the Token Description field, and press Save.

New Access Token

Note. You need to copy your new access token as well, as you won’t see it again.

Add a Bot Account to your Team so that it can send messages to the team channels. To do this, in the Main Menu click Invite People, find your team in the Invite People field, and press Invite Members.

Adding Bot Account to your Team

The bot can already send messages to listed public channels and user channels (direct messages). To send a message to a private channel, you need to add it as a member.

Adding new members to a private channel

Zabbix Webhook configuration

Now you need to go to the Zabbix web interface to configure the Webhook.

Before setting up the Webhook, you need to set up the global macro {$ZABBIX.URL}, which must contain the URL to the Zabbix frontend. To do that, go Administration > General > Macros and click Add. Define the global macro in the new Macro field and your Zabbix frontend location in the Value field.

Global macro

In the Administration > Media types, press Import > Choose file to import the media_mattermost.xml.

Import

All necessary files are stored in the Zabbix repository with a link to it available on the official Zabbix integration page at www.zabbix.com/integrations/, where you can search Mattermost by name.

Mattermost Webhook link

Mattermost media file

In Administration > Media types, 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.

Mattermost frontend URL

You can also choose between two notification modes in the send_mode field: alarm or event.

Configuration of media types

Note. In the alarm (default) notification mode, update messages will be attached as replies to Slack message thread and recovery message from Zabbix will update the initial message. In the event notification mode, recovery and update messages from Zabbix will be posted as new messages.

Click the Update button to save the Webhook settings.

To receive notifications in Mattermost, you need to create a Zabbix user and then add Media with the Mattermost type.

To do that, go to Administration > Users and press Create user. Type ‘Mattermost alerter‘ in the Alias field and select ‘Zabbix administrators‘ in the Groups field. Then you need to set up a password.

Creating Zabbix user

In the Media section, you need to fill in the Send to field.

Send to field

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;
• Channel identifier.

You can copy the channel identifier from the channel properties:

Channel identifier information

After adding the new user, you will need to configure actions to receive alerts in Mattermost. To do that, go to Monitoring > Problems > Update problem and check Close problem. Press Update and then Apply.

Updating problem status

After that, you can check Mattermost messages status in Monitoring > Problems section,

Mattermost message status in Zabbix

as well as in the Zabbix-private section in the Mattermost frontend.

That’s all for today. You are welcome to like, comment, and subscribe.

About Anton Fayantsev

Integration Engineer at Zabbix

View all posts by Anton Fayantsev