Task Manager

API for communication with ZBOS by Zora Robotics.

Channels

zbos/taskmanager/entries/get/all

PUB Gets all entries

Channel tags

  • Task Manager

KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

Any
Examples of payload
{
  "key": "ABCxyz"
}

zbos/taskmanager/entries/get/all/response/\{key}

SUB Get all entries response

Channel tags

  • Task Manager

GetTaskManagerEntriesResponse
Payload

Name

Type

Description

Accepted values

entries

array (object)

Any

entries. id

string

Entry ID

Any

entries. task

object

Task to run

Any

entries.task. type

string

Type of the task

* composition * single_block

entries.task. data

object

Data required for the chosen task type

Any

entries. description

string

Description of the entry

Any

entries. trigger

object

Trigger that starts the task

Any

entries.trigger. type

string

Type of the trigger

* sensor * qr * monitoring * motion * faces * voice * mqtt * domotics * kiosk_home * boot * scheduler * composer * webhook * date_time * poi_in * poi_out

entries.trigger. data

object

Data required for the chosen trigger type

Any

entries. source

string

Source of the entry

* system * user * scheduler

entries. priority

string

Running priority of the entry

* low * normal * important * critical

entries. weight

integer

Weight of the entry, to give more granular control besides priority

Any

entries. concurrent

boolean

Determines if this entry can run concurrently with other entries

Any

entries. on_resume

string

Determines what should happen if the entry is resumed

* restart * restart_block * stop

entries. launch_mode

string

Determines what should happen if a trigger is hit when a task is already running. - single_first: Allow single simultaneous execution. When a new execution is trying to start, it will not succeed and the previously running execution will continue. - single_last: Allow single simultaneous execution. When a new execution is trying to start, the previously running executions will stop. - multiple: Allow multiple simultaneous executions.

* single_first * single_last * multiple

entries. enabled

boolean

Enabled state of the entry trigger

Any

entries. executions

array (object)

All current executions of the task

Any

entries.executions. id

string

Execution ID

Any

entries.executions. state

string

Current state of the entry task execution

* idle * running * paused

entries.executions. info

object

Extra info/metadata about the task execution

Any

entries. info

object

Extra info/metadata about the task

Any
Examples of payload
{
  "entries": [
    {
      "id": "entry_id_1",
      "task": {
        "type": "composition",
        "data": {
          "composition_id": {
            "content": "composition_id_1",
            "string": true
          }
        }
      },
      "description": "A description example",
      "trigger": {
        "type": "sensor",
        "data": {
          "sensors": [
            "sensor_1",
            "sensor_2"
          ]
        }
      },
      "source": "user",
      "priority": "normal",
      "weight": 0,
      "concurrent": true,
      "enabled": true,
      "executions": [
        {
          "id": "entry_id_1_execution_1",
          "state": "running"
        }
      ],
      "on_resume": "restart_block",
      "launch_mode": "single_first"
    }
  ]
}

zbos/taskmanager/entries/get

PUB Get an entry

Channel tags

  • Task Manager

GetTaskManagerEntryRequest
Payload

Name

Type

Description

Accepted values

key

string

Any

id

string

ID of the entry to get

Any
Examples of payload
{
  "key": "abc",
  "id": "entry_id_1"
}

zbos/taskmanager/entries/get/response/\{key}

SUB Get an entry response

Channel tags

  • Task Manager

GetTaskManagerEntryResponse
Payload

Name

Type

Description

Accepted values

success

boolean

Any

entry

object

Any

entry. id

string

Entry ID

Any

entry. task

object

Task to run

Any

entry.task. type

string

Type of the task

* composition * single_block

entry.task. data

object

Data required for the chosen task type

Any

entry. description

string

Description of the entry

Any

entry. trigger

object

Trigger that starts the task

Any

entry.trigger. type

string

Type of the trigger

* sensor * qr * monitoring * motion * faces * voice * mqtt * domotics * kiosk_home * boot * scheduler * composer * webhook * date_time * poi_in * poi_out

entry.trigger. data

object

Data required for the chosen trigger type

Any

entry. source

string

Source of the entry

* system * user * scheduler

entry. priority

string

Running priority of the entry

* low * normal * important * critical

entry. weight

integer

Weight of the entry, to give more granular control besides priority

Any

entry. concurrent

boolean

Determines if this entry can run concurrently with other entries

Any

entry. on_resume

string

Determines what should happen if the entry is resumed

* restart * restart_block * stop

entry. launch_mode

string

Determines what should happen if a trigger is hit when a task is already running. - single_first: Allow single simultaneous execution. When a new execution is trying to start, it will not succeed and the previously running execution will continue. - single_last: Allow single simultaneous execution. When a new execution is trying to start, the previously running executions will stop. - multiple: Allow multiple simultaneous executions.

* single_first * single_last * multiple

entry. enabled

boolean

Enabled state of the entry trigger

Any

entry. executions

array (object)

All current executions of the task

Any

entry.executions. id

string

Execution ID

Any

entry.executions. state

string

Current state of the entry task execution

* idle * running * paused

entry.executions. info

object

Extra info/metadata about the task execution

Any

entry. info

object

Extra info/metadata about the task

Any
Examples of payload
{
  "success": true,
  "entry": {
    "id": "entry_id_1",
    "task": {
      "type": "composition",
      "data": {
        "composition_id": {
          "content": "composition_id_1",
          "string": true
        }
      }
    },
    "description": "A description example",
    "trigger": {
      "type": "sensor",
      "data": {
        "sensors": [
          "sensor_1",
          "sensor_2"
        ]
      }
    },
    "source": "user",
    "priority": "normal",
    "weight": 0,
    "concurrent": true,
    "enabled": true,
    "executions": [
      {
        "id": "entry_id_1_execution_1",
        "state": "running"
      }
    ],
    "on_resume": "restart_block",
    "launch_mode": "single_first"
  }
}

zbos/taskmanager/entries/add

PUB Add an entry

Channel tags

  • Task Manager

AddTaskManagerEntryRequest
Payload

Name

Type

Description

Accepted values

key

string

Required key

Any

task

object

Task to run

Any

task. type

string

Type of the task

* composition * single_block

task. data

object

Data required for the chosen task type

Any

description

string

Description of the entry

Any

trigger

object

Trigger that starts the task

Any

trigger. type

string

Type of the trigger

* sensor * qr * monitoring * motion * faces * voice * mqtt * domotics * kiosk_home * boot * scheduler * composer * webhook * date_time * poi_in * poi_out

trigger. data

object

Data required for the chosen trigger type

Any

priority

string

Running priority of the entry

* low * normal * important * critical

weight

integer

Weight of the entry, to give more granular control besides priority

Any

concurrent

boolean

Determines if this entry can run concurrently with other entries

Any

on_resume

string

Determines what should happen if the entry is resumed

* restart * restart_block * stop

launch_mode

string

Determines what should happen if a trigger is hit when a task is already running. - single_first: Allow single simultaneous execution. When a new execution is trying to start, it will not succeed and the previously running execution will continue. - single_last: Allow single simultaneous execution. When a new execution is trying to start, the previously running executions will stop. - multiple: Allow multiple simultaneous executions.

* single_first * single_last * multiple
Examples of payload
{
  "key": "abc",
  "task": {
    "type": "composition",
    "data": {
      "composition_id": {
        "content": "composition_id_1",
        "string": true
      }
    }
  },
  "description": "A description example",
  "trigger": {
    "type": "sensor",
    "data": {
      "sensors": [
        "sensor_1",
        "sensor_2"
      ]
    }
  },
  "priority": "normal",
  "weight": 0,
  "concurrent": true,
  "on_resume": "restart_block",
  "launch_mode": "single_first"
}

zbos/taskmanager/entries/add/response/\{key}

SUB Add an entry response

Channel tags

  • Task Manager

AddTaskManagerEntryResponse
Payload

Name

Type

Description

Accepted values

success

boolean

Any

id

string

ID of the added entry

Any
Examples of payload
{
  "success": true,
  "id": "entry_id_1"
}

zbos/taskmanager/entries/edit

PUB Edit an entry

Channel tags

  • Task Manager

EditTaskManagerEntryRequest
Payload

Name

Type

Description

Accepted values

key

string

Required key

Any

id

string

ID of the task to edit

Any

task

object

Task to run

Any

task. type

string

Type of the task

* composition * single_block

task. data

object

Data required for the chosen task type

Any

description

string

Description of the entry

Any

trigger

object

Trigger that starts the task

Any

trigger. type

string

Type of the trigger

* sensor * qr * monitoring * motion * faces * voice * mqtt * domotics * kiosk_home * boot * scheduler * composer * webhook * date_time * poi_in * poi_out

trigger. data

object

Data required for the chosen trigger type

Any

priority

string

Running priority of the entry

* low * normal * important * critical

weight

integer

Weight of the entry, to give more granular control besides priority

Any

concurrent

boolean

Determines if this entry can run concurrently with other entries

Any

on_resume

string

Determines what should happen if the entry is resumed

* restart * restart_block * stop

launch_mode

string

Determines what should happen if a trigger is hit when a task is already running. - single_first: Allow single simultaneous execution. When a new execution is trying to start, it will not succeed and the previously running execution will continue. - single_last: Allow single simultaneous execution. When a new execution is trying to start, the previously running executions will stop. - multiple: Allow multiple simultaneous executions.

* single_first * single_last * multiple
Examples of payload
{
  "key": "abc",
  "id": "entry_id_1",
  "task": {
    "type": "composition",
    "data": {
      "composition_id": {
        "content": "composition_id_1",
        "string": true
      }
    }
  },
  "description": "A description example",
  "trigger": {
    "type": "sensor",
    "data": {
      "sensors": [
        "sensor_1",
        "sensor_2"
      ]
    }
  },
  "priority": "normal",
  "weight": 0,
  "concurrent": true,
  "on_resume": "restart_block",
  "launch_mode": "single_first"
}

zbos/taskmanager/entries/edit/response/\{key}

SUB Edit an entry response

Channel tags

  • Task Manager

SuccessMessage

Success message

Payload

Name

Type

Description

Accepted values

success

boolean

Any

message

string

Optional error message

Any
Examples of payload
{
  "success": true
}

zbos/taskmanager/entries/remove

PUB Remove an entry

Channel tags

  • Task Manager

RemoveTaskManagerEntryRequest
Payload

Name

Type

Description

Accepted values

key

string

Any

id

string

ID of the entry to remove

Any
Examples of payload
{
  "key": "abc",
  "id": "entry_id_1"
}

zbos/taskmanager/entries/remove/response/\{key}

SUB Remove an entry response

Channel tags

  • Task Manager

SuccessMessage

Success message

Payload

Name

Type

Description

Accepted values

success

boolean

Any

message

string

Optional error message

Any
Examples of payload
{
  "success": true
}

zbos/taskmanager/entries/clone

PUB Clone an entry

Channel tags

  • Task Manager

CloneTaskManagerEntryRequest
Payload

Name

Type

Description

Accepted values

key

string

Any

id

string

ID of the entry to clone

Any
Examples of payload
{
  "key": "abc",
  "id": "entry_id_1"
}

zbos/taskmanager/entries/clone/response/\{key}

SUB Clone an entry response

Channel tags

  • Task Manager

CloneTaskManagerEntryResponse
Payload

Name

Type

Description

Accepted values

success

boolean

Any

id

string

ID of the added entry

Any
Examples of payload
{
  "success": true,
  "id": "entry_id_2"
}

zbos/taskmanager/entries/update/event

SUB Entries have been updated

Channel tags

  • Task Manager

TaskManagerEntriesUpdatedEvent
Payload

Name

Type

Description

Accepted values

entries

array (object)

Any

entries. id

string

Entry ID

Any

entries. task

object

Task to run

Any

entries.task. type

string

Type of the task

* composition * single_block

entries.task. data

object

Data required for the chosen task type

Any

entries. description

string

Description of the entry

Any

entries. trigger

object

Trigger that starts the task

Any

entries.trigger. type

string

Type of the trigger

* sensor * qr * monitoring * motion * faces * voice * mqtt * domotics * kiosk_home * boot * scheduler * composer * webhook * date_time * poi_in * poi_out

entries.trigger. data

object

Data required for the chosen trigger type

Any

entries. source

string

Source of the entry

* system * user * scheduler

entries. priority

string

Running priority of the entry

* low * normal * important * critical

entries. weight

integer

Weight of the entry, to give more granular control besides priority

Any

entries. concurrent

boolean

Determines if this entry can run concurrently with other entries

Any

entries. on_resume

string

Determines what should happen if the entry is resumed

* restart * restart_block * stop

entries. launch_mode

string

Determines what should happen if a trigger is hit when a task is already running. - single_first: Allow single simultaneous execution. When a new execution is trying to start, it will not succeed and the previously running execution will continue. - single_last: Allow single simultaneous execution. When a new execution is trying to start, the previously running executions will stop. - multiple: Allow multiple simultaneous executions.

* single_first * single_last * multiple

entries. enabled

boolean

Enabled state of the entry trigger

Any

entries. executions

array (object)

All current executions of the task

Any

entries.executions. id

string

Execution ID

Any

entries.executions. state

string

Current state of the entry task execution

* idle * running * paused

entries.executions. info

object

Extra info/metadata about the task execution

Any

entries. info

object

Extra info/metadata about the task

Any
Examples of payload
{
  "entries": [
    {
      "id": "entry_id_1",
      "task": {
        "type": "composition",
        "data": {
          "composition_id": {
            "content": "composition_id_1",
            "string": true
          }
        }
      },
      "description": "A description example",
      "trigger": {
        "type": "sensor",
        "data": {
          "sensors": [
            "sensor_1",
            "sensor_2"
          ]
        }
      },
      "source": "user",
      "priority": "normal",
      "weight": 0,
      "concurrent": true,
      "enabled": true,
      "executions": [
        {
          "id": "entry_id_1_execution_1",
          "state": "running"
        }
      ],
      "on_resume": "restart_block",
      "launch_mode": "single_first"
    }
  ]
}

zbos/taskmanager/entries/start

PUB Start an entry

Channel tags

  • Task Manager

StartTaskManagerEntryRequest
Payload

Name

Type

Description

Accepted values

key

string

Any

id

string

ID of the entry task to start

Any
Examples of payload
{
  "key": "abc",
  "id": "entry_id_1"
}

zbos/taskmanager/entries/start/response/\{key}

SUB Start an entry response

Channel tags

  • Task Manager

SuccessMessage

Success message

Payload

Name

Type

Description

Accepted values

success

boolean

Any

message

string

Optional error message

Any
Examples of payload
{
  "success": true
}

zbos/taskmanager/entries/stop

PUB Stop an entry

Channel tags

  • Task Manager

StopTaskManagerEntryRequest
Payload

Name

Type

Description

Accepted values

key

string

Any

id

string

ID of the entry task to stop

Any
Examples of payload
{
  "key": "abc",
  "id": "entry_id_1"
}

zbos/taskmanager/entries/stop/response/\{key}

SUB Stop an entry response

Channel tags

  • Task Manager

SuccessMessage

Success message

Payload

Name

Type

Description

Accepted values

success

boolean

Any

message

string

Optional error message

Any
Examples of payload
{
  "success": true
}

zbos/taskmanager/entries/pause

PUB Pause an entry

Channel tags

  • Task Manager

PauseTaskManagerEntryRequest
Payload

Name

Type

Description

Accepted values

key

string

Any

id

string

ID of the entry to pause

Any
Examples of payload
{
  "key": "abc",
  "id": "entry_id_1"
}

zbos/taskmanager/entries/pause/response/\{key}

SUB Pause an entry response

Channel tags

  • Task Manager

SuccessMessage

Success message

Payload

Name

Type

Description

Accepted values

success

boolean

Any

message

string

Optional error message

Any
Examples of payload
{
  "success": true
}

zbos/taskmanager/entries/resume

PUB Resume an entry

Channel tags

  • Task Manager

ResumeTaskManagerEntryRequest
Payload

Name

Type

Description

Accepted values

key

string

Any

id

string

ID of the entry to resume

Any
Examples of payload
{
  "key": "abc",
  "id": "entry_id_1"
}

zbos/taskmanager/entries/resume/response/\{key}

SUB Resume an entry response

Channel tags

  • Task Manager

SuccessMessage

Success message

Payload

Name

Type

Description

Accepted values

success

boolean

Any

message

string

Optional error message

Any
Examples of payload
{
  "success": true
}

zbos/taskmanager/entries/enable

PUB Enable an entry

Channel tags

  • Task Manager

EnableTaskManagerEntryRequest
Payload

Name

Type

Description

Accepted values

key

string

Any

id

string

ID of the entry to enable

Any
Examples of payload
{
  "key": "abc",
  "id": "entry_id_1"
}

zbos/taskmanager/entries/enable/response/\{key}

SUB Enable an entry response

Channel tags

  • Task Manager

SuccessMessage

Success message

Payload

Name

Type

Description

Accepted values

success

boolean

Any

message

string

Optional error message

Any
Examples of payload
{
  "success": true
}

zbos/taskmanager/entries/disable

SUB Disable an entry

Channel tags

  • Task Manager

DisableTaskManagerEntryRequest
Payload

Name

Type

Description

Accepted values

key

string

Any

id

string

ID of the entry to disable

Any
Example of payload (generated)
{
  "key": "string",
  "id": "string"
}

zbos/taskmanager/executions/stop

PUB Stop an execution

Channel tags

  • Task Manager

StopTaskManagerExecutionRequest
Payload

Name

Type

Description

Accepted values

key

string

Any

id

string

ID of the execution to stop

Any
Examples of payload
{
  "key": "abc",
  "id": "execution_id_1"
}

zbos/taskmanager/executions/stop/response/\{key}

SUB Stop an execution response

Channel tags

  • Task Manager

SuccessMessage

Success message

Payload

Name

Type

Description

Accepted values

success

boolean

Any

message

string

Optional error message

Any
Examples of payload
{
  "success": true
}

zbos/taskmanager/executions/pause

PUB Pause an execution

Channel tags

  • Task Manager

PauseTaskManagerExecutionRequest
Payload

Name

Type

Description

Accepted values

key

string

Any

id

string

ID of the execution to pause

Any
Examples of payload
{
  "key": "abc",
  "id": "execution_id_1"
}

zbos/taskmanager/executions/pause/response/\{key}

SUB Pause an execution response

Channel tags

  • Task Manager

SuccessMessage

Success message

Payload

Name

Type

Description

Accepted values

success

boolean

Any

message

string

Optional error message

Any
Examples of payload
{
  "success": true
}

zbos/taskmanager/executions/resume

PUB Resume an execution

Channel tags

  • Task Manager

ResumeTaskManagerExecutionRequest
Payload

Name

Type

Description

Accepted values

key

string

Any

id

string

ID of the execution to resume

Any
Examples of payload
{
  "key": "abc",
  "id": "execution_id_1"
}

zbos/taskmanager/executions/resume/response/\{key}

SUB Resume an execution response

Channel tags

  • Task Manager

SuccessMessage

Success message

Payload

Name

Type

Description

Accepted values

success

boolean

Any

message

string

Optional error message

Any
Examples of payload
{
  "success": true
}

zbos/taskmanager/triggers/get

PUB Gets all triggers

Channel tags

  • Task Manager

GetTaskManagerTriggersRequest
Payload

Name

Type

Description

Accepted values

key

string

Required key

Any

language

string

Optional. Set the language to have all translations filled in. The language format is ISO 639-1 language code, Eg: 'en' or 'en-US'

Any
Examples of payload
{
  "key": "abc",
  "language": "en-US"
}

zbos/taskmanager/triggers/get/response/\{key}

SUB Gets all triggers response

Channel tags

  • Task Manager

GetTaskManagerTriggersResponse
Payload

Name

Type

Description

Accepted values

triggers

array (object)

Any

triggers. type

string

Type of the trigger

* sensor * qr * monitoring * motion * faces * voice * mqtt * domotics * kiosk_home * boot * scheduler * composer * webhook * date_time * poi_in * poi_out

triggers. label

string

Human-readable label

Any

triggers. label_key

string

Translation key for human-readable label

Any

triggers. components

object

Components that should be shown when the user selects a trigger type

Any
Examples of payload
{
  "triggers": [
    {
      "type": "sensor",
      "label": "Sensor",
      "components": {
        "sensors": {
          "type": "select_multi",
          "options": [
            {
              "key": "sensor_1",
              "value": "Sensor 1",
              "label_key": "translations_category.trigger_sensor_option_1"
            },
            {
              "key": "sensor_2",
              "value": "Sensor 2",
              "label_key": "translations_category.trigger_sensor_option_2"
            }
          ],
          "label_key": "translations_category.trigger_sensor_components_sensor"
        }
      },
      "label_key": "translations_category.trigger_sensor"
    }
  ]
}

zbos/taskmanager/reset

PUB Reset the task manager to the factory state

Channel tags

  • Task Manager

ResetTaskManagerEntriesRequest
Payload

Name

Type

Description

Accepted values

key

string

Required key

Any

delete_user_entries

boolean

Set true to delete all user generated entries. Otherwise this will only disable them.

Any
Examples of payload
{
  "key": "abc",
  "delete_user_entries": true
}

zbos/taskmanager/reset/response/\{key}

SUB Reset the task manager to the factory state response

Channel tags

  • Task Manager

SuccessMessage

Success message

Payload

Name

Type

Description

Accepted values

success

boolean

Any

message

string

Optional error message

Any
Examples of payload
{
  "success": true
}