Skip to main content
POST
Create a work item

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

application/json

Parameters for creating an incident work item.

item_type
enum<string>
required

action anchors to an active incident and must not set post_mortem_id; follow_up requires post_mortem_id.

Available options:
action,
follow_up
title
string
required

Item title (max 512 characters).

Maximum string length: 512
incident_id
string
required

Incident ID (MongoDB ObjectID) the item is anchored to.

Pattern: ^[0-9a-fA-F]{24}$
idempotency_key
string
required

Client-generated idempotency key (max 128 characters; letters, digits, _, -, ., : only).

Maximum string length: 128
Pattern: ^[A-Za-z0-9_\-.:]+$
description
string

Optional longer description (max 65,535 characters).

Maximum string length: 65535
status
string

Optional client-defined initial status (max 64 characters).

Maximum string length: 64
priority
string

Optional client-defined priority (max 64 characters).

Maximum string length: 64
post_mortem_id
string

Post-mortem ID (32-character hex string). Required for follow_up, forbidden for action. The post-mortem must be linked to incident_id.

assignee_ids
integer<int64>[]

Legacy alias for the initial assignees. Equivalent to assignees with every entry type person. Mutually exclusive with assignees: sending both returns an error. Assignees must be active members who can already read the anchor; assignment never grants access.

assignees
object[]

Initial assignees. Each entry is {type, id?}. type is person or ai_sre; an ai_sre entry omits id. Mutually exclusive with assignee_ids: sending both returns an error. assignee_ids is the legacy alias and is equivalent to an all-person list. At most 20 entries. Person assignees must be active members who can already read the anchor; assignment never grants access.

Maximum array length: 20

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 creating a work item.