Workflows

Workflows description: Workflows are bots developed in Studio and published to Orchestrator.

Get all Workflows

This returns a list of all the Workflows in the Orchestrator.

SecuritybearerAuth

Request

query Parameters

ids	Array of strings It filters by Workflow IDs

Responses

200

Success

get/workflows

Response samples

application/json

{"list": [{"id": "6114e2c4038ca47aa488d878",
"name": "My workflow",
"description": "Workflows that makes coffee"
}
]
}

Get Workflow Detailed Info

This returns detailed information on a specific Workflow.

SecuritybearerAuth

Request

path Parameters

required

string

Workflow ID

Responses

200

Success

get/workflow/{id}

Response samples

application/json

{"assigned_runners": {"id": "610d3ca103635d3c9ad9a601",
"name": "My Bot Runner",
"host_name": "My super computer"
},
"id": "6114e2c4038ca47aa488d878",
"name": "My workflow",
"description": "Workflows that makes coffee"
}

Get Workflows Launches Summary

This returns the list of launches of a particular Workflow. You can filter the launches by type, status, launch time, and Bot Runner IDs. The output list contains the last 1000 launches.

SecuritybearerAuth

Request

path Parameters

required

string

Workflow ID

query Parameters

type	string Enum: "manual" "webhook" "schedule" "zapier" "api"
status	string Enum: "stopped" "in-queue" "cancelled" "forced-stop" "in-progress" "completed-with-error" "completed-successfully"
started_from	string <date-time>
started_to	string <date-time>
completed_from	string <date-time>
completed_to	string <date-time>
runner_ids	Array of strings

Responses

200

Success

get/workflow/{id}/launches

Response samples

application/json

{"list": [{"runner_id": "610d3ca103635d3c9ad9a601",
"id": "6114e341038ca47aa488d942",
"type": "manual",
"status": "completed-successfully",
"account_email": "robot@electoneek.com",
"started_at": "2019-08-24T14:15:22Z",
"completed_at": "2019-08-24T14:15:22Z",
"logs_enabled": true,
"output_data": { }
}
]
}

Launch Workflow

This launches a Workflow. If runner_id is not specified, it launches the Workflow on the first available Bot Runner. If all Bot Runners are busy or offline, the Workflow is put in a queue.

SecuritybearerAuth

Request

path Parameters

required

string

Workflow ID

Request Body schema: application/json

runner_id	string or null
payload	object

Responses

201

Success

post/workflow/{id}/launch

Request samples

Payload

application/json

{"runner_id": null,
"payload": { }
}

Response samples

application/json

{"launch_id": "6114e341038ca47aa488d942"
}