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_status_id
string

Incident status to assign to the incident

Example:

"01G0J1EXE7AXZ2C93K61WBPYEH"

incident_timestamp_values
object[]

Assign the incident's timestamps to these values

Example:
incident_type_id
string

Incident type to create this incident as

Example:

"01FH5TZRWMNAFB0DZ23FD1TV96"

mode
enum<string>

Whether the incident is real, a test, a tutorial, or importing as a retrospective incident

Available options:
standard,
retrospective,
test,
tutorial
Example:

"standard"

name
string

Explanation of the incident

Example:

"Our database is sad"

retrospective_incident_options
object
Example:
severity_id
string

Severity to create incident as

Example:

"01FH5TZRWMNAFB0DZ23FD1TV96"

slack_channel_name_override
string

Name of the Slack channel to create for this incident

Example:

"inc-123-database-down"

slack_team_id
string

Slack Team to create the incident in

Example:

"T02A1FSLE8J"

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