Event Object

Represents the business process level of the [incident - event - event resolution business process] relationship. It provides event and process related variables and methods.

Creation Method: System-provided object

Reference Name: This represents the inbound event and is loaded as a global script object. Access this object using @event.

Scope: Event lifecycle.

Reserved object variables
Variable Type Description

creationTimeValue

Integer

Time the event was created, recorded as the number of milliseconds since epoch (January 1st, 1970 00:00:00 GMT).

creationTime

String

Time the event was created, recorded as a formatted date value using the full date format of the installed locale.

company

String

ID of the Company associated with the Event Domain of this event

company_callin_number

String

The call-in number for the Company associated with the Event Domain of this event.

domain

String

The Event Domain for this event. This is actually the initial Event Domain. This does not change, even if the event is submitted to a peer event resolution business process. See the business process script object for further event domain tracking.

id

String

The event ID for this event.

incident_id

String

External identifier for the incident relating to this event.

recipients

List

The value passed in as person_or_group_id; see also Recipient target names.

terminated

Boolean

Visibility of the termination state of the event; true if this business process has been terminated.

xm_priority String

Event priority; one of LOW, MEDIUM, or HIGH. The value is not case-sensitive, and also determines the default priority level of notifications associated with the event. If no value is specified, or if an invalid value is passed in, the default is MEDIUM.

Added in xMatters version 5.0

Event object methods

The following methods are available for the Event object:

advancedMessage

createContent

createExternalServiceMessage

createExternalServiceRequest

createExternalServiceRequest2

createURLAliasObject

deleteIncident

delink

delinkAll

delinkAllExcept

delinkIncident

delivered

deliveredAll

deliveredIncident

getCompany

getCompanyName

getEventDomainConstant

getPriority

getRecipient

getStakeholders

getSubscription

getSubscriptions

getUniquePersons

isAnyRecipientNotifiable

isDelinked

notification

report

terminate

Inbound reserved names