Saltar al contenido

Retry a failed automation run

Módulo Platform

POST/automation-runs/{id}/retryautomationRuns.retry

Queues a failed run again through `app.retry_automation_run`; steps that succeeded are not run again. The automation must be on (automation_off: 422) and the run Failed (automation_run_not_failed: 422). Needs org.automations.write. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

  • Requiere la capacidad org.automations.write.
  • Alcances de OAuth: org.
  • Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
  • Estados de error: 400, 401, 404, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

automationRuns.retry: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the automation run.

Respuesta 200: AutomationRun

automationRuns.retry: AutomationRun
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the automation run.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row.
automation_idstring (uuid)SíIdentifier of the automation that ran.
domain_event_idstring (uuid)SíIdentifier of the domain event that started the run.
parent_run_idstring (uuid) | nullSíIdentifier of the run whose action raised the event, when an automation caused it.
depthintegerSíAutomation runs that led to this one; 0 for an event a person raised.Restricciones: range 0 to any
run_status"Queued" | "Running" | "Retrying" | "Succeeded" | "Failed" | "Skipped"SíQueued, Running, Retrying after a failure the job queue retries with backoff, Succeeded, Failed, or Skipped (loop_depth, rate_limited, or the automation was off).
event_payloadobjectSíThe event as webhooks send it: the run's input.
owner_person_idstring (uuid) | nullSíIdentifier of the person the run acted as.
attemptsintegerSíTimes the worker started the run.Restricciones: range 0 to any
error_codestring | nullSíRule code of the failure or skip.Restricciones: pattern ^[a-z][a-z0-9_]*$
error_messagestring | nullSíWhy the run failed or was skipped.Restricciones: length 1 to 2000
started_atstring (date-time) | nullSíWhen the worker first started the run.
finished_atstring (date-time) | nullSíWhen the run reached Succeeded, Failed or Skipped.
duration_msinteger | nullSíMilliseconds from the first start to the end.Restricciones: range 0 to any
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "automation_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "domain_event_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "parent_run_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "depth": 0,
  "run_status": "Queued",
  "event_payload": {
    "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "type": "record.created",
    "occurred_at": "2026-10-08T14:30:00Z",
    "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "subject": {
      "table": "records",
      "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
    },
    "data": {
      "record_kind": "Task",
      "title": "Call the venue"
    }
  },
  "owner_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "attempts": 1,
  "error_code": "owner_left_org",
  "error_message": "The API answered 503.",
  "started_at": "2026-10-08T14:30:00Z",
  "finished_at": "2026-10-08T14:30:00Z",
  "duration_ms": 840
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/automation-runs/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/retry" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"
const { data } = await xos.automationRuns.retry("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.automation_runs.retry("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos automation-runs retry 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f