Workflows

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": [
    ]
}

Get Workflow Detailed Info

This returns detailed information on a specific Workflow.

SecuritybearerAuth
Request
path Parameters
id
required
string

Workflow ID

Responses
200

Success

get/workflow/{id}
Response samples
application/json
{
  • "assigned_runners": {
    },
  • "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
id
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": [
    ]
}

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
id
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
application/json
{
  • "runner_id": null,
  • "payload": { }
}
Response samples
application/json
{
  • "launch_id": "6114e341038ca47aa488d942"
}
Copyright © ElectroNeek 2019-2023. All right reserved.