Skip to main content
POST
/
v1
/
incident_roles
Create
curl --request POST \
  --url https://api.incident.io/v1/incident_roles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "The person currently coordinating the incident",
  "instructions": "Take point on the incident; Make sure people are clear on responsibilities",
  "name": "Incident Lead",
  "required": false,
  "shortform": "lead"
}
'
{
  "incident_role": {
    "created_at": "2021-08-17T13:28:57.801578Z",
    "description": "The person currently coordinating the incident",
    "id": "01FCNDV6P870EA6S7TK1DSYDG0",
    "instructions": "Take point on the incident; Make sure people are clear on responsibilities",
    "name": "Incident Lead",
    "required": false,
    "role_type": "lead",
    "shortform": "lead",
    "updated_at": "2021-08-17T13:28:57.801578Z"
  }
}

Authorizations

​
Authorization
string
header
required

API key from your incident.io dashboard (Settings → API keys)

Body

application/json
​
description
string
required

Describes the purpose of the role

Minimum string length: 1
Example:

"The person currently coordinating the incident"

​
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"

​
required
boolean
required

DEPRECATED: this will always be false.

Example:

false

​
shortform
string
required

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

Example:

"lead"

Response

201 - application/json

Created response.

​
incident_role
object
required
Example:
{
  "created_at": "2021-08-17T13:28:57.801578Z",
  "description": "The person currently coordinating the incident",
  "id": "01FCNDV6P870EA6S7TK1DSYDG0",
  "instructions": "Take point on the incident; Make sure people are clear on responsibilities",
  "name": "Incident Lead",
  "required": false,
  "role_type": "lead",
  "shortform": "lead",
  "updated_at": "2021-08-17T13:28:57.801578Z"
}