xMatters

Supported versions

Supported Cortex XSOAR versions: 5.5.0 and later.

This is an integration for using xMatters. This integration was integrated and tested with version 1 of xMatters

Configure xMatters on Cortex XSOAR

  1. Navigate to Settings > Integrations > Servers & Services.
  2. Search for xMatters.
  3. Click Add instance to create and configure a new integration instance.
ParameterDescriptionRequired
instanceYour xmatters instance base URL. (i.e. acme.xmatters.com)True
insecureTrust any certificate (not secure)False
proxyUse system proxy settingsFalse
usernameUsername for your xMatters instance.True
passwordPassword for your xMatters instance.True
urlURL of an HTTP trigger in a flow.True
fetch_typeTrue
statusFetch alerts with status (ACTIVE, SUSPENDED)False
priorityPriority of events to fetchFalse
isFetchFetch incidentsFalse
incidentTypeIncident typeFalse
property_nameFalse
property_valueFalse
first_fetchFirst fetch timestamp (<number> <time unit>, e.g., 12 hours, 7 days)False
max_fetchFalse
  1. Click Test to validate the URLs, token, and connection.

Commands

You can execute these commands from the Demisto CLI, as part of an automation, or in a playbook. After you successfully execute a command, a DBot message appears in the War Room with the command details.

xm-trigger-workflow


sends the event to xMatters

Base Command

xm-trigger-workflow

Input

Argument NameDescriptionRequired
recipientsRecipients of the xMatters MessageRequired
subjectSubject of the xMatters MessageOptional
bodyBody of the xMatters MessageOptional
incident_idIncident ID of Incident referencedOptional
close_task_idId of task to close in playbook. Requires an incident_id as the investigation id.Optional

Context Output

PathTypeDescription
request_idstringRequest ID from xMatters

Command Example

!xm-trigger-workflow recipients="Joey" subject="Major Emu Issue" body="The emu has escaped!"

Context Example

{
"request_id": "93e6b331-2108-424d-872b-8200b476907b"
}

Human Readable Output

Successfully sent a message to xMatters.

xm-get-events


Get events from xMatters.

Base Command

xm-get-events

Input

Argument NameDescriptionRequired
request_idThe UUID returned from triggering a workflow.Optional
statusStatus of the event.Optional
priorityPriority of the event.Optional
fromA date in UTC format that represents the start of the time range you want to search.Optional
toA date in UTC format that represents the end of the time range you want to search.Optional
workflowThe name of the workflow the event is tied to.Optional
formThe name of the form the event is tied to.Optional
property_nameAn event property name to filter the eventsOptional
property_valueAn event property value to filter the eventsOptional

Context Output

PathTypeDescription
EventsunknownEvents from xMatters.

Command Example

!xm-get-events status=ACTIVE

Context Example

{
"Events": [
{
"Created": "2020-10-13T21:35:07.725+0000",
"FormName": "Incident",
"Incident": "7a63abc3-5abf-41ca-969b-80eb678fbf72",
"Name": "Major Emu Issue\n",
"PlanName": "Cortex XSOAR",
"Prioity": "MEDIUM",
"Properties": null,
"Status": "ACTIVE",
"SubmitterName": "admin",
"Terminated": null
},
{
"Created": "2020-10-13T21:33:58.444+0000",
"FormName": "Incident",
"Incident": "388884f1-410b-4eb8-a38e-4973e7151b89",
"Name": "Major Emu Issue\n",
"PlanName": "Cortex XSOAR",
"Prioity": "MEDIUM",
"Properties": null,
"Status": "ACTIVE",
"SubmitterName": "admin",
"Terminated": null
}
]
}

Human Readable Output

Retrieved Events from xMatters.

xm-get-event


Get a single event from xMatters.

Base Command

xm-get-event

Input

Argument NameDescriptionRequired
event_idUnique identifier of the eventRequired

Context Output

PathTypeDescription
EventunknownEvent from xMatters.

Command Example

!xm-get-event event_id=33999001

Context Example

{
"Event": {
"Created": "2020-10-13T20:50:24.520+0000",
"FormName": "Integration Builder: Integration Problem",
"Incident": "99a7692b-30df-40c4-9a20-edc495ae91f9",
"Name": "Your xMatters integration has a problem",
"PlanName": "Integration Builder Notifications",
"Prioity": "MEDIUM",
"Properties": null,
"Status": "ACTIVE",
"SubmitterName": "xm-support",
"Terminated": null
}
}

Human Readable Output

Retrieved Event from xMatters.