Skip to main content
POST
Add comment to incident

Restrictions

Usage

  • To mention a member, embed a markdown link in comment in the form [@Display Name](flashduty://ref/member/<member_id>). Mentioned members receive a dedicated personal notification, which is not affected by mute_reply.
  • Plain @name text without the link syntax does not create a mention.
  • The server rewrites each mention’s display label to the member’s canonical name.

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

application/json

Parameters for adding a comment to one or more incidents.

incident_ids
string[]
required

Incident IDs to comment on. At most 100 per call.

Required array length: 1 - 100 elements
Pattern: ^[0-9a-fA-F]{24}$
comment
string
required

Comment body. Leading and trailing whitespace is trimmed; the comment must be non-empty after trimming and at most 1024 characters (counted after @mention normalization).

Maximum string length: 1024
mute_reply
boolean

When true, do not trigger webhook reply actions for this comment.

comment_type_id
string | null

Optional ID of an account-level comment type to attach to the comment (MongoDB ObjectID). An invalid or all-zero ID is rejected with 400.

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

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

No payload. Depending on the operation, data is {} or omitted from the envelope; rely only on the HTTP 200 status and the absence of error.