Run workflow

POST 
/workspace/:ws_id/playbooks/:id/execute

Executes a complete workflow

Request

Path Parameters

id stringrequired

The ID of the workflow to execute.

ws_id stringrequired

Workspace ID

Query Parameters

run_sync boolean

Wether to run the workflow synchronously or not. If the workflow is executed synchronously, the whole execution's output will be returned instead of the execution's ID. Additionally, the request's execution time will be longer, according to the time it takes the workflow to execute. Consider adjusting the action step's timeout configuration accordingly.

timeout integer

If the automation runs synchronously, the amount of seconds until the automation's run will timeout if it did not yet finish executing.

application/json

Body

Workflow's input parameters, JSON object containing key-value pairs.

property name* any

Responses

200

Execution id

application/json

Schema

Schema

execution_id string

Example (from schema)

{
  "execution_id": "a22f642a-f4fc-4c66-b978-6f1d1008e6ae"
}

400

Can not execute workflow

application/json

Schema

Schema

data
details string
identifier string
message string
status integer
user_error

Example (from schema)

{
  "data": {},
  "details": "string",
  "identifier": "string",
  "message": "string",
  "status": 404,
  "user_error": {}
}

404

Can not find workflow

application/json

Schema

Schema

data
details string
identifier string
message string
status integer
user_error

Example (from schema)

{
  "data": {},
  "details": "string",
  "identifier": "string",
  "message": "string",
  "status": 404,
  "user_error": {}
}

Loading...