RevKeenDocs
StatusSupport
API Reference

Run an automation

Queue a manual run of a saved automation. --- **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 - `GET /automations/{id}/runs/{runId}` — Retrieve a run - `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. **Idempotency** Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).

POST
/automations/{id}/runs

Queue a manual run of a saved automation.

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
  • GET /automations/{id}/runs/{runId} — Retrieve a run
  • 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.

Idempotency

Pass an Idempotency-Key header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see the idempotency guide.

Authorization

x-api-key<token>

Your RevKeen merchant API key. Create and manage keys in Dashboard → Settings → Developer. Use rk_sandbox_* for staging/test and rk_live_* for production. The same key may be sent as Authorization: Bearer <key> if that suits your HTTP client better. A missing, invalid, expired, or revoked key returns 401 with a WWW-Authenticate: Bearer challenge; a valid key without the required scope returns 403.

In: header

Path Parameters

id*string

The automation ID

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

Stuck on an error response? Ask the RevKeen assistant to explain it.
curl -X POST "https://api.revkeen.com/v2/automations/00000000-0000-0000-0000-000000000000/runs" \
  -H "x-api-key: $REVKEEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "trigger_payload": null
  }'
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "object": "automation_run",    "status": "string",    "automation_id": "64fb5f73-6415-4f56-8e9e-ca06539f09ac",    "job_id": "string"  }}

Reject an automation approval POST

Reject a pending automation approval request, optionally providing a reason. --- **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/{id}/runs/{runId}` — Retrieve a run - `GET /automations/approvals` — List approvals - `POST /automations/approvals/{approvalId}/approve` — Approve an automation approval **Common errors** - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. **Idempotency** Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).

Retrieve a run GET

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.