Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

xMatters Events API

The Events API from xMatters — 3 operation(s) for events.

xMatters Events API is one of 11 APIs that xMatters publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Events. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 3 paths. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against a single base URL, https://{company}.{deployment}.xmatters.com/api/xm/1.

6 operations 3 paths 0 schemas 3 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://{company}.xmatters.com/api/xm/1
Authentication
HTTP Basic, OAuth 2.0
Resource Areas
1

Authentication & Security 2

xMatters Events API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (BasicAuth). It supports OAuth 2.0 (OAuth2) using the password flow. By default, every request must be authenticated.

  • BasicAuth — HTTP Basic authentication using a username and password or API key.

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 3 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Events 6
GET
/events
Retrieve a list of events
listEvents → 200
POST
/events
Trigger a new event
createEvent → 201
GET
/events/{eventId}
Retrieve a specific event
getEvent 1 param → 200
PUT
/events/{eventId}
Change the status of an event
updateEvent 1 param → 200
GET
/events/{eventId}/annotations
Retrieve annotations on an event
listEventAnnotations 1 param → 200
POST
/events/{eventId}/annotations
Add a comment to an event
createEventAnnotation 1 param → 201

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xmatters-events-api-openapi.yml Raw ↑

Other APIs xMatters publishes across the network.

xMatters REST API
xMatters Devices API
xMatters Groups API
xMatters Integrations API
xMatters OnCall API
xMatters People API
xMatters Plans API
xMatters Scenarios API
xMatters Services API
xMatters Shifts API