xMatters API Authentication

How to authenticate xMatters API requests: one Bearer API key plus a connectionId. MindCloud stores your xMatters credentials — no auth headers to build.

Every xMatters API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your xMatters account. This page covers both, plus exactly how to send them, so you do not need to visit any other page to get authenticated.

Steps to authenticate

Create a MindCloud account at app.mindcloud.co if you do not already have one.
Generate a MindCloud API Key in API Keys. This is the Bearer token you send on every request. Keep it on your server.
Create a xMatters connection in Connections. xMatters uses a username and password. You enter them when you create the connection — MindCloud stores them securely so your requests never carry raw credentials.
Copy the connection’s connectionId — you will send it on every request alongside your MindCloud API Key.

How requests are authenticated

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected xMatters account that should run the action. MindCloud stores and refreshes the xMatters credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions.

For example, calling Get People with an xMatters connection looks like this:

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": {}
}'

The Authorization: Bearer <your MindCloud API Key> header authenticates you to MindCloud; the connectionId tells MindCloud which xMatters account to run the action against. Missing or invalid Authorization returns 401, and a missing or mismatched connectionId returns 400.

Connect xMatters with Basic Authentication

Use your xMatters tenant over HTTPS and choose an account that has permission to call the xMatters REST API.

Choose the xMatters account to connect
Use an account with the permissions this integration needs. xMatters documents the REST Web Service User role as the recommended role for many common endpoints and for creating and updating users and groups.
Enter the account credentials in MindCloud
Use the account's web login ID as the Username and its password as the Password for this connection. xMatters requires HTTPS for sending these credentials securely.
Validate the connection with a read action
After saving the connection, run a safe read action such as Get People to confirm the account can reach your xMatters tenant and has the expected API permissions.

Keep your key safe

Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs. Anyone with the key can call the Universal API as your MindCloud account, across every connection you have created.