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	Audit types xMatters REST API
Audits	Get event audit information xMatters REST API
Devices	Get a device xMatters REST API
	Get devices xMatters REST API
	Create a device xMatters REST API
	Modify a device xMatters REST API
	Delete a device xMatters REST API
Device Names	Get device names xMatters REST API
Device Types	Get device types xMatters REST API
Dynamic Teams	Get dynamic teams xMatters REST API
	Get a dynamic team xMatters REST API
	Get dynamic team members xMatters REST API
	Create a dynamic team xMatters REST API
	Update a dynamic team xMatters REST API
	Delete a dynamic team xMatters REST API
Events	Get events xMatters REST API
	Get an event xMatters REST API
	Get event annotation xMatters REST API
	Get user delivery data xMatters REST API	See Get notifications for information on the deprecated method that returned event notifications.
	Get user delivery data xMatters REST API
	Trigger an event xMatters REST API	See POST trigger for information on the deprecated method that called the form directly.
	Add a comment to an event xMatters REST API
	Change event status xMatters REST API
	Get a list of notifications Additional REST Endpoints
Event Suppressions	Get suppressed events xMatters REST API
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
	Get form sections 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 a group's supervisors xMatters REST API
Group Roster	Get the group roster xMatters REST API
	Add a member to the group roster xMatters REST API
	Remove a group member xMatters REST API
Import Jobs	Get import jobs xMatters REST API
	Get an import job xMatters REST API
	Get import job messages xMatters REST API
Integrations	Get an integration xMatters REST API
	Get integrations xMatters REST API
	Get integration logs xMatters REST API
	Create an integration xMatters REST API
	Modify an integration xMatters REST API
	Delete an integration xMatters REST API
OAuth	Obtain an access token and refresh token xMatters REST API
	Authorize a request xMatters REST API
	Refresh an access token xMatters REST API
On-call	Get who is on call xMatters REST API	Get who is on call (deprecated)
On-call Summary	Get on-call summary xMatters REST API
People	Get a person (by id) xMatters REST API
	Get a person (by query) 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 a person's groups xMatters REST API
	Get a person's supervisors xMatters REST API
Plans	Get plans xMatters REST API
	Get a plan xMatters REST API
	Create a plan xMatters REST API
	Modify a plan xMatters REST API
	Delete a plan xMatters REST API
Plan Constants	Get plan constants xMatters REST API
	Create a plan constant xMatters REST API
	Modify a plan constant xMatters REST API
	Delete a plan constant xMatters REST API
Plan Endpoints	Get endpoint xMatters REST API
	Create endpoint xMatters REST API
	Modify endpoint xMatters REST API
	Delete a plan endpoint xMatters REST API
Plan Properties	Get plan properties xMatters REST API
	Create plan properties xMatters REST API
	Modify plan properties xMatters REST API
Roles	Get roles xMatters REST API
Scenarios	Get a scenario xMatters REST API
	Get scenarios xMatters REST API
	Create a scenario xMatters REST API
	Modify a scenario xMatters REST API
Shared Libraries	Get a shared library xMatters REST API
	Get shared libraries xMatters REST API
	Create a shared library xMatters REST API
	Modify a shared library xMatters REST API
	Delete a shared library 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 a site xMatters REST API	Create a site, Modify site (deprecated)
	Modify or update a site xMatters REST API
	Delete a site xMatters REST API
Subscription Forms	Get a subscription form xMatters REST API
	Get subscription forms xMatters REST API
	Get subscription forms in a plan xMatters REST API
	Create a subscription form xMatters REST API
	Modify a subscription form xMatters REST API
Subscriptions	Get subscriptions xMatters REST API
	Get a subscription xMatters REST API
	Create a subscription xMatters REST API
	Get subscription subscribers xMatters REST API
	Modify a subscription xMatters REST API
	Delete a subscription xMatters REST API
	Unsusbcribe a user 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
User Uploads	Upload Users xMatters REST API
User Uploads	Upload Epic ZipSync xMatters REST API

SOAP web services

Before the xMatters REST API became available, many integrations relied on the Simple Object Access Protocol (SOAP) web services. Developed primarily as an interface for premises-based deployments, the SOAP API allowed remote function calls to the xMatters system via HTTP requests using SOAP syntax and formatting.

We've officially moved on from the SOAP API (meaning it's officially no longer supported and has been deprecated), so you should use the xMatters REST API going forward.