Execute a workflow with provided config.

Beta

POST

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.

workflow_configobjectRequired

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

streamingbooleanOptional

Response

Successful Response

Workflows Run with Config Response Zeroobject or null

Workflow Run Responseobject or null

POST

1 curl -X POST https://api-prod.scoutos.com/v2/workflows/execute \
2      -H "Authorization: Bearer <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "workflow_config": {}
6 }'

200Successful

1 {
2   "organization_id": "organization_id",
3   "id": "id",
4   "correlation_id": "correlation_id",
5   "name": "workflow_run_started",
6   "environment": "development",
7   "timestamp": "timestamp",
8   "data": {
9     "actor": {
10       "id": "id",
11       "type": "external"
12     },
13     "workflow_id": "workflow_id",
14     "workflow_run_id": "workflow_run_id",
15     "inputs": {
16       "key": "value"
17     },
18     "session_id": "session_id",
19     "state": {
20       "key": "value"
21     },
22     "workflow_config": {
23       "key": "value"
24     },
25     "price": 1.1
26   },
27   "price": "price",
28   "event_type": "event_type",
29   "version": "version"
30 }

Built with

1	curl -X POST https://api-prod.scoutos.com/v2/workflows/execute \
2	-H "Authorization: Bearer <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"workflow_config": {}
6	}'

1	{
2	"organization_id": "organization_id",
3	"id": "id",
4	"correlation_id": "correlation_id",
5	"name": "workflow_run_started",
6	"environment": "development",
7	"timestamp": "timestamp",
8	"data": {
9	"actor": {
10	"id": "id",
11	"type": "external"
12	},
13	"workflow_id": "workflow_id",
14	"workflow_run_id": "workflow_run_id",
15	"inputs": {
16	"key": "value"
17	},
18	"session_id": "session_id",
19	"state": {
20	"key": "value"
21	},
22	"workflow_config": {
23	"key": "value"
24	},
25	"price": 1.1
26	},
27	"price": "price",
28	"event_type": "event_type",
29	"version": "version"
30	}