SPspectate
Status page incidents

Save the write-up

Writes the incident's public write-up, in Markdown: what happened, why, and what changes. With published: true it shows on the public incident page; with false it's a draft only the team sees, and a published write-up is taken down. Publishing needs content (422).

Confirmed subscribers are emailed the write-up when this publishes it for the first time and notify_subscribers is true; saving a published write-up again never emails. A write-up keeps the time it was first published while you edit it.

put/status-pages/{statusPage}/incidents/{incident}/writeup

Request

  • Base URL
    https://api.spectate.net/v1
  • Auth
    HTTP bearer

Path parameters

statusPagestring uuid required

Status page ID.

incidentstring uuid required

Status page incident ID.

Request body

contentstring nullable

The write-up, in Markdown, at most 50,000 characters. Required to publish

publishedboolean required

true shows it on the public incident page; false keeps it as a draft, or takes a published write-up down

notify_subscribersboolean

Email confirmed subscribers when this publishes the write-up for the first time (default false). Edits to a published write-up are never emailed

Example request

{
  "content": "On 26 October, card payments failed for 18 minutes after a configuration change."
}

Response

The incident with its write-up.

idstring uuid required

Status page incident ID

titlestring required

Title shown on the page

status'investigating' | 'identified' | 'monitoring' | 'resolved' required

Where an incident stands.

investigating <br/> Declared; the cause isn't known yet.
identified <br/> Acknowledged: the cause is known and someone works on it.
monitoring <br/> A fix is out; watching whether it holds.
resolved <br/> Over.
impact'none' | 'degraded_performance' | 'partial_outage' | 'major_outage' required

An impact on a status page, including none: how an incident or maintenance affects a component, or an incident's overall impact.

none <br/> No impact (for a component: not affected).
degraded_performance <br/> Slower or less reliable than usual.
partial_outage <br/> Down for some visitors or some functions.
major_outage <br/> Down.
incident_idstring uuid nullable required

The team's incident that publishes to it; null for none

automatedboolean required

Opened by monitor automation and still managed by it, until someone posts an update or edits its timeline

resolved_atstring date-time nullable required

When it was resolved; null while open

created_atstring date-time required

When it was created

Example response

{
  "title": "Elevated API error rates",
  "updates": [
    {
      "body": "We found the cause and are rolling out a fix."
    }
  ],
  "affected_components": [
    {
      "component": {
        "name": "API"
      }
    }
  ],
  "impacts": [
    {
      "component": {
        "name": "API"
      }
    }
  ],
  "writeup": {
    "content": "On 26 October, card payments failed for 18 minutes after a configuration change."
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.