Get a workflow instance with its step events and per-step status
curl --request GET \
--url https://app.hookie.ai/admin/api/projects/{project_id}/workflow-instances/{instance_id} \
--cookie hookie_session=const options = {method: 'GET', headers: {cookie: 'hookie_session='}};
fetch('https://app.hookie.ai/admin/api/projects/{project_id}/workflow-instances/{instance_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.hookie.ai/admin/api/projects/{project_id}/workflow-instances/{instance_id}"
headers = {"cookie": "hookie_session="}
response = requests.get(url, headers=headers)
print(response.text){
"instance": {
"id": "<string>",
"workflow_id": "<string>",
"state": "pending",
"current_step_index": 123,
"context": "<string>",
"correlation_id": "<string>",
"last_error": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"engine": "legacy",
"cf_instance_id": "<string>",
"run_attempt": 123,
"workflow_version": 123
},
"events": [
{
"step_index": 123,
"step_type": "emit_event",
"status": "started",
"details": "<string>",
"created_at": "<string>"
}
],
"engine": "legacy",
"steps": [
{
"index": 123,
"path": "<string>",
"type": "<string>",
"status": "completed",
"started_at": "<string>",
"finished_at": "<string>",
"error": "<string>"
}
],
"cf_status": {
"status": "queued",
"error": {
"name": "<string>",
"message": "<string>"
}
}
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}Workflows
Get a workflow instance with its step events and per-step status
For a Cloudflare Workflows instance (engine cf) the API asks Cloudflare for the instance’s status (cf_status), and a row that missed the end of its run is brought into line with it. steps is derived from the step log of the current attempt, one entry per step path, for overlaying run status on the workflow graph.
GET
/
admin
/
api
/
projects
/
{project_id}
/
workflow-instances
/
{instance_id}
Get a workflow instance with its step events and per-step status
curl --request GET \
--url https://app.hookie.ai/admin/api/projects/{project_id}/workflow-instances/{instance_id} \
--cookie hookie_session=const options = {method: 'GET', headers: {cookie: 'hookie_session='}};
fetch('https://app.hookie.ai/admin/api/projects/{project_id}/workflow-instances/{instance_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.hookie.ai/admin/api/projects/{project_id}/workflow-instances/{instance_id}"
headers = {"cookie": "hookie_session="}
response = requests.get(url, headers=headers)
print(response.text){
"instance": {
"id": "<string>",
"workflow_id": "<string>",
"state": "pending",
"current_step_index": 123,
"context": "<string>",
"correlation_id": "<string>",
"last_error": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"engine": "legacy",
"cf_instance_id": "<string>",
"run_attempt": 123,
"workflow_version": 123
},
"events": [
{
"step_index": 123,
"step_type": "emit_event",
"status": "started",
"details": "<string>",
"created_at": "<string>"
}
],
"engine": "legacy",
"steps": [
{
"index": 123,
"path": "<string>",
"type": "<string>",
"status": "completed",
"started_at": "<string>",
"finished_at": "<string>",
"error": "<string>"
}
],
"cf_status": {
"status": "queued",
"error": {
"name": "<string>",
"message": "<string>"
}
}
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}Authorizations
sessionbearerAuth
The console's sealed session cookie, set by WorkOS AuthKit. Mutating requests also require the X-Requested-With CSRF header.
Response
Instance detail, its oldest-first step-event log, the engine it runs on, and per-step status.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
legacy, cf Show child attributes
Show child attributes
Cloudflare's own instance status; null for a legacy instance or when Cloudflare no longer holds it (past retention).
Show child attributes
Show child attributes