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 roles. During an incident, you can assign responders to one of the incident roles that are configured in your organisation settings. Every organisation will have a special ‘lead’ role, which signifies the incident lead or commander. This role cannot be deleted, but can be renamed in the incident.io dashboard.

​
The incident role object

​
created_at
string<date-time>
required

When the role was created

Example:

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

​
description
string
required

Describes the purpose of the role

Minimum string length: 1
Example:

"The person currently coordinating the incident"

​
id
string
required

Unique identifier for the role

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

​
instructions
string
required

Provided to whoever is nominated for the role. Note that this will be empty for the 'reporter' role.

Example:

"Take point on the incident; Make sure people are clear on responsibilities"

​
name
string
required

Human readable name of the incident role

Minimum string length: 1
Example:

"Incident Lead"

​
role_type
enum<string>
required

Type of incident role

Available options:
lead,
reporter,
custom
Example:

"lead"

​
shortform
string
required

Short human readable name for Slack. Note that this will be empty for the 'reporter' role.

Example:

"lead"

​
updated_at
string<date-time>
required

When the role was last updated

Example:

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