Api reference
Run an automation
Queue a manual run of a saved automation.
Related endpoints
GET /automations— List automationsPOST /automations— Create an automationGET /automations/{id}— Retrieve an automationGET /automations/{id}/runs— List runs for an automationGET /automations/{id}/runs/{runId}— Retrieve a runGET /automations/approvals— List approvalsPOST /automations/approvals/{approvalId}/approve— Approve an automation approvalPOST /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.
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
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
trigger_payload?unknown
Response Body
application/json
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"
}
}Empty