Jira

Jira is a proprietary issue tracking product developed by Atlassian which allows bug tracking and agile project management.

Available solutions




This template is for Zabbix version: 5.4
Also available for: 5.0

Source: https://git.zabbix.com/projects/ZBX/repos/zabbix/browse/templates/media/jira

Jira webhook

This guide describes how to integrate Zabbix 5.0 installation with Jira using the Zabbix webhook feature. This guide provides instructions on setting up a media type, a user and an action in Zabbix.
Please note that recovery and update operations and Jira's custom fields are supported only for trigger-based events.

Setting up webhook in Zabbix

1. Before setting up a Jira Webhook, it is recommended to setup the global macro {$ZABBIX.URL} containing an URL to the Zabbix frontend.
As an example, this macro can be used to populate Jira's custom field with URL to an event info or graph.

2. In the Administration > Media types section, import the media_jira.yaml.

3. Open the newly added Jira media type and replace all <PLACEHOLDERS> with your values.
The following parameters are required:
jira_url - actual URL of your Jira instance,
jira_user - Jira user login,
jira_password - password or API token (for Jira Cloud installations an API token can be obtained at https://id.atlassian.com/manage/api-tokens),
jira_project_key - text key of the Jira project (not to be mistaken with an ID!),
jira_issue_type - name of the issue type to be used when creating new issues from Zabbix notifications.

4. You can customize Jira issue by export information into Jira custom fields.
By default the webhook does not use Jira custom fields and {ALERT.MESSAGE} is used as an issue description.

To export information into your Jira custom field, add a parameter with custom field ID as key (if you need help finding custom field ID, see this page in Jira documentation). If at least one parameter starting with "customfield_" is configured for the media type, the webhook will use {TRIGGER.DESCRIPTION} as an issue description instead of {ALERT.MESSAGE} to avoid duplication of information in description and custom fields.
We recommend creating custom fields for all of {ALERT.MESSAGE} fields like "Host", "Link to event info", "Trigger ID", "Event date", etc.

Jira webhook supports the following custom fields types:

  • String
  • URL
  • Number
  • Datetime
  • Single-select
  • Multi-select
  • Checkbox
  • Radio button

Examples:

You can use combined parameter value as {$ZABBIX.URL}/tr_events.php?triggerid={TRIGGER.ID}&eventid={EVENT.ID} or {EVENT.DATE}T{EVENT.TIME}.

Note, that you can pass only one value for each custom field including multi-select and checkbox.

Date and time must be in ISO 8601 format with timezone of the Zabbix server (2020-01-01T23:59:59+0200). If server time is set to UTC, there is no need to add timezone at the end of parameter value.

5. Create a Zabbix user and add Media with the Jira media type. Though a "Send to" field is not used in Jira webhook, it cannot be empty. To comply with 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 converted into Jira tasks.

For more information see Zabbix and Jira documentations.

Supported Versions

Zabbix 5.0

Articles and documentation

+ Propose new article
Add your solution