Webhook script examples

Overview

Though Zabbix offers a large number of webhook integrations available out-of-the-box, you may want to create your own webhooks instead. This section provides examples of custom webhook scripts (used in the Script parameter). See webhook section for description of other webhook parameters.

Jira webhook (custom)

Webhook script examples - 图1

This script will create a JIRA issue and return some info on the created issue.

  1. try {
  2.            Zabbix.log(4, '[ Jira webhook ] Started with params: ' + value);
  4.            var result = {
  5.                    'tags': {
  6.                        'endpoint': 'jira'
  7.                    }
  8.                },
  9.                params = JSON.parse(value),
  10.                req = new HttpRequest(),
  11.                fields = {},
  12.                resp;
  14.            if (params.HTTPProxy) {
  15.                req.setProxy(params.HTTPProxy);
  16.            }
  18.            req.addHeader('Content-Type: application/json');
  19.            req.addHeader('Authorization: Basic ' + params.authentication);
  21.            fields.summary = params.summary;
  22.            fields.description = params.description;
  23.            fields.project = {key: params.project_key};
  24.            fields.issuetype = {id: params.issue_id};
  26.            resp = req.post('https://tsupport.zabbix.lan/rest/api/2/issue/',
  27.                JSON.stringify({"fields": fields})
  28.            );
  30.            if (req.getStatus() != 201) {
  31.                throw 'Response code: ' + req.getStatus();
  32.            }
  34.            resp = JSON.parse(resp);
  35.            result.tags.issue_id = resp.id;
  36.            result.tags.issue_key = resp.key;
  38.            return JSON.stringify(result);
  39.        }
  40.        catch (error) {
  41.            Zabbix.log(4, '[ Jira webhook ] Issue creation failed json : ' + JSON.stringify({"fields": fields}));
  42.            Zabbix.log(3, '[ Jira webhook ] issue creation failed : ' + error);
  44.            throw 'Failed with error: ' + error;
  45.        }

Slack webhook (custom)

This webhook will forward notifications from Zabbix to a Slack channel.

Webhook script examples - 图2

  1. try {
  2.            var params = JSON.parse(value),
  3.                req = new HttpRequest(),
  4.                response;
  6.            if (params.HTTPProxy) {
  7.                req.setProxy(params.HTTPProxy);
  8.            }
  10.            req.addHeader('Content-Type: application/x-www-form-urlencoded');
  12.            Zabbix.log(4, '[ Slack webhook ] Webhook request with value=' + value);
  14.            response = req.post(params.hook_url, 'payload=' + encodeURIComponent(value));
  15.            Zabbix.log(4, '[ Slack webhook ] Responded with code: ' + req.Status() + '. Response: ' + response);
  17.            try {
  18.                response = JSON.parse(response);
  19.            }
  20.            catch (error) {
  21.                if (req.getStatus() < 200 || req.getStatus() >= 300) {
  22.                    throw 'Request failed with status code ' + req.getStatus();
  23.                }
  24.                else {
  25.                    throw 'Request success, but response parsing failed.';
  26.                }
  27.            }
  29.            if (req.getStatus() !== 200 || !response.ok || response.ok === 'false') {
  30.                throw response.error;
  31.            }
  33.            return 'OK';
  34.        }
  35.        catch (error) {
  36.            Zabbix.log(3, '[ Jira webhook ] Sending failed. Error: ' + error);
  38.            throw 'Failed with error: ' + error;
  39.        }