yzl
93958d0fb0
|
1 year ago | |
---|---|---|
.. | ||
images | 1 year ago | |
README.md | 1 year ago | |
media_msteams.yaml | 1 year ago |
README.md
Microsoft Teams webhook
This guide describes how to integrate Zabbix 7.0 with MS Teams using the Zabbix webhook feature. This guide will provide instructions on setting up a media type, a user and an action in Zabbix. This integration is supported only for Teams as part of Office 365. Note, that Teams free plan does not support incoming webhook feature.
Setting up webhook in MS Teams
Microsoft Teams webhook only supports integrating with a single channel.
First, you need to get a webhook URL for the channel. There are two ways to do this:
-
Add official Zabbix webhook connector from MS Teams apps for the channel, where you want to receive notifications. (Check how to add a connector to a channel)
-
Create Incoming webhook for your channel. (See Teams documentation for the step-by-step instructions).
Setting up webhook in Zabbix
1. In the Zabbix web interface go to Administration → General section and select Macros from the dropdown menu in top left corner. Setup the global macro "{$ZABBIX.URL}" which will contain the URL to the Zabbix frontend.
The URL should be either an IP address, a fully qualified domain name or localhost. Specifying a protocol is mandatory, whereas port is optional.
Good examples:
http://zabbix.com
https://zabbix.lan/
http://server.zabbix.lan/
http://localhost
http://127.0.0.1:8080
Bad examples:
zabbix.com
http://zabbix/
2. In the Administration > Media types section, import the media_ms_teams.yaml
3. Open the newly added MS Teams media type and replace placeholder <PLACE WEBHOOK URL HERE> with the incoming webhook URL, created during the webhook setup in MS Teams.
4. You can also choose between two notification formats. Set "use_default_message" parameter:
-
false (default)
- Use preformatted message with predefined set of fields for trigger-based notifications.
In internal, autoregistration and discovery notifications {ALERT.MESSAGE} as a body of the message will be used. In this case you can customize the message template for trigger-based notifications by adding additional fields and up to four buttons with URLs.- To add an additional field to message card, put a parameter with prefix fact_ and field name. For example, "fact_Data center" as key and {EVENT.TAGS.dc} as value.
- To create a new button with a link to an external resource, add a parameter with prefix openUri_ and button name. The value should be a valid URL. For example, "openUri_Link to Zabbix.com" as key and https://www.zabbix.com/ as value.
If any of the parameters with prefix openUri_ has invalid URL it will be ignored by Teams.
Also, since Microsoft only supports five buttons in a message card, one of which is reserved for the "Event info" link, the fifth and subsequent parameters with prefix openUri_ and valid URL will be ignored too.
- Use preformatted message with predefined set of fields for trigger-based notifications.
-
true
- Use {ALERT.MESSAGE} as a body of the message in all types of notifications.
5. To receive Zabbix notifications in MS Teams, you need to create a Zabbix user and add Media with the MS Teams media type.
In the Administration → Users section, click Create user button in the top right corner. In the User tab, fill in all required fields (marked with red asterisks). In the Media tab, add a new media and select "MS Teams" type from the drop-down list. Though a "Send to" field is not used in MS Teams media, it cannot be empty. To comply with the frontend requirements, you can put any symbol there.
Make sure this user has access to all hosts for which you would like problem notifications to be sent to MS Teams.
6. Great! You can now start receiving alerts!
For more information see Zabbix and MS Teams webhook documentations.
Supported Versions
Zabbix 7.0