Integrate Catchpoint events

Integrate Catchpoint with Event Management by adding an alert webhook in the Catchpoint platform.

Before you begin

Ensure that the Event Management Connectors (sn_em_connector) plugin is installed on the ServiceNow AI Platform instance.

Role required: evt_mgmt_admin

About this task

Configure the Event Management environment for the collection of events from Catchpoint by authenticating Catchpoint as a data source. In the Catchpoint platform, set your ServiceNow AI Platform as the rest endpoint using a webhook.

Procedure

1. In the Catchpoint platform, create an alert webhook destination.
   1. Login to the Catchpoint platform.
   2. Navigate to Catchpoint > Setting > API > Alert Data Webhook to set the webhook endpoint.
   3. In the API Alert Webhook, provide the following details.

      Table 1. API Alert Webhook form

      Field	Value
      Name	Any name based on your requirement.
      URL	The default format of the URL to push events from Catch Point to the ServiceNow AI Platform instance, https://<username>:<password>@<instance-name>.service-now.com/api/sn_em_connector/em/inbound_event?source=catchpoint.
      On Failure Alert	The email address for the API Alert webhook.
      Notification Trigger	Select based on your requirement. The default value is 3.
      Add the following headers	Authorization: Basic {Base 64 | username:password} Content-Type: application/json
      Format	Select Template and add the following template: { "Source": "CatchPoint", "severity": "${notificationLevelId}", "alertType": "${AlertType}", "time_of_event": "${alertCreateDateUtc(YYYY-MM-DD HH:MI:SS)}", "monitorType": "${Switch(${MonitorTypeId},'0', 'IE','2', 'Object','3','Emulated','8', 'Ping','9', 'Tracert','10', 'DNS-Traversal','11', 'Ping-TCP','12', 'DNS-Exp', '13','DNS-Direct', '14','Tracert-UDP', '15', 'Port-TCP','16', 'FTP','17', 'Data-Push-API','18', 'Chrome','19', 'Playback', '20', 'Playback-Mobile', '21', 'SMTP', '22', 'Port-UDP', '23', 'Ping-UDP', '24', 'Streaming', '25', 'API', '26', 'Mobile', '27', 'SFTP', '28', 'SSH', '29', 'Tracert-TCP')}", "testName": "${TestName}", "testId": "${TestId}", "testUrl": "${TestUrl}", "testPath": "${testPath}", "testLink": "${testLink}", "productName": "${ProductName}", "clientId": "${ClientId}", "productId": "${productId}", "nodeName":"${nodeDetails("${nodeName}")}", "nodeClientServerAddress":"${nodeDetails(\"${NodeClientAddress},\"),}", "nodeServerAddress": "${nodeDetails(\"${nodeServerAddress},\"),}", "Labels" : "${testLabels}", "addtionalInformation": "Test initial URL: ${testUrl}\n\nAlert type: ${AlertType}\n\nScatter Chart: ${scatterplotChartURL}\n\nWaterfall Chart: ${waterfallChartURL}\n\nTest properties: ${testLink}\n\nTest time of run / Test time of alert (Central Time): ${reportDateLocal(YYYY-MM-DD HH:MI:SS)} / ${alertCreateDateLocal(YYYY-MM-DD HH:MI:SS)}"}

2. For the HTTP Endpoint monitoring tests, in the ServiceNow instance, create a CI.
   Note:

   The Catchpoint connector supports multiple types of monitoring tests such as Endpoint, Networking, and others. The following steps apply only to the HTTP Endpoint monitoring tests.
   1. Navigate to Configuration > CI Class Manager.
   2. Click Hierarchy and search for HTTP(S) Endpoint.
   3. In the CI Type field, select cmdb_ci_endpoint_http.
   If the services are not modeled, then you should manually add the CIs under the [cmdb_ci_endpoint_http] table. Also, the manual endpoint should be removed before the automatic discovery of services. For other type tests CI bindings, you can create Event rules based on their requirements.

Result

Alerts start flowing from the Catchpoint connector into the Event Management plugin. The following table shows how the Catchpoint severity mapping translates into the ServiceNow mapping.

Table 2. Severity levels between Catchpoint and ServiceNow

Catchpoint severity	ServiceNow severity
0	Warning
1	Critical
2/3	Clear