RevKeen Docs
Api reference

Retrieve a run

Get the details of a specific automation run including its steps and outputs.

Related endpoints

  • GET /automations — List automations
  • POST /automations — Create an automation
  • GET /automations/{id} — Retrieve an automation
  • GET /automations/{id}/runs — List runs for an automation
  • POST /automations/{id}/runs — Run an automation
  • GET /automations/approvals — List approvals
  • POST /automations/approvals/{approvalId}/approve — Approve an automation approval
  • POST /automations/approvals/{approvalId}/reject — Reject an automation approval

Common errors

  • 404 resource_missing — the referenced resource does not exist or is not visible to your key.
GET
/automations/{id}/runs/{runId}

Authorization

x-api-key<token>

Your RevKeen API key (powered by Unkey). Get it from Dashboard > Settings > API Keys. Use rk_sandbox_* for test mode and rk_live_* for production.

In: header

Path Parameters

id*string

The automation ID

Formatuuid
runId*string

The run ID

Formatuuid

Response Body

application/json

curl "https://api.revkeen.com/v2/automations/00000000-0000-0000-0000-000000000000/runs/00000000-0000-0000-0000-000000000000" \  -H "x-api-key: $REVKEEN_API_KEY"
{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "object": "automation_run",
    "automation_id": "64fb5f73-6415-4f56-8e9e-ca06539f09ac",
    "automation_name": "string",
    "status": "string",
    "trigger_source": "string",
    "summary": "string",
    "error_message": "string",
    "created_at": "string",
    "started_at": "string",
    "completed_at": "string",
    "automation_version_id": "cda2ed79-119f-41c9-a9ef-36f4a9f69a6f",
    "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84",
    "trigger_payload": null,
    "version": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "version": 0,
      "objective": "string"
    },
    "automation": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "status": "string",
      "trigger_type": "string",
      "risk_profile": "string"
    },
    "steps": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "step_index": 0,
        "step_type": "string",
        "name": "string",
        "status": "string",
        "input_json": null,
        "output_json": null,
        "duration_ms": 0,
        "created_at": "string"
      }
    ],
    "approvals": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "status": "string",
        "action_summary": "string",
        "actions_json": null,
        "approved_by_user_id": "6f927876-90f9-4dae-8888-4b498595faf4",
        "approved_at": "string",
        "rejection_reason": "string",
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "notifications": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "type": "string",
        "priority": "string",
        "message": "string",
        "payload_json": null,
        "delivered_at": "string",
        "created_at": "string"
      }
    ]
  }
}
Empty
Edit on GitHub