Skip to main content
POST
Create incident

Restrictions

Usage

  • When an account create form applies, its visible custom fields and required system values must be supplied.
  • To attach images, send multipart/form-data with the JSON request in data and files in images; the complete request must not exceed 50 MiB.
  • Audited — changes are recorded in the audit log.

Authorizations

app_key
string
query
required

App key issued from the Flashduty console under Account → APP Keys. Required on every public API call. Keep it secret — it grants the same access as the owning account.

Body

Parameters for manually creating an incident.

incident_severity
enum<string>
required

Incident severity.

Available options:
Info,
Warning,
Critical
title
string

Incident title, up to 512 characters.

Maximum string length: 512
description
string

Incident description, up to 1024 characters.

Maximum string length: 1024
channel_id
integer<int64>

Channel to file the incident into. Optional; leave unset for a standalone incident.

assigned_to
object

Incident assignment target. Either person_ids or escalate_rule_id must be provided.

fields
object

Custom field values keyed by field name. When a create form applies, only its visible fields are accepted.

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
required

Result of manually creating an incident.