Skip to content

Incident Update

Incident Update represents single update for Incident.
Every Incident consists of at least one Incident Update and a resolved incident consists of at least two Incident Updates where the second one has resolved incident type.

Operations

Create an Incident Update

Request

Creates a new Incident Update.
Incident Update is a distinct update in an Incident. Creation of Incident Update records is a way to add new update to an existing Incident.

Security
ApiKeyAuth
Path
subdomainstringrequired

Unique subdomain of requested Hub.

incident_idintegerrequired

id of the requested incident.

Query
api_versionstring

Api version

Value:"V3-R1"
Bodyapplication/json
titlestringrequired

Title of this update.
Can contain only plain text.
Setting title to value different from current title of Incident may result in changing of Incident title.
Incident title equals to title of latest (by start_time) published (not draft) Incident Update title.

start_timestring or null, (date-time)required

Timestamp of event start.
Can't be in future.
ISO8601 formatted time (UTC).

Example:"2020-09-01T08:29:00Z"
incident_typestringrequired

Type of Incident Update.
Exact meaning may depend on use case and there is just one restriction:
resolved can't be used as type of a first (by start_time) Incident Update.

Enum:"investigating""identified""monitoring""resolved"
Example:"investigating"
service_statusesArray of objects

Describes affected services and their statuses.
This parameter is required unless incident_type is resolved, in which case it is forbidden because resolving an incident automatically sets all affected services to up status for this incident.

bodystring
Default:""
Example:"Message for an event or event update.<br>\nMay contain basic HTML tags.\n"
silentboolean

When true notifications are not being sent to subscribers.
Does not impact draft notifications for Team Members.

Default:false
statestring or null

State of Incident or Incident Update:

  • draft - Not published on Hub Page,
  • unconfirmed - Published on Hub Page but marked as unconfirmed,
  • published - Published on Hub Page.
Default:"published"
Enum:"draft""unconfirmed""published"
Example:"published"

Basic example of creating incident update affecting two services.

curl -i -X POST \
  'https://subdomain-of-your-account.app.statushub.io/api/v3/hubs/{subdomain}/incidents/{incident_id}/incident_updates?api_version=V3-R1' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "title": "Example incident title",
    "start_time": "2025-05-02 12:34:56",
    "incident_type": "investigating",
    "body": "Incident body<br>with basic HTML tags.",
    "service_statuses": [
      {
        "service_id": 17363,
        "status": "degraded-performance"
      },
      {
        "service_id": 17155,
        "status": "down"
      }
    ]
  }'

Responses

OK

Bodyapplication/json
idinteger, >= 1
Example:25
authorstring or null

Author email

titlestring

Title of this update. May be different from current incident title.
Incident title may be changed during the duration of incident and therefore some updates may reflect previous title.

bodystring
Default:""
Example:"Message for an event or event update.<br>\nMay contain basic HTML tags.\n"
created_atstring, (date-time)

Timestamp of record creation.
ISO8601 formatted time (UTC).

Example:"2020-09-01T08:29:00Z"
start_timestring, (date-time)

Timestamps of a Incident Update.
ISO8601 formatted time (UTC).

Example:"2020-09-01T08:29:00Z"
updated_atstring, (date-time)

Timestamp of last modification of record.
ISO8601 formatted time (UTC).

Example:"2020-09-01T08:29:00Z"
incident_typestring

Type of Incident Update.
Exact meaning may depend on use case and there is just one restriction:
resolved can't be used as type of a first (by start_time) Incident Update.

Enum:"investigating""identified""monitoring""resolved"
Example:"investigating"
statestring or null

State of Incident or Incident Update:

  • draft - Not published on Hub Page,
  • unconfirmed - Published on Hub Page but marked as unconfirmed,
  • published - Published on Hub Page.
Default:"published"
Enum:"draft""unconfirmed""published"
Example:"published"
service_statusesArray of objects
flagsBasic flags (object) or Extended flags (object)
One of:
Response
{
  "id": 25,
  "author": "string",
  "title": "string",
  "body": "Message for an event or event update.<br>\nMay contain basic HTML tags.\n",
  "created_at": "2020-09-01T08:29:00Z",
  "start_time": "2020-09-01T08:29:00Z",
  "updated_at": "2020-09-01T08:29:00Z",
  "incident_type": "investigating",
  "state": "published",
  "service_statuses": [
    { … }
  ],
  "flags": {
    "deleted": true,
    "draft": true
  }
}