---
title: "xMatters Integration Guide"
slug: "xmatters-integration-guide"
updated: 2023-01-06T15:48:57Z
published: 2023-01-06T15:48:57Z
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.catchpoint.com/llms.txt
> Use this file to discover all available pages before exploring further.

# xMatters Integration Guide

## Overview

xMatters automates and brings structure to communications so you can prevent outages, manage incidents, and keep the right people informed.

**Features:**

- 200+ integrations and REST APIs for everything else
- Notifications, instant conferencing, subscribe to alerts that matter to you, and alert suppression
- Configurable notifications – email, SMS, phone call, and native mobile app
- On-call Scheduling and Escalations
- Reporting – responses, team health, and operational dashboards

Catchpoint’s Alert Webhook allows Catchpoint to integrate with other tools such as xMatters by pushing data when a test triggers an alert. Any tool supporting Webhooks or providing a URL to POST data can be used.

Alert Webhook templates can be customized to fit a tool’s format and content-type using Macros. If a template needs modification, please contact Catchpoint Support. We are happy to assist you in creating a template that meets your requirements.

Alert Webhook Guide - [https://docs.catchpoint.com/docs/Alert-Webhook-Guide](https://docs.catchpoint.com/docs/Alert-Webhook-Guide)

## Integration Steps

### xMatters Setup

1. Log in to xMatters
2. Click on the **Webhook** icon under the **Integrations** widget on the home screen dashboard.
3. **Create** a new webhook **Configuration**.  

![](https://cdn.document360.io/cb4af8f9-6751-4fd2-b39c-07aae832badb/Images/Documentation/360004513211-mceclip0.png)
4. Enter configuration details.
5. Copy the **webhook URL** and **content template**.  

![](https://cdn.document360.io/cb4af8f9-6751-4fd2-b39c-07aae832badb/Images/Documentation/360004513651-mceclip3.png)

### Catchpoint Setup

1. Log in to the Catchpoint Portal and go to **Settings > API**
2. In the **Alert Webhook** section, enter the **webhook URL** that was provided when you created xMatters webhook.
3. The Alert format you need to choose is **Template**. Click **Add New** and you will be taken to the Edit Template window.
4. Give the template a **Name** and set the **Format** to **Text**.
5. The template here should follow the content template provided by xMatters. The **subject** and **message** fields support Catchpoint's Alert Macros.

```
{
    "properties": {
		"subject": "CP Alert -     	 ${switch('${notificationLevelId}','0','WARNING','1','CRITICAL','3','IMPROVED')}",  
		"message": "Test Type - ${TestType}, Test Name -   ${TestName}, TestURL - ${TestUrl}"
    }
}
```

![](https://cdn.document360.io/cb4af8f9-6751-4fd2-b39c-07aae832badb/Images/Documentation/360004516272-mceclip4.png) 6. **Save** the template and the Alert webhook setup.

### xMatters Two-way communication

This can be set up to send webhooks back to any application that can consume POST requests over HTTP. These outbound webhooks can be sent on any of these events:

- When an alert is triggered in Catchpoint and pushed to xMatters.
- When xMatters has delivered the notification via app, phone, SMS, email to intended recipients.
- When the recipient has responded to the incident.

This enbales you to send outbound messages related to the event to a status page or some type of program/software that can perform further actions (eg: AWS lambda, other incident management tools, etc)

## Other Useful Links

Alert Webhook Macro Index - ["https://docs.catchpoint.com/docs/ALERT WEBHOOK MACRO INDEX](https://docs.catchpoint.com/docs/ALERT WEBHOOK MACRO INDEX)[](https://docs.catchpoint.com/docs/ALERT WEBHOOK MACRO INDEX)

Other Integrations in Catchpoint - [https://docs.catchpoint.com/docs/integration-guides](https://docs.catchpoint.com/docs/integration-guides)

xMatter Webhook Support Page - [https://help.xmatters.com/integrations/other/webhooks.html](https://help.xmatters.com/integrations/other/webhooks.htm)