Incidents V1

Create and read incidents.

Incidents are a core resource, on which many other resources (actions, etc) are created.

Care should be taken around these endpoints, as automation that creates duplicate incidents can be distracting, and impact reporting.

List Incidents V1Deprecated

List all incidents for an organisation.

Request
query Parameters
page_size
integer <int64> <= 500
Default: 25

Integer number of records to return

Example: page_size=25
after
string

An record's ID. This endpoint will return a list of records after this ID in relation to the API response order.

Example: after=01FDAG4SAP5TYPT98WGR2N7W91
status
Array of strings

Filter for incidents in these statuses

Examples:
status=declined
Responses
200

OK response.

get/v1/incidents
Request samples 
Response samples 
application/json
{
  • "incidents": [
    ],
  • "pagination_meta": {
    }
}
Create Incidents V1Deprecated
Create a new incident.


Request 
Request Body schema: application/json
required
Array of objects (CustomFieldEntryPayloadV1) 
Set the incident's custom fields to these values


 
idempotency_key
required
string
Unique string used to de-duplicate incident create requests


 
Array of objects (IncidentRoleAssignmentPayloadV1) 
Assign incident roles to these people


 
incident_type_id
string
Incident type to create this incident as


 
mode
string
Whether the incident is real or test


 Enum: "real" "test"  
name
string
Explanation of the incident


 
severity_id
string
Severity to create incident as


 
slack_team_id
string
ID of the Slack team / workspace. This is only required if you are using a Slack Enterprise Grid with multiple teams.


 
source_message_channel_id
string
Channel ID of the source message, if this incident was created from one


 
source_message_timestamp
string
Timestamp of the source message, if this incident was created from one


 
status
string
Current status of the incident


 Enum: "triage" "investigating" "fixing" "monitoring" "closed" "declined"  
summary
string
Detailed description of the incident


 
visibility
required
string
Whether the incident should be open to anyone in your Slack workspace (public), or invite-only (private). For more information on Private Incidents see our help centre.


 Enum: "public" "private"  
Responses 
200
OK response.


post/v1/incidents
Request samples 
application/json
{
  • "custom_field_entries": [
    ],
  • "idempotency_key": "alert-uuid",
  • "incident_role_assignments": [
    ],
  • "incident_type_id": "01FH5TZRWMNAFB0DZ23FD1TV96",
  • "mode": "real",
  • "name": "Our database is sad",
  • "severity_id": "01FH5TZRWMNAFB0DZ23FD1TV96",
  • "slack_team_id": "T02A1FSLE8J",
  • "source_message_channel_id": "C02AW36C1M5",
  • "source_message_timestamp": "1653650280.526509",
  • "status": "triage",
  • "summary": "Our database is really really sad, and we don't know why yet.",
  • "visibility": "public"
}
Response samples 
application/json
{
  • "incident": {
    }
}
Show Incidents V1Deprecated
Get a single incident.


Request 
path Parameters
id
required
string
Unique identifier for the incident


 
 Example:  01FDAG4SAP5TYPT98WGR2N7W91
Responses 
200
OK response.


get/v1/incidents/{id}
Request samples 
Response samples 
application/json
{
  • "incident": {
    }
}
➔ Next to Incidents V2