---
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
---
# Pushing events to the MID Server using web service API
# Pushing events to the MID Server using web service API {#ariaid-title1}
* Release version: Yokohama
*
* Updated January 30, 2025
*
*  3 minutes to read
Summarize
 Summarized using AI
This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.
## Summary of Pushing events to the MID Server using web service API
This functionality enables ServiceNow customers to push event messages directly to the MID Server via a web service API.
By configuring the MID WebService Event Collector, you can use specific URLs to send event data in JSON, XML, or plain text formats.
This approach streamlines event ingestion through the MID Server, allowing for efficient event processing and integration with external event generators.
Show full answer Show less
## Key Features
* **Event Push URL:** Use the default URL (`http://{MIDServerIP}:{MIDWebServerPort}/api/mid/em/jsonv2`) to send JSON v2 formatted events, matching the format clients use to send events to the instance, ensuring good performance.
* **Custom Payload Support:** Push custom event payloads in JSON, XML, or plain text using a URL with a transform script parameter (e.g., `?Transform={Transformscriptname}`). This allows the MID Server to convert incoming data into ServiceNow events.
* **Transform Script Include:** Scripts named with the prefix `TransformEvents` handle parsing and transforming incoming event messages. A sample script, `TransformEventsxmlSample`, is provided for XML format when the Event Management plugin is active.
* **Generic JSON Transformation:** The provided `TransformEventsMidJsonGeneric` script include transforms generic JSON payloads by mapping all fields to Additional Information fields in the event record.
* **Request Headers:** Specify the correct `Content-Type` header based on the message format---`application/json` for JSON, `application/xml` for XML, and `text/plain` for plain text.
* **Authentication and Security Options:** Supports API Key, mTLS, or Basic authentication. Secure connection options include the use of certificates from trusted authorities, keystore password protection, and the MID Unified Keystore for encryption and custom certificate installation.
* **Connectivity Validation:** Use the REST API endpoint (`/api/mid/em/ping`) to verify connectivity with the MID Server.
## Practical Application for ServiceNow Customers
By leveraging this web service API setup, you can integrate external event sources with your ServiceNow Event Management process more efficiently. Custom transform scripts enable flexible parsing of diverse event formats, ensuring that all relevant event data is captured accurately within ServiceNow. The security and authentication options help maintain data integrity and compliance during transmission.
Ensure that your transform scripts correctly implement the `transform()` function to parse incoming event data and return an array of event objects for processing. Use the provided examples as templates when developing custom parsers.
Configure the MID WebService Event Collector to provide a URL method to push event
messages to the MID Server.
The MID WebService Event Collector, by default, enables you to connect to an event generator and send event messages through the MID Server, using a URL in the format: `http://{MID_Server_IP}:{MID_Web_Server_Port}/api/mid/em/jsonv2`
The JSON v2 format is the same as the format that clients use to send event messages
to the instance. This URL provides good performance.
For more information, see [Configure the MID WebService Event Collector Context](https://servicenow-prod.fluidtopics.net/9hyUIqDCjbtMOV2bYDXigQ "Configure the MID WebService Event Collector Context to provide a URL method to push event messages from an external source to the MID Server.").
Note:
Event Management accepts events in the timezone of the MID Server through which the listener has sent the event message. If you require a different timezone, you can configure the script as required, see [Integrate with push connectors](https://servicenow-prod.fluidtopics.net/fflpxkIq3CsQDAbBfe7dxA "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.").
## URL to push custom payloads
The MID Server can also
receive a custom payload in JSON, XML, or plain text format. In this case, the MID Server transforms the event messages using the script include
that you provide, and then sends the events to the instance. The URL in this case
is:
`http://{MID_Server_IP}:{MID_Web_Server_Port}/api/mid/em/inbound_event?Transform={Transform_script_name}` For an example of a script include, see the default `TransformEvents_xmlSample` script include.
For an example of how
the MID WebService Event Collector transforms JSON formatted event messages, see
[Event collection from BMC TrueSight and BMC TrueSight_v2](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.").
To send events in generic JSON format, you can use the URL in this
format:
`http://{MID_Server_IP}:{MID_Web_Server_Port}/api/mid/em/inbound_event?Transform=TransformEvents_MidJsonGeneric`
In
this case, the `TransformEvents_MidJsonGeneric` MID script include
that is provided in the base instance transforms the event messages into the event
fields. All fields are added as Additional Information fields
into the ServiceNow event that is generated.
Note:
The URL in the format `http://{MID_Server_IP}:{MID_Web_Server_Port}/api/mid/em/{transform_script_name}`is also supported.
The REST API URL for validating connectivity is:
`http://{MID_Server_IP}:{MID_Web_Server_Port}/api/mid/em/ping`
## Script include to transform collected events
Use the required MID Server
script include to transform (parse) collected event messages and populate them into
the mapped event field. The MID Server script include name
is composed of a prefix and suffix. The prefix is the mandatory text
`TransformEvents_` and the suffix is the transform name on the
URL, for example,
`http://{MID_Server_IP}:{MID_Web_Server_Port}/api/mid/em/xmlSample`
. The composed script name is therefore
`TransformEvents_xmlSample`.
You must supply a script include that receives the event messages in a text variable.
The script must have a `transform()` function that performs the
transformation and prepares the return array of Event objects. When the Event Management plugin is
activated, you are provided with the `TransformEvents_xmlSample`
sample include script that transforms events from XML format.
Note:
Event fields that are not identical to fields in the event table are saved in the Additional information field.
## Event message headers
Specify the relevant request header value for the Content-Type
field according to the format of the event message.
{#event-collection-via-MID-using-push__table_uqf_ldy_dy__entry__2}
| Message format | Content-Type value |
|-|-|
| JSON | application/json |
| XML | application/xml |
| text | text/plain |
[Table 1. Request header values for the Content-Type]
{#event-collection-via-MID-using-push__table_uqf_ldy_dy}
## Authentication and data security options
Options for authentication and data security:
* Authentication type, which can be set to either API Key, mTLS, or Basic.
* Secure Connection, which lets you choose whether incoming and outgoing data is secured when transmitted. If you choose the advanced secured option, it requires that you obtain a certificate from a well-known certificate authority, and then provide the Keystore Certificate Alias and the Keystore Password.
* Use MID Unified Keystore, which provides encryption protection and enables you to install a custom certificate in the MID Server unified keystore. For details, see [Install custom
certificates in the MID Server unified key store](https://www.servicenow.com/docs/access?context=mid-unified-keystore&version=yokohama&pubname=yokohama-servicenow-platform&ft:locale=en-US).
* Users must supply a script that receives the JSON, XML, or text formatted event messages in a text variable. The script must have a transform() function that performs the transformation and prepares the return array of event objects. The `TransformEvents_xmlSample` include script that transforms events from XML format is provided as an example when the Event Management plugin is activated.
{#event-collection-via-MID-using-push__ul_pz5_cgt_2x}For more information about authentication and data security, see [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.").
**Related tasks**
* [Pushing events to the instance using web service API](https://servicenow-prod.fluidtopics.net/teqkbfHOG39L5QZR5b~ycQ "You can use a web service interface, supported by ServiceNow, that operates on the JSON object as the data input and output format.")