Execute a workflow.

Beta

POST

Path parameters

workflow_idstringRequired

Query parameters

environmentstringOptional

Specifies the execution environment for the workflow. The available environments include:

production: The production environment, where workflows are executed under live conditions.
staging: A staging environment used for testing prior to production deployment.
development: A development environment used for testing new changes.
console: The console environment, runs latest changes on a workflow.

revision_idstringOptional

session_idstringOptional

Request

This endpoint expects an object.

streamingtrueRequired

inputsmap from strings to booleans or maps from strings to any or doubles or integers or lists of any or stringsOptional

Response

This endpoint returns a stream of object.

Workflow Run Startedobject

Workflow Run Completedobject

Workflow Run Failedobject

Block Run Startedobject

Block Run Completedobject

Block Run Failedobject

Block State Updatedobject

POST

1 curl -X POST "https://api-prod.scoutos.com/v2/workflows/:workflow_id/execute?environment=string&revision_id=string" \
2      -H "Authorization: Bearer <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "streaming": true
6 }'

Streamed Response

Built with

1	curl -X POST "https://api-prod.scoutos.com/v2/workflows/:workflow_id/execute?environment=string&revision_id=string" \
2	-H "Authorization: Bearer <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"streaming": true
6	}'