Skip to documentation
InBrief

Create an incident in one request.

Developer quickstart · live playground

Send a scoped, authenticated request from the documentation and inspect the real response before moving the same request into your server, CI runner or protected worker.

REST APIServer-side integration201 Created
Prerequisite
A temporary API key scoped to one status page.
Endpoint
POST /api/v1/incidents
Success
A 201 response containing the new incident id.
POSTLive API playgroundSame origin · live write
ResponseNot sent
Run a request to inspect its status, timing and response body.

$NOW becomes the current ISO time when sent. Running a create or update writes to the status page attached to this key; the monitor requests only read. The key is never saved; use a temporary scoped key and revoke it after testing.

Make one request, then pick the reference you need: the public read API, the incident and event write APIs, webhooks, or badges and feeds.

Start building

Base URLs, credentials and a first request you can check.

Developer quickstartBase URLs, credentials, retry rules and the first request. MCP connectionsTool permissions and client setup for connecting an AI client over MCP.

Read public status

Read the public page as JSON without a key.

Public Status APIRead current service health and the incident ledger as cached JSON. Public

Automate operations

Create incidents from your own systems, report what your application returned, or say a job ran.

Incident APICreate incidents, append updates and resolve them from your own systems. API Heartbeat pingsThe URL a cron job calls to say it started, finished or failed, and every response. API Database Health reportingREST server observations and optional pool reporters. Event APIReport application outcomes in batches for the private operational view. API

Integrate and extend

Signed webhooks for your receivers, and badges and feeds for other tools.

WebhooksVerify signatures, process event types and handle delivery retries. Events Badges and feedsUse public badges, JSON status and lifecycle feeds in another surface. Public
Last reviewed October 15, 2026Was this helpful? Get help troubleshooting