Skip to main content
POST
Create incident

Restrictions

Usage

  • Without an account create form, only incident_severity is required.
  • When the account has a create form, title (non-blank), channel_id and assigned_to become required, fields may contain only custom fields visible in the form, and the form’s required fields must be filled.
  • Images can be attached only when the create form contains an image-upload element (at most 10 images): send multipart/form-data with the JSON request in data and files in images; the whole request must not exceed 50 MiB.
  • Assignment runs after the incident is created. Without assigned_to, the channel’s escalation rules decide; a standalone incident with no assigned_to gets no responders. If assignment fails (for example an out-of-range layer_idx), the incident is still created, without responders.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

Parameters for manually creating an incident.

incident_severity
enum<string>
required

Incident severity: Info, Warning or Critical (most severe).

Available options:
Info,
Warning,
Critical
title
string

Incident title, up to 512 characters. Required (non-blank) when the account has a create form.

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; must exist in the account. Optional unless the account has a create form; leave it unset for a standalone incident.

assigned_to
object

Who to assign. When omitted or empty, the channel's escalation rules decide (a standalone incident gets no responders); required when the account has a create form. person_ids, team_ids, escalate_rule_id and emails can be combined — responders are the union. Assignment runs after creation, and its failure does not undo the incident.

fields
object

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

labels
object

Labels to store on the created incident, up to 50 entries. Blank values are dropped. Spaces and selected punctuation in keys become _; keys and values are trimmed, and values are truncated at 8 KiB.

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

Result of manually creating an incident.