Skip to main content
POST
Create
🔑 Requires the incidents.create scope.

Authorizations

Authorization
string
header
required

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

Body

application/json
idempotency_key
string
required

Unique string used to de-duplicate incident create requests

Example:

"alert-uuid"

visibility
enum<string>
required

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 docs.

Available options:
public,
private
Example:

"public"

custom_field_entries
object[]

Set the incident's custom fields to these values

Example:
incident_role_assignments
object[]

Assign incident roles to these people

Example:
incident_type_id
string

Incident type to create this incident as

Example:

"01FH5TZRWMNAFB0DZ23FD1TV96"

mode
enum<string>

Whether the incident is real or test

Available options:
real,
test
Example:

"real"

name
string

Explanation of the incident

Example:

"Our database is sad"

severity_id
string

Severity to create incident as

Example:

"01FH5TZRWMNAFB0DZ23FD1TV96"

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.

Example:

"T02A1FSLE8J"

source_message_channel_id
string

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

Example:

"C02AW36C1M5"

source_message_timestamp
string

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

Example:

"1653650280.526509"

status
enum<string>

Current status of the incident

Available options:
triage,
investigating,
fixing,
monitoring,
closed,
declined
Example:

"triage"

summary
string

Detailed description of the incident

Example:

"Our database is really really sad, and we don't know why yet."

Response

200 - application/json

OK response.

incident
object
required
Example: