zabbix_export:
version: '7.0'
media_types:
-
name: ServiceNow
type: WEBHOOK
parameters:
-
name: alert_message
value: '{ALERT.MESSAGE}'
-
name: alert_subject
value: '{ALERT.SUBJECT}'
-
name: event_nseverity
value: '{EVENT.NSEVERITY}'
-
name: event_recovery_value
value: '{EVENT.RECOVERY.VALUE}'
-
name: event_source
value: '{EVENT.SOURCE}'
-
name: event_update_status
value: '{EVENT.UPDATE.STATUS}'
-
name: event_value
value: '{EVENT.VALUE}'
-
name: servicenow_password
value: '<PLACE PASSWORD HERE>'
-
name: servicenow_sys_id
value: '{EVENT.TAGS.__zbx_servicenow_sys_id}'
-
name: servicenow_url
value: '{ALERT.SENDTO}'
-
name: servicenow_user
value: '<PLACE USERNAME HERE>'
-
name: urgency_for_average
value: '2'
-
name: urgency_for_disaster
value: '1'
-
name: urgency_for_high
value: '2'
-
name: urgency_for_information
value: '3'
-
name: urgency_for_not_classified
value: '3'
-
name: urgency_for_warning
value: '3'
script: |
var ServiceNow = {
params: {},
setParams: function (params) {
if (typeof params !== 'object') {
return;
}
ServiceNow.params = params;
if (typeof ServiceNow.params.url === 'string') {
if (!ServiceNow.params.url.endsWith('/')) {
ServiceNow.params.url += '/';
}
ServiceNow.params.url += 'api/now/table/incident';
}
},
setProxy: function (HTTPProxy) {
ServiceNow.HTTPProxy = HTTPProxy;
},
setFields: function (data, fields) {
if (typeof fields === 'object' && Object.keys(fields).length) {
Object.keys(fields)
.forEach(function(field) {
data[field] = (fields[field].match(/^\d{4}\.\d{2}\.\d{2}$/) !== null)
? fields[field].replace(/\./g, '-')
: fields[field];
});
}
},
request: function (method, data) {
['url', 'user', 'password'].forEach(function (field) {
if (typeof ServiceNow.params !== 'object' || typeof ServiceNow.params[field] === 'undefined'
|| ServiceNow.params[field] === '' ) {
throw 'Required ServiceNow param is not set: "' + field + '".';
}
});
var response,
url = ServiceNow.params.url,
request = new HttpRequest();
request.addHeader('Content-Type: application/json');
request.addHeader('Authorization: Basic ' + btoa(ServiceNow.params.user + ':' + ServiceNow.params.password));
if (typeof ServiceNow.HTTPProxy !== 'undefined' && ServiceNow.HTTPProxy !== '') {
request.setProxy(ServiceNow.HTTPProxy);
}
if (typeof data !== 'undefined') {
data = JSON.stringify(data);
}
Zabbix.log(4, '[ ServiceNow Webhook ] Sending request: ' + url + ((typeof data === 'string')
? ('\n' + data)
: ''));
switch (method) {
case 'get':
response = request.get(url, data);
break;
case 'post':
response = request.post(url, data);
break;
case 'put':
response = request.put(url, data);
break;
default:
throw 'Unsupported HTTP request method: ' + method;
}
Zabbix.log(4, '[ ServiceNow Webhook ] Received response with status code ' +
request.getStatus() + '\n' + response);
if (response !== null) {
try {
response = JSON.parse(response);
}
catch (error) {
Zabbix.log(4, '[ ServiceNow Webhook ] Failed to parse response received from ServiceNow');
response = null;
}
}
if (request.getStatus() < 200 || request.getStatus() >= 300) {
var message = 'Request failed with status code ' + request.getStatus();
if (response !== null && typeof response.error.message !== 'undefined'
&& Object.keys(response.error).length > 0) {
message += ': ' + JSON.stringify(response.error.message);
}
throw message + ' Check debug log for more information.';
}
else if (typeof response.result !== 'object' || typeof response.result.sys_id === 'undefined') {
throw 'Cannot create ServiceNow incident. Check debug log for more information.';
}
return response.result;
}
};
try {
var params = JSON.parse(value),
fields = {},
servicenow = {},
data = {},
result = {tags: {}},
required_params = [
'alert_subject', 'alert_message', 'event_source', 'event_value',
'event_update_status', 'event_recovery_value', 'event_nseverity'
],
severities = [
{name: 'not_classified', color: '#97AAB3'},
{name: 'information', color: '#7499FF'},
{name: 'warning', color: '#FFC859'},
{name: 'average', color: '#FFA059'},
{name: 'high', color: '#E97659'},
{name: 'disaster', color: '#E45959'},
{name: 'resolved', color: '#009900'},
{name: 'default', color: '#000000'}
],
method = 'post',
process_tags = true;
Object.keys(params)
.forEach(function (key) {
if (key.startsWith('servicenow_')) {
servicenow[key.substring(11)] = params[key];
}
else if (key.startsWith('u_')) {
fields[key] = params[key];
}
else if (required_params.indexOf(key) !== -1 && params[key] === '') {
throw 'Parameter "' + key + '" can\'t be empty.';
}
});
if ([0, 1, 2, 3].indexOf(parseInt(params.event_source)) === -1) {
throw 'Incorrect "event_source" parameter given: ' + params.event_source + '\nMust be 0-3.';
}
if ([0, 1, 2, 3, 4, 5].indexOf(parseInt(params.event_nseverity)) === -1) {
params.event_nseverity = '7';
}
// Check {EVENT.VALUE} for trigger-based and internal events.
if (params.event_value !== '0' && params.event_value !== '1'
&& (params.event_source === '0' || params.event_source === '3')) {
throw 'Incorrect "event_value" parameter given: ' + params.event_value + '\nMust be 0 or 1.';
}
// Check {EVENT.UPDATE.STATUS} only for trigger-based events.
if (params.event_update_status !== '0' && params.event_update_status !== '1' && params.event_source === '0') {
throw 'Incorrect "event_update_status" parameter given: ' + params.event_update_status + '\nMust be 0 or 1.';
}
if (params.event_source !== '0' && params.event_recovery_value === '0') {
throw 'Recovery operations are supported only for trigger-based actions.';
}
data.short_description = params.alert_subject;
data.description = params.alert_message;
data.comments = params.alert_message;
if (typeof params['urgency_for_' + severities[params.event_nseverity].name] !== 'undefined') {
data.urgency = params['urgency_for_' + severities[params.event_nseverity].name];
}
ServiceNow.setParams(servicenow);
ServiceNow.setProxy(params.HTTPProxy);
ServiceNow.setFields(data, fields);
if (params.event_source === '0' && (params.event_value === '0' || params.event_update_status === '1')) {
process_tags = false;
method = 'put';
delete data.description;
delete data.urgency;
ServiceNow.params.url += '/' + params.servicenow_sys_id;
}
var response = ServiceNow.request(method, data);
if (process_tags) {
result.tags.__zbx_servicenow_sys_id = response.sys_id;
result.tags.__zbx_servicenow_link = params.servicenow_url +
(params.servicenow_url.endsWith('/') ? '' : '/') + 'incident.do?sys_id=' + response.sys_id;
result.tags.__zbx_servicenow_number = response.number;
}
return JSON.stringify(result);
}
catch (error) {
Zabbix.log(3, '[ ServiceNow Webhook ] ERROR: ' + error);
throw 'Sending failed: ' + error;
}
process_tags: 'YES'
show_event_menu: 'YES'
event_menu_url: '{EVENT.TAGS.__zbx_servicenow_link}'
event_menu_name: 'ServiceNow: {EVENT.TAGS.__zbx_servicenow_number}'
message_templates:
-
event_source: TRIGGERS
operation_mode: PROBLEM
subject: '[{EVENT.STATUS}] {EVENT.NAME}'
message: |
Problem started at {EVENT.TIME} on {EVENT.DATE}
Problem name: {EVENT.NAME}
Host: {HOST.NAME}
Severity: {EVENT.SEVERITY}
Operational data: {EVENT.OPDATA}
Original problem ID: {EVENT.ID}
{TRIGGER.URL}
-
event_source: TRIGGERS
operation_mode: RECOVERY
subject: '[{EVENT.STATUS}] {EVENT.NAME}'
message: |
Problem has been resolved in {EVENT.DURATION} at {EVENT.RECOVERY.TIME} on {EVENT.RECOVERY.DATE}
Problem name: {EVENT.NAME}
Host: {HOST.NAME}
Severity: {EVENT.SEVERITY}
Original problem ID: {EVENT.ID}
{TRIGGER.URL}
-
event_source: TRIGGERS
operation_mode: UPDATE
subject: '[{EVENT.STATUS}] {EVENT.NAME}'
message: |
{USER.FULLNAME} {EVENT.UPDATE.ACTION} problem at {EVENT.UPDATE.DATE} {EVENT.UPDATE.TIME}.
{EVENT.UPDATE.MESSAGE}
Current problem status is {EVENT.STATUS}, acknowledged: {EVENT.ACK.STATUS}.
-
event_source: DISCOVERY
operation_mode: PROBLEM
subject: 'Discovery: {DISCOVERY.DEVICE.STATUS} {DISCOVERY.DEVICE.IPADDRESS}'
message: |
Discovery rule: {DISCOVERY.RULE.NAME}
Device IP: {DISCOVERY.DEVICE.IPADDRESS}
Device DNS: {DISCOVERY.DEVICE.DNS}
Device status: {DISCOVERY.DEVICE.STATUS}
Device uptime: {DISCOVERY.DEVICE.UPTIME}
Device service name: {DISCOVERY.SERVICE.NAME}
Device service port: {DISCOVERY.SERVICE.PORT}
Device service status: {DISCOVERY.SERVICE.STATUS}
Device service uptime: {DISCOVERY.SERVICE.UPTIME}
-
event_source: AUTOREGISTRATION
operation_mode: PROBLEM
subject: 'Autoregistration: {HOST.HOST}'
message: |
Host name: {HOST.HOST}
Host IP: {HOST.IP}
Agent port: {HOST.PORT}