Post an update to an incident on a status page.

POST

/status_page/{status_page_id}/incident/{incident_id}/update

curl --request POST \
  --url https://api.siteqwality.com/status_page/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/incident/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "status": "investigating", "message": "example", "visibility": "public", "notify_subscribers": true, "force": true }'

• Production

Public by default: it sets the incident’s public status (omitted keeps it), and resolved resolves it. Moving the status backwards returns 409 unless force is set. The path page’s subscribers are emailed unless notify_subscribers is false. An internal update shows only in the app.

Authorizations

• bearer_auth

Parameters

Path Parameters

status_page_id

required

string format: uuid

Status page identifier

incident_id

required

string format: uuid

Incident identifier

Request Body ^required

Media type application/json

object

status

One of:

string

The new public status for a public update; omitted keeps it. An internal update never changes it, and resolved there is a 400 (use resolve).

string

Allowed values: investigating identified monitoring resolved

null

null

message

required

string

visibility

One of:

string

public (default) or internal. Only public updates reach status pages and their subscribers; the app’s own composer sends internal unless asked to publish.

string

Allowed values: public internal

null

null

notify_subscribers

Email status page subscribers about a public update. Default true on the status page route (that page only), false on /incident/{id}/update (true there emails every page).

boolean | null

force

Post even when this moves the status backwards (otherwise 409).

boolean

Responses

201

Incident update added

Media type application/json

object

id

required

string format: uuid

status

required

The public status when it was posted.

string

Allowed values: investigating identified monitoring resolved

message

required

string

created_at

required

string format: date-time

visibility

required

public updates show on status pages; internal ones only here.

string

Allowed values: public internal

author_user_id

Who posted it; null for the system, API keys and older updates.

string | null format: uuid

Example

{
  "status": "investigating",
  "visibility": "public"
}

400

Invalid request body, or an internal update with status resolved

401

Missing or invalid authentication

404

Status page or incident not found, or the incident is not on that page

409

The status would move backwards, or the incident is resolved; data holds its current state

500

Internal server error