Skip to main content
GET
/
workflow-requests
/
{id}
Get Workflow Request Status
curl --request GET \
  --url https://app.splox.io/api/v1/workflow-requests/{id}
{
  "id": "0199f123-d60e-7ffd-9131-4cc5ab040ee8",
  "workflow_version_id": "0199e001-a23b-7c8d-1234-567890abcdef",
  "start_node_id": "0199e002-b34c-8d9e-2345-678901bcdef0",
  "status": "completed",
  "created_at": "2025-10-22T12:15:30Z",
  "user_id": "0199d001-c45d-9e0f-3456-789012cdef01",
  "parent_node_execution_id": null,
  "parent_workflow_request_id": "0199f123-d60e-7ffd-9131-4cc5ab040ee8",
  "query": {
    "user_id": "12345",
    "event": "user.signup",
    "email": "[email protected]"
  },
  "iteration_array": null,
  "iteration_data": null,
  "files": [],
  "output": {
    "result": "success",
    "user_created": true,
    "welcome_email_sent": true
  },
  "metadata": {},
  "started_at": "2025-10-22T12:15:32Z",
  "completed_at": "2025-10-22T12:15:47Z"
}
Retrieves the status and results of a workflow execution triggered by webhook.

​
Usage

Use the workflow_request_id returned from the webhook trigger to poll for execution status and results.

​
Polling

For long-running workflows, poll this endpoint to check if execution is complete: 
# Check status every few seconds
GET /v1/workflow-requests/{workflow_request_id}

​
Status Values

  • pending - Request received, waiting to start
  • in_progress - Currently executing
  • waiting - Paused, waiting for user input or external event
  • completed - Finished successfully
  • failed - Execution failed (check output field for error details)
  • stopped - Execution was manually stopped

​
Output Data

When status is completed, the output field contains the workflow results. When status is failed, the output field may contain error information.

Path Parameters

​
id
string<uuid>
required

Workflow request ID (UUID format) returned from webhook trigger

Example:

"0199f123-d60e-7ffd-9131-4cc5ab040ee8"

Response

Workflow request details retrieved successfully

Represents a workflow execution request

​
id
string<uuid>
required

Unique workflow request identifier

Example:

"0199f123-d60e-7ffd-9131-4cc5ab040ee8"

​
workflow_version_id
string<uuid>
required

ID of the workflow version being executed

Example:

"0199e001-a23b-7c8d-1234-567890abcdef"

​
start_node_id
string<uuid>
required

ID of the starting node in the workflow

Example:

"0199e002-b34c-8d9e-2345-678901bcdef0"

​
status
enum<string>
required

Current status of the workflow request

Available options:
pending,
in_progress,
waiting,
completed,
failed,
stopped
Example:

"completed"

​
created_at
string<date-time>
required

Timestamp when request was created

Example:

"2025-10-22T12:15:30Z"

​
user_id
string<uuid>

ID of the user who owns this workflow

Example:

"0199d001-c45d-9e0f-3456-789012cdef01"

​
parent_node_execution_id
string<uuid> | null

ID of parent node execution (for subflows)

Example:

null

​
parent_workflow_request_id
string<uuid>

ID of parent workflow request (same as id for root requests)

Example:

"0199f123-d60e-7ffd-9131-4cc5ab040ee8"

​
query
object

Input data from webhook payload

Example:
{
  "user_id": "12345",
  "event": "user.signup",
  "email": "[email protected]"
}
​
iteration_array
any[] | null

Array data for loop iterations

Example:

null

​
iteration_data
object

Current iteration context data

Example:

null

​
files
object[]

Files attached to the workflow request

Example:
[]
​
output
object

Output data from completed workflow (null if not completed)

Example:
{
  "result": "success",
  "user_created": true,
  "welcome_email_sent": true
}
​
metadata
object

Additional metadata for the workflow request

Example:
{}
​
started_at
string<date-time> | null

Timestamp when execution started (null if not started)

Example:

"2025-10-22T12:15:32Z"

​
completed_at
string<date-time> | null

Timestamp when execution completed (null if not completed)

Example:

"2025-10-22T12:15:47Z"