Bot Runners

Bot Runners are instances of the ElectroNeek Bot Runner application connected to Orchestrator. Bot Runners are designed to execute workflows.

Get a list of all Bot Runners

This returns the list of all Bot Runners that are connected to Orchestrator. You can filter the result by status, logged-in user, Bot Runner version, ID, or name.

SecuritybearerAuth
Request
query Parameters
status
string

It filters Bot Runners by status

Enum: "ready" "in_progress" "offline"
login_as
string

It filters logged users by email, e.g., robot@electroneek.com

version
string

It filters Bot Runners by version, e.g., 8.0.0

ids
Array of strings

It filters by Bot Runner IDs.

Example: ids=623sdfjs3924320aqizmhf18
name
string

It filters Bot Runners by the name, .e.g, MY-BOT-RUNNER-1

Responses
200

API returns the list of Bot Runners matching the filter criteria.

get/bot-runners
Response samples
application/json
{
  • "list": [
    ]
}

Get info of a Bot Runner

This returns detailed information on a specific Bot Runner including all the workflows where the Bot Runner is assigned.

SecuritybearerAuth
Request
path Parameters
id
required
string

Bot Runner ID

Responses
200

Success

get/bot-runner/{id}
Response samples
application/json
{
  • "status_since": "2019-08-24T14:15:22Z",
  • "assigned_workflows": [
    ],
  • "host_name": "Main ElectroNeek Computer",
  • "id": "610d3ca103635d3c9ad9a601",
  • "login_as": {
    },
  • "name": "My Bot Runner",
  • "status": "ready",
  • "version": "6.0.0"
}

Get launches of a Bot Runner

This returns a list of launches for a specific Bot Runner. 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

Bot Runner 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>
workflow_ids
Array of strings
Responses
200

Success

get/bot-runner/{id}/launches
Response samples
application/json
{
  • "list": [
    ]
}

Stop current Bot Runner

This stops the launch on the particular Bot Runner.

SecuritybearerAuth
Request
path Parameters
id
required
string

Bot Runner ID

Request Body schema: application/json
is_hardstop
boolean
Responses
200

Success

post/bot-runner/{id}/stop
Request samples
application/json
{
  • "is_hardstop": true
}
Copyright © ElectroNeek 2019-2023. All right reserved.