Skip to main content
Back to Search AI connectors list xMatters is an incident management and automated alerting platform that integrates with monitoring tools to deliver targeted notifications and orchestrate workflows. The Search AI xMatters connector ingests incidents, events, and on-call data for search.
SpecificationDetails
Repository typeCloud
Supported contentIncidents, Events, On-Calls
RACL supportYes
Content filteringNo

Prerequisites

Search AI uses OAuth 2.0 Password Grant Type to authenticate with xMatters. The authorization token grants the same permissions in xMatters as the user account used to create it. Retrieve the OAuth Client ID from xMatters before configuring the connector:
  1. In xMatters, navigate to Workflows > OAuth.
  2. Copy the Client ID. This is unique to your xMatters company and is required during connector configuration.

Configuring the xMatters Connector in Search AI

Navigate to the xMatters Connector and enter the following details on the Authentication page.
FieldDescription
NameUnique identifier for the connector
DomainYour xMatters company subdomain (for example, if your domain is test.xmatters.com, enter only test)
Client IDOAuth Client ID from your xMatters instance
UsernameUsername of the account used to authenticate requests
User PasswordPassword of the account used to authenticate requests

Content Ingestion

Search AI ingests the following content types from xMatters:
  • Incidents
  • Alerts (also referred to as Events)
  • On Calls
The doc_source_type field identifies the content type of each ingested document. Additional metadata is available in the respective fields of each document.

Access Control

For incidents and alerts, the sys_racl field contains the following permission entities:
  • User ID of the commander (if available)
  • User ID of the resolvers (if available)
  • User ID of the creator
  • Group ID of one or more involved groups (if applicable)
For on-calls, the sys_racl field contains:
  • Group ID
Use the Permission Entity APIs to associate users with these permission entities.