Get a workflow instance with its step events
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>"
},
"events": [
{
"step_index": 123,
"step_type": "emit_event",
"status": "started",
"details": "<string>",
"created_at": "<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
GET
/
admin
/
api
/
projects
/
{project_id}
/
workflow-instances
/
{instance_id}
Get a workflow instance with its step events
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>"
},
"events": [
{
"step_index": 123,
"step_type": "emit_event",
"status": "started",
"details": "<string>",
"created_at": "<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.