Incident Management API

Returns all active incidents across all process instances. Filter by instance, process definition, or error type.

Query parameters

Parameter	Type	Description
processInstanceKey	string	Filter to a specific process instance.
processDefinitionKey	string	Filter to all instances of a process definition.
errorType	string	Filter by error type: JOB_NO_RETRIES, EXTRACT_VALUE_ERROR, CONDITION_ERROR.
size	integer	Page size, default 20, max 100.

Example response 200 OK

{
  "incidents": [
    {
      "key": "inc_aaa111",
      "errorType": "JOB_NO_RETRIES",
      "errorMessage": "Stripe timeout after 3 retries",
      "processInstanceKey": "pi_111",
      "processDefinitionKey": "payment-process",
      "jobKey": "job_xyz789",
      "elementId": "task_charge",
      "createdAt": "2026-04-06T09:05:00Z",
      "state": "ACTIVE"
    }
  ],
  "total": 1
}

Returns full details for a single incident by its key.

Marks the incident as resolved and resumes the stalled element. Typically called after you have fixed the underlying issue (e.g. incremented job retries or corrected a variable).

No request body required. Returns 204 No Content on success.

Sets the retry count for a job. Usually called before resolving an incident to give the job more attempts.

Request body

Field	Type	Description
retries	integer	New retry count (must be ≥ 1 to allow re-execution).

Example workflow

# 1. Set retries back to 3
POST /api/v1/jobs/job_xyz789/update-retries
{ "retries": 3 }

# 2. Resolve the incident to resume
POST /api/v1/incidents/inc_aaa111/resolve