---
title: xMATTERS
slug: authentication-guides/xmatters
docTags: 
createdAt: 2026-04-28T10:25:12.743Z
---

# Introduction

This guide tells you how to authenticate the xMatters connector in Swimlane using:

- HTTP Basic Authentication
- OAuth 2.0 Password Credentials

You will obtain xMatters credentials, configure OAuth (if applicable), collect required identifiers, and configure the connector in Swimlane.

# Prerequisites

| **Requirement**     | **Description**                                    |
| ------------------- | -------------------------------------------------- |
| Platform Access     | Access the xMatters platform                       |
| User Management     | View and manage users and devices                  |
| Workflow Management | Create and manage workflows                        |
| OAuth Configuration | Configure OAuth clients (for OAuth authentication) |
| API Access          | Access API endpoints                               |

## Required Credentials

During setup, you will collect:

### For HTTP Basic Authentication:

- URL
- Username
- Password

### For OAuth 2.0 Password Credentials:

- URL
- Username
- Password
- Client ID

## xMatters Setup

Take the following steps to retrieve API endpoint URL:

1. Log in to your xMatters instance.
2. Identify your base API URL in the following format: https\://\<company>.xmatters.com/api/xm/1
3. Verify access to the API endpoint.

## OAuth 2.0 Setup (Optional)

Take the following steps to obtain Client ID:

1. Log in to the xMatters web interface.
2. Navigate to:
   **Workflows → OAuth Clients**
3. Locate or create an OAuth client.
4. Copy the **Client ID**.

Take the following steps to verify user credentials:

1. Ensure the user account has sufficient permissions.
2. Confirm username and password are active.
3. Verify access to incidents, events, and devices.

# Connector configuration in Swimlane

1. Log in to Turbine.
2. From the left-hand navigation pane, click **ORCHESTRATION** and click **Assets**.
3. Asset homepage opens.
4. Click the plus icon to open the Configure your Connector Asset window.
5. Select **xMatters** from the Asset type list.
6. Fill in the Asset Settings and Asset Input as shown:

## Configuration – HTTP Basic Authentication

| **Field**   | **Description**                 | **Required/Optional** |
| ----------- | ------------------------------- | --------------------- |
| url         | xMatters API base URL           | Required              |
| username    | xMatters username               | Required              |
| password    | xMatters password               | Required              |
| verify\_ssl | Enable/Disable SSL Verification | Optional              |
| http\_proxy | Optional proxy configuration    | Optional              |

![](https://api.archbee.com/api/optimize/n8uUzk0MM4uC57-zlHNtY/qNHpsWSr6tlyLloCZqnkn_.blob)

![]()

## Configuration – OAuth 2.0 Password Credentials

| **Field**        | **Description**                 | **Required/Optional** |
| ---------------- | ------------------------------- | --------------------- |
| url              | xMatters API base URL           | Required              |
| oauth2\_username | xMatters username               | Required              |
| oauth2\_password | xMatters password               | Required              |
| client\_id       | OAuth client ID                 | Required              |
| verify\_ssl      | Enable/Disable SSL Verification | Optional              |
| http\_proxy      | Optional proxy configuration    | Optional              |

Fields with \* marks are required.

![](https://api.archbee.com/api/optimize/n8uUzk0MM4uC57-zlHNtY/gEPnA_WNxIhtV_VVRtMsr_.blob)

![]()

# Troubleshooting

If authentication fails:

- Ensure the **URL is correct and accessible**
- Verify **username and password are correct**
- Confirm the **user has sufficient permissions**
- Ensure the **Client ID is valid (for OAuth)**
- Check if the **OAuth client is properly configured**
- Verify **API access is enabled in xMatters**
- Check **network or proxy restrictions**

You have successfully authenticated the xMatters Connector in Swimlane.

**Sources**

- xMatters API Documentation (Official): [https://help.xmatters.com](https://help.xmatters.com)
- xMatters OAuth Documentation: [https://help.xmatters.com/xmapi/](https://help.xmatters.com/xmapi/)