Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.incident.io/llms.txt

Use this file to discover all available pages before exploring further.

Manage incident statuses. Each incident has a status, picked from one of the statuses configured in your organisations settings. Statuses help communicate where an incident is in its lifecycle. You can use statuses when filtering incidents in the dashboard, and in workflows and announcement rules.

​
The incident status object

​
category
enum<string>
required

What category of status it is. All statuses apart from live (renamed in the app to Active) and learning (renamed in the app to Post-incident) are managed by incident.io and cannot be configured

Available options:
triage,
declined,
merged,
canceled,
live,
learning,
closed,
paused
Example:

"triage"

​
created_at
string<date-time>
required
Example:

"2021-08-17T13:28:57.801578Z"

​
description
string
required

Rich text description of the incident status

Example:

"Impact has been **fully mitigated**, and we're ready to learn from this incident."

​
id
string
required

Unique ID of this incident status

Example:

"01FCNDV6P870EA6S7TK1DSYD5H"

​
name
string
required

Unique name of this status

Example:

"Closed"

​
rank
integer<int64>
required

Order of this incident status

Example:

4

​
updated_at
string<date-time>
required
Example:

"2021-08-17T13:28:57.801578Z"