xMatters API Documentation

This is the complete API documentation for connecting to the xMatters API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet xMatters: Manage incidents, alerts, people, and on-call schedules. Keep reading to get started.

Quickstart

Before you run your first xMatters request, you need three things:

A MindCloud account — sign in or create an account at MindCloud.
A MindCloud API Key — create one in API Keys. Keep it on your server.
At least one xMatters connection — create or choose one in Connections. Note its connectionId.

Every xMatters action uses the same URL pattern:

POST https://connect.mindcloud.co/v2/universal/apps/xMatters/actions/{actionSlug}/run

You need a MindCloud API Key and a xMatters connection. Then call an action such as Get People:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/xMatters/actions/get-people/run" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "arguments": {}
}'

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authenticate with a MindCloud API Key plus a connectionId for your xMatters account. See xMatters API Authentication for the full flow and how to get your connection credentials.

xMatters actions

All 164 published actions for this xMatters version. Each page documents the endpoint, arguments, and response controls.

More IT Operations apps on the Universal API, behind the same REST shape. Or browse all apps.

Quickstart

xMatters actions

Related apps