Actions

API endpoints for actions

Manage incident actions.

Incident actions are used during an incident, to track work such as ‘restart the database’ or ‘contact the customer’.

You can manage actions in the incident Slack channel with /incident actions, or on the incident homepage.

The action object

created_at · string<date-time> · required

When the action was created

Example:

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

creator · object · required

Show child attributes

Example:

{
  "alert": {
    "id": "01GW2G3V0S59R238FAHPDS1R66",
    "title": "*errors.withMessage: PG::Error failed to connect"
  },
  "api_key": {
    "id": "01FCNDV6P870EA6S7TK1DSYDG0",
    "name": "My test API key"
  },
  "user": {
    "email": "[e-mail]",
    "id": "01FCNDV6P870EA6S7TK1DSYDG0",
    "name": "Lisa Karlin Curtis",
    "role": "owner",
    "slack_user_id": "U02AYNF2XJM"
  },
  "workflow": {
    "id": "01FCNDV6P870EA6S7TK1DSYDG0",
    "name": "My little workflow"
  }
}

description · string · required

Description of the action

Example:

"Call the fire brigade"

id · string · required

Unique identifier for the action

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

incident_id · string · required

Unique identifier of the incident the action belongs to

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

status · enum<string> · required

Status of the action

Available options: outstanding, completed, deleted, not_doing

Example:

"outstanding"

updated_at · string<date-time> · required

When the action was last updated

Example:

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

assignee · object

Show child attributes

Example:

{
  "email": "[e-mail]",
  "id": "01FCNDV6P870EA6S7TK1DSYDG0",
  "name": "Lisa Karlin Curtis",
  "role": "owner",
  "slack_user_id": "U02AYNF2XJM"
}

completed_at · string<date-time>

When the action was completed

Example:

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