POST
/
run_workflow
/
{team_id}
/
{run_id}
curl -X POST \
  -H 'x-api-key: <YOUR_API_KEY>' \
  -H 'Authorization: Bearer <YOUR_JWT_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{ "id": "<WORKFLOW_ID>", "origin": "2", "inputs": {} }' \
  'https://api.playbook3d.com/run_workflow/<TEAM_ID>/<RUN_ID>'
{
  "run_id": "eb49c4e2-e9c5-4202-aea2-86dd31493621",
  "status": "queued",
  "message": "Workflow queued successfully."
}

Headers

​
x-api-key
string
required

Your API key. This is required by most endpoints for programmatic access. You can view your x-api-key in the 'Profile' tab.

​
Authorization
string
required

Bearer token for authentication (JWT).

Path Parameters

​
team_id
string
required

The team UUID to which this run will be associated.

​
run_id
string
required

A unique run UUID for identifying this workflow execution. Generated automatically if not supplied by user.

Body

application/json
The workflow ID and optional origin and inputs for the run.
​
id
string

The workflow's unique UUID.

​
origin
string

Indicates the caller context (e.g., '2' for Unity SDK).

​
inputs
object

Any JSON data you want to pass into the workflow.

Response

200
application/json
Workflow queued successfully. The response body typically includes run status info.
​
run_id
string

The unique run ID.

​
status
string

Status of the newly queued workflow.

​
message
string

Optional success/failure message.

Cancel Workflow RunGet Run IDs