xMatters connector and action


xMatters connector and actionedit

The xMatters connector uses the xMatters Workflow for Elastic to send actionable alerts to on-call xMatters resources.

Connector configurationedit

xMatters connectors have the following configuration properties:

The name of the connector. The name is used to identify a connector in the management UI connector listing, or in the connector list when configuring an action.
Authentication Type
The type of authentication used in the request made to xMatters.
The request URL for the Elastic Alerts trigger in xMatters. If you are using the xpack.actions.allowedHosts setting, make sure the hostname is added to the allowed hosts.
Username for HTTP Basic Authentication.
Password for HTTP Basic Authentication.

Connector networking configurationedit

Use the Action configuration settings to customize connector networking configurations, such as proxies, certificates, or TLS settings. You can set configurations that apply to all your connectors or use xpack.actions.customHostSettings to set per-host configurations.

Preconfigured connector typeedit

Connector using Basic Authentication

   name: preconfigured-xmatters-connector-type
   actionTypeId: .xmatters
     configUrl: https://test.host
     usesBasic: true
     user: testuser
     password: passwordkeystorevalue

Connector using URL Authentication

   name: preconfigured-xmatters-connector-type
   actionTypeId: .xmatters
     usesBasic: false
     secretsUrl: https://test.host?apiKey=1234-abcd

Config defines information for the connector type:

A URL string that corresponds to URL. Only used if usesBasic is true.
A boolean that corresponds to Authentication Type. If true, this connector will require values for user and password inside the secrets configuration. Defaults to true.

Secrets defines sensitive information for the connector type:

A string that corresponds to User. Required if usesBasic is set to true.
A string that corresponds to Password. Should be stored in the Kibana keystore. Required if usesBasic is set to true.
A URL string that corresponds to URL. Only used if usesBasic is false, indicating the API key is included in the URL.

Define connector in Stack Managementedit

Define xMatters connector properties. Choose between basic and URL authentication for the requests:

xMatters connector with basic authentication
xMatters connector with url authentication

Test xMatters rule parameters:

xMatters params test

Action configurationedit

xMatters rules have the following properties:

Severity of the rule.
Comma-separated list of tags for the rule as provided by the user in Elastic.

Configure xMattersedit

By integrating with xMatters, you can:

  1. Leverage schedules, rotations, escalations, and device preferences to quickly engage the right resources.
  2. Allow resolvers to take immediate action with customizable notification responses, including incident creation.
  3. Reduce manual tasks so teams can streamline their resources and focus.


To use the Elastic xMatters connector either install the Elastic workflow template, or add the Elastic Alerts trigger to one of your existing xMatters flows. Once the workflow or trigger is in your xMatters instance, configure Elastic to send alerts to xMatters.

  1. In xMatters, double-click the Elastic trigger to open the settings menu.
  2. Choose the authentication method and set your authenticating user.
  3. Copy the initiation URL.
  4. In Elastic, open the xMatters connector.
  5. Set the authentication method, then paste the initiation URL.

Note: If you use basic authentication, specify the Web / App Login ID in the user credentials for the connector. This value can be found in the Edit Profile modal in xMatters for each user. For detailed configuration instructions, see xMatters online help