---
sourceDocument: Yokohama IT Operations Management
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/yokohama/it-operations-management

 Release :

    - yokohama

ft:locale :

    - en-US

ft:publication_title :

    - Yokohama IT Operations Management

ft:clusterId :

    - itom

bundleId :

    - itom

workflow :

    - Technology


---

# Configure the MID WebService Event Collector Context

# Configure the MID WebService Event Collector Context {#ariaid-title1}

* Release version: Yokohama
* 
* Updated May 21, 2026
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 4 minutes to read

Configure the MID WebService Event Collector Context to provide a URL method to push
event messages from an external source to the MID Server.

## 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

The default format of the URL to push event messages from an external source to the MID Server is `http://{MID_Server_IP}:{MID_Web_Server_Port}/api/mid/em/jsonv2`. This URL provides good performance.

From an external source, to push event messages that are not in jsonv2 format, the format of the URL is:
`http://{MID_Server_IP}:{MID_Web_Server_Port}/api/mid/em/inbound_event?Transform={Name_of_Transform_Script}`, where the <var class="keyword varname">{Name_of_Transform_Script}</var> variable is the full name of the script and
always begins with the text: <kbd class="ph userinput">TransformEvents_</kbd>.{#configure-em-context-extension__p_non-json-format}  
For example, assume the following values:

* {MID_Server_IP}: 10.118.69.27
* {MID_Web_Server_Port}: 8097
* Transform script name: EventsToProcess

{#configure-em-context-extension__ul_asl_dyq_tfb}The URL to be used is therefore: `http://10.118.69.27:8097/api/mid/em/inbound_event/TransformEvents_EventsToProcess`  
Note:  
* The URL in the format `http://{MID_Server_IP}:{MID_Web_Server_Port}/api/mid/em/{transform_script_name}`is also supported.
* The date format for events is yyyy-M-d h:mm:ss.

  If you receive an event whose date is in a different format, you must use a `{transform_script_name}` that is appropriate for the
  incoming event's date format. If you do not, the event will not be processed correctly.

  For example, if an event arrives on June 27, 2019 at 11:25 AM with a listed date of 2019/06/27/ 11:25:00 a, use a `{transform_script_name}` with a date format of yyyy/MM/dd/ HH:mm:ss a to match the format of the received event.
  {#configure-em-context-extension__ph_date-format}
{#configure-em-context-extension__ul_wqh_3dw_b5b}

## Procedure

1. Navigate to AllEvent ManagementIntegrationsMID WebService Event Listener.
2. In the MID WebService Event Collector Contexts list, click New.
3. On the form, fill in the fields.  
   {#configure-em-context-extension__table_od5_flc_bx__entry__2}{#configure-em-context-extension__ph_entry-name}{#configure-em-context-extension__ph_entry-short-desc}{#configure-em-context-extension__ph_entry-extension}{#configure-em-context-extension__ph_entry-status}{#configure-em-context-extension__ph_entry-execute-on}{#configure-em-context-extension__ph_entry-mid-server}{#configure-em-context-extension__ph_entry-executing-on}

   | Field | Description |
   |-|-|
   | Name | A unique name for this collector for easy identification. |
   | Short description | Enter a brief, meaningful description of this collector. |
   | MID Web Server Extension | Specify and then start the MID Web Server extension. The supported authentication methods are listed in the Authentication Type field of the MID Web Server extension. For information about how to configure a MID Web Server extension, see [Configure the MID Web Server](https://servicenow-prod.fluidtopics.net/_6TI0U~gdVg0W_7HIWP7AA "The MID Web Server is a MID Server extension that enables developing REST APIs to send events and metrics to the MID Server. The extension is leveraged by other MID Server extensions, such as Metric Intelligence, MID WebService Event Listener, and the Agent Client Collector websocket endpoint extension."). |
   | Status | This field is auto-populated with the status of the MID Web Server extension. This field is blank until the MID Web Server extension is started. After issuing a command to the MID Web Server extension, one of the following values is displayed: * Started: The collector is running. * Stopped: The collector is not running. * Offline: The MID Server is down. * Error: The collector failed with an error (the error message is displayed in Error Message). * Warning: A run-time exception has occurred. {#configure-em-context-extension__ul_entry-status} |
   | Execute on | Specific MID Server or Specific MID Server Cluster, as defined on the specified MID Web Server extension. |
   | MID Server | The Specific MID Server or Specific MID Server Cluster, as defined on the specified MID Web Server extension. |
   | Executing on | The name of the MID Server on which the MID Web Server extension is running. |
   [Table 1. MID WebService Event Collectors Context form]

   {#configure-em-context-extension__table_od5_flc_bx}
4. Right-click the form heading and click Save. {#configure-em-context-extension__step_save}
{#configure-em-context-extension__step_save}
5. Under Related Links, click Start to start the collector.  
   {#configure-em-context-extension__table_dhd_tjc_bx__entry__2}

   | Related Link | Description |
   |-|-|
   | Start | If it is not running, start the collector. This action verifies that a web service API endpoint with the Event Management application is running on the MID Server. |
   | Stop | Stops the running collector on the configured MID Server. If the collector is not running, no action is taken. |
   | Restart | Stops, then starts the collector on the configured MID Server. |
   | Update parameters | Sends updated parameters to the collector. Parameters are also updated when the Event Management MID Server context extension is updated. If you click this control when the collector is not running, no update is made. |
   [Table 2. Commands in the Event Management Context form]

   {#configure-em-context-extension__table_dhd_tjc_bx} {#configure-em-context-extension__cmd_start}
{#configure-em-context-extension__steps_nd5_flc_bx}

## Example

Showing the use of the URL to transform JSON v2 formatted event messages

Assume that JSON v2 formatted event messages are sent to the MID Server. When using the `jsonv2` URL, there is no need to use a script include.
{#configure-em-context-extension__table_qzh_fyt_cy__entry__2}

| Field | Value |
|-|-|
| MID_Server_IP | 10.218.64.27 |
| MID_Web_Server_Extension_Port | 8097 |
| Event message format | jsonv2 |
[Table 3. Data for the JSON v2 example]

{#configure-em-context-extension__table_qzh_fyt_cy}

Replace the variables in the default format of the URL `http://<my-instance>.service-now.com/api/global/em/jsonv2`with values from the preceding
table:`http://10.218.64.27:8097/api/global/em/jsonv2`

Example showing the URL to push messages not in jsonv2 format

The format of the URL to push event messages from an external source that are not in jsonv2 format is `http://{MID_Server_IP}:{MID_Web_Server_Port}/api/mid/em/inbound_event/Transform={Name_of_Transform_Script}`
where the {Name_of_Transform_Script} variable is the full name of the script and always begins with the text: TransformEvents_. The script name must be specified as the <kbd class="ph userinput">Transform</kbd> header parameter and must
always start with the prefix <kbd class="ph userinput">TransformEvents_</kbd>.

For this example, assume that the script name is EventsToProcess, the URL is therefore:`http://10.138.64.27:8097/api/mid/em/inbound_event/TransformEvents_EventsToProcess`  
Example showing JSON v2 formatted event messages  
Note:  
When copying and pasting the text following, hidden characters might also be copied and can cause unexpected results.


    curl -v -H "Accept: application/json" -H "Content-Type: application/json" -X POST --data "{
        \"records"\:
        [ {
             \"source\" : \"Simulated\",
            \"node\" : \"nameofnode\",
            \"type\" : \"High Virtual Memory\",
            \"resource\" : \"C:\",
            \"severity\" : \"5\",
            \"description\" : \"Virtual memory usage exceeds 98%\",
            \"ci_type\":\"cmdb_ci_app_server_tomcat\",
            \"additional_info\":\"{\\\"name\\\":\\\"My Airlines\\\"}\"
          },
          {
          \"source\" : \"Simulated\",
          \"node\" : \"01.myairlines.com\",
          \"type\" : \"High CPU Utilization\",
          \"resource\" : \"D:\",
          \"severity\" : \"5\",
          \"description\" : \"CPU on 01.my.com at 60%\"
          }
       ]
    }" -u UserName:Password http://{MID_Server_IP}:{MID_Web_Server_Port}/api/mid/em/jsonv2

## Example

Example showing JSON v2 formatted event messages with MID Web Server API key  
Note:  
When copying and pasting the text following, hidden characters might also be copied and can cause unexpected results.


    curl --location -g --request POST 'http://{MID_Server_IP}:{MID_Web_Server_Port}/api/mid/em/jsonv2' \
    --header 'Accept: application/json' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: key <mid_webserver_api_key>' \
    --data-raw '{
       "records":
        [ {
             \"source\" : \"Simulated\",
            \"node\" : \"nameofnode\",
            \"type\" : \"High Virtual Memory\",
            \"resource\" : \"C:\",
            \"severity\" : \"5\",
            \"description\" : \"Virtual memory usage exceeds 98%\",
            \"ci_type\":\"cmdb_ci_app_server_tomcat\",
            \"additional_info\":\"{\\\"name\\\":\\\"My Airlines\\\"}\"
          },
          {
          \"source\" : \"Simulated\",
          \"node\" : \"01.myairlines.com\",
          \"type\" : \"High CPU Utilization\",
          \"resource\" : \"D:\",
          \"severity\" : \"5\",
          \"description\" : \"CPU on 01.my.com at 60%\"
          }
       ]
    }'

**Related tasks**   

* [Configure the MID Web Server extension](https://servicenow-prod.fluidtopics.net/_6TI0U~gdVg0W_7HIWP7AA "The MID Web Server is a MID Server extension that enables developing REST APIs to send events and metrics to the MID Server. The extension is leveraged by other MID Server extensions, such as Metric Intelligence, MID WebService Event Listener, and the Agent Client Collector websocket endpoint extension.")
* [Event collection from BMC TrueSight](https://servicenow-prod.fluidtopics.net/t1JRTxZLxWW3V2zSkOztBQ "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.")
* [Event collection from Microsoft Azure Monitor](https://servicenow-prod.fluidtopics.net/6_ZA0hfCo4cSAq~RH0Elfg "The MID WebServer Event Collector enables you to collect JSON formatted event messages sent from the Microsoft Azure portal.")
* [Event collection from Google Cloud Platform](https://servicenow-prod.fluidtopics.net/nDe6P1lV6F1cwbgaHKM7Yw "The MID WebService Event Collector enables you to collect JSON formatted event messages sent from Google Cloud Platform (GCP).")

*[\>]: and then