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

Instatus

Post to and update maintenance and incidents on your status page through an HTTP REST API

This event API exposes 3 operations across 3 channels, and defines 18 schemas. It is described by AsyncAPI 2.6.0, at version 1.0.0.

The API connects through a single server, {webhookUrl} (https).

3 operations 3 channels 18 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification
AsyncAPI 2.6.0
API Version
1.0.0
Base URL
https://instatus.com/help/api
Contact
Resource Areas
1

Channels & Operations 3

Across 3 channels, the API surfaces 3 operations. Each is listed below with its action, channel, parameters, and response codes.

Channels 3
SUB
incident
Receive an incident lifecycle event.
receiveIncidentEvent body
SUB
maintenance
Receive a maintenance lifecycle event.
receiveMaintenanceEvent body
SUB
component
Receive a component status change event.
receiveComponentEvent body

Messages & Schemas 18

The contract defines 18 schemas that model the data carried by its messages. The most detailed are Maintenance (11 properties), Incident (10 properties), IncidentUpdate (6 properties), MaintenanceUpdate (6 properties). Each schema is shown below with its type and property counts.

IncidentEvent
message
Fired when an incident is added or updated.
MaintenanceEvent
message
Fired when a scheduled maintenance is added or updated.
ComponentEvent
message
Fired when a component's status changes.
WebhookHeaders
object
2 properties 2 required
Meta
object
Common metadata included on every webhook payload.
2 properties
Page
object
Status page summary included on every webhook payload.
4 properties
IncidentStatus
string
Incident lifecycle status.
MaintenanceStatus
string
Maintenance lifecycle status.
ComponentStatus
string
Component operational status.
IncidentUpdate
object
6 properties
Incident
object
10 properties
MaintenanceUpdate
object
6 properties
Maintenance
object
11 properties
Component
object
4 properties
ComponentUpdate
object
3 properties
IncidentPayload
object
3 properties 3 required
MaintenancePayload
object
3 properties 3 required
ComponentPayload
object
4 properties 4 required

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

webhooks-asyncapi.yml Raw ↑