Incident kommentieren

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

Fügt der Timeline des Incidents einen Freitext-Kommentar hinzu (ein Event der Art comment, sichtbar in events von Incident abrufen). Ausgehende Integrationen erfahren vom Kommentar, und Abonnenten einer Statusseite, die über eine Statusseiten-Regel gesteuert wird, können ihn als Update erhalten. Auch geschlossene Incidents nehmen Kommentare an.

AuthentifizierungAnkerlink kopieren

Jede IM-berechtigte Rolle (admin, editor, responder) oder ein organisationsweiter API-Token, siehe Authentifizierung. Incident Management muss für die Organisation aktiviert sein. Es gibt keine Team-Einschränkung.

Anfrage (Request Body)Ankerlink kopieren

Beispiel (cURL)Ankerlink kopieren

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." }'

Antwort (Response)Ankerlink kopieren

200 OK

{
  "ok": true
}

Häufige FehlerAnkerlink kopieren

• 401 Unauthorized wenn du nicht authentifiziert bist
• 403 Forbidden (customerScopedTokenForbidden) bei Verwendung eines kunden-gescopten Tokens
• 403 Forbidden (imAccessDenied) wenn die angemeldete Person keine IM-berechtigte Rolle hat
• 403 Forbidden (imNotEnabled) wenn Incident Management für die Organisation nicht aktiviert ist
• 400 Bad Request (invalidRequestBody) wenn :id keine positive Ganzzahl ist, oder text fehlt, leer ist oder länger als 10.000 Zeichen
• 404 Not Found (imIncidentNotFound) wenn der Incident nicht existiert oder zu einer anderen Organisation gehört