Comment on Incident

POST /api/im/incidents/:id/comment

Adds a free-text comment to the incident's timeline (an event of kind comment, visible in events of Get Incident). Outbound integrations are notified of the comment, and subscribers of a status page driven by a status page rule may receive it as an update. Comments are accepted on closed incidents too.

AuthenticationCopy Anchor Link

Any IM-eligible role (admin, editor, responder) or an organization-wide API token, see Authentication. Incident Management must be enabled for the organization. There is no team restriction.

Request BodyCopy Anchor Link

Example (cURL)Copy Anchor Link

curl -X POST "$BASE_URL/api/im/incidents/42/comment" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "text": "Failover to the replica is running, ETA 10 minutes." }'

ResponseCopy Anchor Link

200 OK

{
  "ok": true
}

Common errorsCopy Anchor Link

• 401 Unauthorized when not authenticated
• 403 Forbidden (customerScopedTokenForbidden) when using a customer-scoped token
• 403 Forbidden (imAccessDenied) when the session user has no IM-eligible role
• 403 Forbidden (imNotEnabled) when Incident Management is not enabled for the organization
• 400 Bad Request (invalidRequestBody) when :id is not a positive integer, or text is missing, blank or longer than 10,000 characters
• 404 Not Found (imIncidentNotFound) when the incident does not exist, or belongs to another organization