---
sourceDocument: Xanadu API Reference
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - en-US

ft:publication_title :

    - Xanadu API Reference

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Event - Global

# Event - Global {#ariaid-title1}

* Release version: Xanadu
* 
* Updated August 1, 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 4 minutes to read

The Event API provides methods that enable the setting and getting of values within an event.

These events are sent from a MID Server to a ServiceNow instance. Before you are able to successfully send
events, the connection between the MID Server and the ServiceNow instance must be defined.

Use the Event API to add/update fields
within an event. Use the SNEventSenderProvider API to instantiate
an event sender object. Then use the IEventSender API to send the
event to a ServiceNow instance.

You must activate the Event Management (com.glideapp.itom.snac) plugin before attempting to access this API. The Event Management plugin requires a separate subscription and must be activated. This
plugin includes demo data and activates related plugins if they are not already active.

For additional information on event management, see [Event Management](https://www.servicenow.com/docs/access?context=c_EM&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US).

## Event - Event() {#ariaid-title2}

Instantiates an Event constructor.
{#Event-Event__table_zk1_mcl_jkb__entry__3}

| Name | Type | Description |
|-|-|-|
| None |   |   |
[Table 1. Parameters]

{#Event-Event__table_zk1_mcl_jkb}  

    var event = new Event();
    var esource = event.getField("source");
    var eseverity = event.getField("severity");       

## Event - getField(String field) {#ariaid-title3}

Returns the current value of the passed in event management field.
{#Event-getField_S__table_ky4_4mk_jkb__entry__3}

| Name | Type | Description |
|-|-|-|
| field | String | Name of the event management field value to return. |
[Table 2. Parameters]

{#Event-getField_S__table_ky4_4mk_jkb} {#Event-getField_S__table_ly4_4mk_jkb__entry__2}

| Type | Description |
|-|-|
| String | Value of the requested event management field. |
[Table 3. Returns]

{#Event-getField_S__table_ly4_4mk_jkb}  

    var event = new Event();
    var eventSource = event.getField("source");
    var eventSeverity = event.getField("severity");       

## Event - setAdditionalInfo(String additionalInfo) {#ariaid-title4}

Replaces the existing additional_info field in the associated
event with the passed in JSON string.
Note:  
You can use the [setField()](https://servicenow-prod.fluidtopics.net/Be3VjWWpPnTS~WNzhwp5Hw#Event-setField_S_S "Sets the specified field in the associated event.") method to update a specific field within the additional_info field.
{#Event-setAdditionalInfo_S__table_pc2_dbh_kkb__entry__3}

| Name | Type | Description |
|-|-|-|
| additionalInfo | String | JSON String (key/value pairs) to save in the additional_info field. Note: This parameter replaces the existing information. It does not update the existing fields. |
[Table 4. Parameters]

{#Event-setAdditionalInfo_S__table_pc2_dbh_kkb} {#Event-setAdditionalInfo_S__table_qc2_dbh_kkb__entry__2}

| Type | Description |
|-|-|
| void |   |
[Table 5. Returns]

{#Event-setAdditionalInfo_S__table_qc2_dbh_kkb}  

    event.setAdditionalInfo("{\"evtComponent\":\"Microsoft-Windows- WindowsUpdateClient\",\"evtMessage\":\"Installation Failure: Windows failed. Error 0x80070490\"}");

## Event - setField(String key, String value) {#ariaid-title5}

Sets the specified field in the associated event.
If the passed in key matches a predefined event field, the method
updates the corresponding event field. Otherwise, the method adds the
key parameter to the additional_info section of
the event before applying the passed in value.

The following are the predefined event fields that you can modify using this method:
{#Event-setField_S_S__table_ddd_32g_pkb__entry__2}

| Field | Description |
|-|-|
| additional_info | Key-value pair to add to the additional_info field of the associated event. If the passed in key already exists, its value is overwritten. Maximum length: 4,000 characters Associated UI field: Additional information |
| ci_identifier | JSON string that uniquely identifies a configuration item. For example, `{"name":"SAP ORA01","type":"Oracle"}`. Maximum length: 1,000 characters |
| cmdb_ci | Sys_id of the Configuration Item \[cmdb_ci\] record to bind the event to. Default: Null |
| description | Free-form description of the event. Maximum length: 4,000 characters Associated UI field: Description Default: Null |
| event_class | Enterprise Message Service (EMS) that generated the event. For example, "Solarwinds" or "SCOM". Maximum length: 100 Associated UI field: Source instance Default: Null |
| message_key | Unique event identifier. To override an existing event severity, use the same message_key value. Maximum length: 1024 characters Associated UI field: Message key Default: Combination of source, node, type, resource, and metric name. |
| resolution_state | Event resolution state. Valid values: * New: Resolution state for the corresponding event is open. * Closing: Resolution state for corresponding event is closing/closed. {#Event-setField_S_S__ul_szv_dmg_pkb} Associated UI field: Resolution state Default: New |
| resource | Node resource to associate with the event. For example, "Disk C:", "CPI-1", or the name of a process or service. Maximum length: 100 characters Associated UI field: Resource |
| severity | Event severity. Valid values: * 0: Clear - No action is required. An alert is not created from this event. Existing alerts are closed. * 1: Ok - An alert is created. The resource is still functional. * 2: Warning - Attention is required, even though the resource is still functional. * 3: Minor - Partial, non-critical loss of functionality or performance degradation occurred. * 4: Major - Major functionality is severely impaired or performance has degraded. * 5: Critical - Immediate action is required. The resource is either not functional or critical problems are imminent. {#Event-setField_S_S__ul_ol1_d4g_pkb} Associated UI field: Severity Default: Null |
| source | Instance of the EMS that triggered the event. Typically the connector instance name. Maximum length: 200 characters Associated UI field: Source Default: Null |
| time_of_event | UTC time that the event occurred in the source system. Format: "yyyy-MM-dd HH:mm:ss" Maximum length: 40 characters Associated UI field: Time of event Default: Current date/time |
| type | Metric type to which the event is related, such as Disk or CPU. This value is used to identify an event record from which alerts are created. Maximum length: 100 characters Associated UI field: Type Default: Null |
[ ]

{#Event-setField_S_S__table_ddd_32g_pkb}  
Note:  
You can also use the [setText()](https://servicenow-prod.fluidtopics.net/Be3VjWWpPnTS~WNzhwp5Hw#Event-setText_S "Sets the description field of the associated event to the passed in value.") method to update the description field and the [setTimeOfEvent()](https://servicenow-prod.fluidtopics.net/Be3VjWWpPnTS~WNzhwp5Hw#Event-setTimeOfEvent_S "Sets the time_of_event field in the associated event to the passed in UTC time value.") method to update the event time.

For additional information on events, see [Event Management](https://www.servicenow.com/docs/access?context=c_EM&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US).
{#Event-setField_S_S__table_ijd_4ck_jkb__entry__3}

| Name | Type | Description |
|-|-|-|
| key | String | Name of the key to add or update in the event. For additional information on the predefined event fields, see [Event field format for event collection](https://www.servicenow.com/docs/access?context=c_EMIntegrateRequirementEvent&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US). |
| value | String | Information to store in the associated event field. Note: The value string is trimmed before it is stored, whereby multiple spaces are replaced with a single space. |
[Table 6. Parameters]

{#Event-setField_S_S__table_ijd_4ck_jkb} {#Event-setField_S_S__table_jjd_4ck_jkb__entry__2}

| Type | Description |
|-|-|
| void |   |
[Table 7. Returns]

{#Event-setField_S_S__table_jjd_4ck_jkb}  

    var event = new Event();
    event.setField("source","SAP Solman");
    event.setField("severity","3");
    event.setField("time_of_event", "2019-18-05 13:12:05");
    event.setField("type", "SAP object");
    event.setField("user", "admin"); // parameter will be added to additional_info section       

## Event - setText(String text) {#ariaid-title6}

Sets the description field of the associated event to the passed
in value.
Note:  
You can also use the [Event - setField(String key, String value)](https://servicenow-prod.fluidtopics.net/Be3VjWWpPnTS~WNzhwp5Hw#Event-setField_S_S "Sets the specified field in the associated event.") method to set the text field in the current event. Unlike the setField() method, this method does not trim the passed in text.
{#Event-setText_S__table_r2j_mgh_kkb__entry__3}

| Name | Type | Description |
|-|-|-|
| text | String | Text to store in the description field of the associated event. Max length: 4000 characters |
[Table 8. Parameters]

{#Event-setText_S__table_r2j_mgh_kkb} {#Event-setText_S__table_s2j_mgh_kkb__entry__2}

| Type | Description |
|-|-|
| void |   |
[Table 9. Returns]

{#Event-setText_S__table_s2j_mgh_kkb}  

    var event = new Event();
    event.setText("SAP Solman");       

## Event - setTimeOfEvent(String timeOfEvent) {#ariaid-title7}

Sets the time_of_event field in the associated event to the passed
in UTC time value.
Note:  
You can also use the [Event - setField(String key, String value)](https://servicenow-prod.fluidtopics.net/Be3VjWWpPnTS~WNzhwp5Hw#Event-setField_S_S "Sets the specified field in the associated event.") method to set the time_of_event field.
{#Event-setTimeOfEvent_S__table_m43_kwg_kkb__entry__3}

| Name | Type | Description |
|-|-|-|
| timeOfEvent | String | UTC time value to set in the time_of_event field. Format: "yyyy-MM-dd HH:mm:ss" Max length: 40 characters |
[Table 10. Parameters]

{#Event-setTimeOfEvent_S__table_m43_kwg_kkb} {#Event-setTimeOfEvent_S__table_n43_kwg_kkb__entry__2}

| Type | Description |
|-|-|
| void |   |
[Table 11. Returns]

{#Event-setTimeOfEvent_S__table_n43_kwg_kkb}  

    var event = new Event();
    event.setTimeOfEvent("2019-18-05 13:12:05");