Module

events

A module related to xMatters events.

https://help.xmatters.com/xmapi/index.html#events

View Source events.js, line 3

Methods

# async inner create(env, event, functionId) → {Promise.<Event>}

Create an event in xMatters

https://help.xmatters.com/xmapi/index.html#trigger-an-event
Parameters:
Name Type Description
env module:environments.xMattersEnvironment The xmtoolbox representation of an xMatters instance.
event Event https://help.xmatters.com/xmapi/index.html#event-object
functionId string The id of the function. This may be found Integration or Flow Designer URL.

View Source events.js, line 73

Event Object Created
Promise.<Event>

# async inner get(env, eventId, query) → {Promise.<Event>}

Get a event from xMatters

https://help.xmatters.com/xmapi/index.html#get-an-event
Parameters:
Name Type Description
env module:environments.xMattersEnvironment The xmtoolbox representation of an xMatters instance.
eventId string The unique identifier or id of the event.

Examples:
- “24abd4c0-bff3-4381-9f84-678580b24428”
- “408005”

Note: We recommend using the UUID, since the event ID number might not always return results. To find the id or UUID for an event, use event.getMany() or locate the Event UUID entry on the event’s Properties screen in the web interface.
query Object A json object representing the query string parameters for this request.

View Source events.js, line 25

Event Object Requested
Promise.<Event>

# async inner getMany(env, query) → {Promise.<Array.<Event>>}

Get all events from xMatters matching the query. Please refer to the link below for the available query parameters.

https://help.xmatters.com/xmapi/index.html#get-events
Parameters:
Name Type Description
env module:environments.xMattersEnvironment The xmtoolbox representation of an xMatters instance.
query Object A json object representing the query string parameters for this request.

View Source events.js, line 38

Array of Event Objects Requested
Promise.<Array.<Event>>

# async inner getManyUserDeliveries(env, query, eventId) → {Promise.<Array.<UserDeliveryData>>}

Get all user delivery data for an event in xMatters matching the query. Please refer to the link below for the available query parameters.

https://help.xmatters.com/xmapi/index.html#get-user-delivery-data
Parameters:
Name Type Description
env module:environments.xMattersEnvironment The xmtoolbox representation of an xMatters instance.
query Object A json object representing the query string parameters for this request.
eventId string The unique identifier or id of the event.

Examples:
- “24abd4c0-bff3-4381-9f84-678580b24428”
- “408005”

View Source events.js, line 55

Array of User Delivery Data Objects Requested
Promise.<Array.<UserDeliveryData>>

# async inner update(env, event, eventId) → {Promise.<Event>}

Update an event [status] in xMatters

https://help.xmatters.com/xmapi/index.html#change-the-status-of-an-event
Parameters:
Name Type Description
env module:environments.xMattersEnvironment The xmtoolbox representation of an xMatters instance.
event Event https://help.xmatters.com/xmapi/index.html#event-object
eventId string The unique identifier or id of the event.

Examples:
- “24abd4c0-bff3-4381-9f84-678580b24428”
- “408005”

Note: We recommend using the UUID, since the event ID number might not always return results. To find the id or UUID for an event, use event.getMany() or locate the Event UUID entry on the event’s Properties screen in the web interface.

View Source events.js, line 93

Event Object Updated
Promise.<Event>