Introduction to xMatters REST APIs

xMatters provides REST APIs that you can use to integrate with xMatters using any programming language that has the ability to make HTTP requests.

  • xMatters REST API: The xMatters REST API is currently under development and new functionality is added to it on an ongoing basis. For more information about working with the xMatters REST API, see xMatters REST API.
  • Additional REST Endpoints: Our previous REST API implementation has some functionality not yet implemented in the xMatters REST API. For more information about working with the additional REST API methods, see Additional REST API methods.

Available endpoints

The xMatters REST API and the Additional REST methods are accessed with different URLs and have slightly different usage patterns. Refer to the documentation for each API to learn about authentication, error codes, results pagination and versioning as it applies to each API. The following table summarizes the actions available in the REST APIs.

CATEGORY ENDPOINT NOTES
Audits

Get event audit information

xMatters REST API

 

Calendar

Get who is on call

xMatters REST API

See Get who is on call

(deprecated)

Devices

Get a device

xMatters REST API

 

Create a device

xMatters REST API

 

Modify a device

xMatters REST API

 

Delete a device

xMatters REST API

 
Device Types

Get device types

xMatters REST API

 
Device Names

Get device names

xMatters REST API

 
Events

Initiate an event

xMatters REST API

See POST trigger for information on the deprecated method that called the form directly.

Get a list of events

xMatters REST API

 

Get an event

xMatters REST API

 

Suspend, resume, and stop an event

xMatters REST API

 

Get a list of comments added to an event

xMatters REST API

 

Get a comment added to an event

xMatters REST API

 

Add a comment to an event

xMatters REST API

At the moment, comments added using this endpoint won't trigger outbound integrations that use the Event Comments trigger. But it's on our roadmap, and we plan to roll it out down the road. When we do turn it on, comments added using this endpoint will trigger those integrations. Keep an eye on our News & Updates page — we'll post there before we roll it out.

Get a list of notifications

Additional REST Endpoints

 
Forms

Subscribe to a form

Additional REST Endpoints

 

Set the value of form properties

Additional REST Endpoints

 
Get forms

xMatters REST API

 
Get forms in a plan

xMatters REST API

 
Get form response options

xMatters REST API

 
Groups

Get a group

xMatters REST API

 

Create a group

xMatters REST API

 

Modify a group

xMatters REST API

 

Delete a group

xMatters REST API

 

Get groups

xMatters REST API

 

Get the group roster

xMatters REST API

 

Add a member to the group roster

xMatters REST API

 

Remove a group member

xMatters REST API

 
Integrations

Get shared libraries

xMatters REST API

 

Get a shared library

xMatters REST API

 
Create a shared library

xMatters REST API

 
Modify a shared library

xMatters REST API

 
On-call

Get who is on call

xMatters REST API

Get who is on call

(deprecated)

People

Get a person

xMatters REST API

 

Get people

xMatters REST API

 

Create a person

xMatters REST API

 

Modify a person

xMatters REST API

 

Delete a person

xMatters REST API

 

Get a person's devices

xMatters REST API

 

Get groups a person belongs to

xMatters REST API

 

Get a person's supervisors

xMatters REST API

 
Plans

Get plans

xMatters REST API

 

Get a plan

xMatters REST API

 

Get constants

xMatters REST API

 

Get endpoints

xMatters REST API

 
Shifts

Get a shift

xMatters REST API

 

Get shifts in a group

xMatters REST API

 

Get members in a shift

xMatters REST API

 

Create a shift

xMatters REST API

 

Add a member to a shift

xMatters REST API

 

Delete a shift

xMatters REST API

 
Sites

Get a site

xMatters REST API

 

Get sites

xMatters REST API

Get sites

(deprecated)

Create or update a site

xMatters REST API

Create a site, Modify site

(deprecated)

Subscription Forms Get a subscription form
xMatters REST API
 
Get subscription forms
xMatters REST API
 
Get subscription forms in a plan
xMatters REST API
 
Temporary Absences Get temporary absences
xMatters REST API
 
Create a temporary absence
xMatters REST API
 
Delete a temporary absence
xMatters REST API