Integrate with push connectors

Integrate with a push connector to connect to an external event source. Push connectors process the collected event messages and transform them to the required event format.

Before you begin

Ensure that the Event Management Connectors (sn_em_connector) plugin is installed.

Role required: evt_mgmt_admin

Note: If you are upgrading a ServiceNow AI Platform instance from Paris or earlier, you can use legacy listener transform scripts. See Use legacy listener transform scripts for further information.

About this task

The push connectors accept event messages that are generated by external event sources.

Configure a connector to listen to an external event source. Using a custom push connector, send the event messages through either the MID Server or the instance.

Note: You can use this generic JSON target URL to collect events:https:/<<INSTANCE>>/api/sn_em_connector/em/inbound_event?source=genericJson. This URL can be used as-is and requires that an event rule be configured.

Procedure

1. Navigate to All > Event Management > Integrations > Push Connectors.

2. Click New or click the push connector that you want to modify, for example, AWS or Azure.

3. On the form, fill in the fields.

1. In the Script section:

   • If the value selected for the Type field is MID, the Transform script field appears. In this field, specify or search for the name of the MID script include that accepts event messages that the required external event source generates and that the script parses into the required event format. Use this naming convention for the script: TransformEvents_<your source>
   • If the value selected for the Type field is Instance, the Script editor appears. In the Script editor, enter the customized script that accepts event messages that the required external event source generates and that the script parses into the required event format. This example shows the fields that have been transformed, being added to an event form.

   (function process(/*RESTAPIRequest*/ request, body) {
       /*Function that receives a JSON object, adding all its fields to the Additional information object. The field name is a concatenation of the field key and the parent field key if it exists.*/
       function updateAdditionalInfo(event, field,jsonObject,additionalInfo) {
           for (var key in jsonObject) {
               var newKey = key;
               if (field != "") {
                   newKey = field + '_' + key;
               }
               // You can do some transformation here and set fields on the event
               //if(key == "MySource")
               //   event.source = jsonObject[key];
               additionalInfo[newKey] = jsonObject[key];
           }
       }
   
       try
       {       
           gs.info("TransformEvents_generic received body:" + body);
           var jsonObject = JSON.parse(body);
           var event = new GlideRecord('em_event');
           event.source = "GenericJson"; //TODO: Need to define
           event.event_class = "GenericJsonClass"; //TODO: Need to define
           event.severity = "5";
   
           var additionalInfo = {};
           updateAdditionalInfo(event, "",jsonObject,additionalInfo);
           /*Iterates over Additional information JSON object and adds all nested objects' fields as fields of the Additional information object*/
           var notDone = true;
           while (notDone) {
               notDone = false;
               for (var key in additionalInfo) {
                   if (Object.prototype.toString.call(additionalInfo[key]) == '[object Object]') {
                       notDone = true;
                       updateAdditionalInfo(event, key,additionalInfo[key],additionalInfo);
                       additionalInfo[key] = "";
                   }
               }
           }
           gs.info("TransformEvents_generic generated additional information:" + JSON.stringify(additionalInfo));
           event.additional_info = JSON.stringify(additionalInfo);
           event.insert();
       }
       catch(er){
           gs.error(er);
           status=500;
           return er;
       }
       return "success";
   })(request, body);
   

2. Use legacy listener transform scripts
   Use legacy listener transform scripts when upgrading a ServiceNow AI Platform instance from Paris or earlier. These scripts can be run as part of existing integrated systems, or in unison with Event Management push connectors.

3. Integrate AWS platform as a data source
   Integrate Amazon Web Services (AWS) with Event Management. To add AWS platform as a data source, configuration is required in the AWS platform.
4. Integrate Azure Monitor as an authenticated data source
   Integrate Microsoft Azure with Event Management by adding the Azure Monitor as an authenticated data source.
5. Event collection from Microsoft Azure Monitor
   The MID WebServer Event Collector enables you to collect JSON formatted event messages sent from the Microsoft Azure portal.
6. Event collection from BMC TrueSight and BMC TrueSight_v2
   The MID WebService Event Collector enables you to collect JSON formatted event messages sent from BMC TrueSight Operations Management (TrueSight), previously known as BMC ProactiveNet Performance Management (BPPM), utilizing event stream notification capabilities.
7. Metric collection from OpenTelemetry (Otel) metrics
   The MID WebService metric Collector enables you to collect JSON and protobuf formatted metrics sent from OpenTelemetry (Otel).
8. Integrate New Relic platform events
   Integrate New Relic with Event Management by adding a standard webhook in the New Relic old and new consoles.
9. Integrate Catchpoint events
   Integrate Catchpoint with Event Management by adding an alert webhook in the Catchpoint platform.
10. Integrate Google Cloud Platform (GCP) events
    Integrate Google Cloud Platform (GCP) with Event Management by adding a standard webhook in the GCP console.
11. Event collection from Google Cloud Platform (GCP)
    The MID WebService Event Collector enables you to collect JSON formatted event messages sent from Google Cloud Platform (GCP).
12. Integrate Grafana events
    Integrate Grafana with Event Management by adding Grafana as an authenticated data source.
13. Integrate Honeycomb events
    Integrate Honeycomb with Event Management by creating a webhook and configuring it as a trigger in the Honeycomb platform.
14. Integrate Instana events
    Integrate Instana with Event Management by adding Instana as an authenticated data source.
15. Integrate ServiceNow Cloud Observability Events
    Integrate ServiceNow Cloud Observability with Event Management by adding a standard webhook in the ServiceNow Cloud Observability platform. Download the Event Management Connector plugin from the ServiceNow Store so you can integrate with ServiceNow Cloud Observability.
16. Integrate Logicmonitor events
    Integrate Logicmonitor with Event Management to send events into ServiceNow by adding a webhook using Basic Authentication, it will also be available with bi-directional functionality.
17. Event collection from Logicmonitor
    The MID WebService Event Collector enables you to collect JSON formatted event messages from the Logicmonitor.
18. Integrate Oracle Cloud Infrastructure alarms
    Integrate Oracle Cloud Infrastructure (OCI) alarms with Event Management to send events into ServiceNow by adding a https subscription using Basic Authentication.
19. Integrate Prometheus events
    Integrate Prometheus with Event Management by adding a standard webhook in Prometheus's Alert Manager.
20. Integrate Sentry events
    Integrate Sentry with Event Management by adding a standard webhook in the Sentry platform.
21. Integrate Scout APM events
    Enable the collection of events from Scout APM by authenticating Scout APM as a data source to integrate it with Event Management.
22. Integrate Sumo Logic events
    Use the Sumo Logic push connector to integrate Sumo Logic with Event Management by adding a standard webhook in the Sumo Logic platform.
23. Integrate Panopta as a data source
    Integrate the Panopta cloud-based monitoring solution with Event Management. To add Panopta as a data source, configuration is required in Panopta.
24. Integrate Event Integration (EIF) format event connector
    Use the push connector that allows events to be forwarded from products, generally from IBM, that support the Event Integration (EIF) format to a MID Server.

Parent Topic:Configure Event Management connectors