Composer

API for communication with ZBOS by Zora Robotics.

Channels

zbos/composition/start

PUB Start composition

Payload is composition json

Channel tags

  • Composer

String
Payload

Name

Type

Description

Accepted values

Message Payload

string

Any
Example of payload (generated)
"string"

zbos/composition/start/response/\{key}

PUB Start composition response

Channel tags

  • Composer

CompositionStartResponse
Payload

Name

Type

Description

Accepted values

success

boolean

Any

composition_execution_id

string

Any
Examples of payload
{
  "success": true,
  "composition_execution_id": "execution_id_1"
}

zbos/composition/start/id

PUB Start composition by id

Channel tags

  • Composer

CompositionStartRequest
Payload

Name

Type

Description

Accepted values

key

string

Required key

Any

id

string

ID of the composition

Any

settings

object

Optional settings

Any

settings. concurrent

boolean

Any

settings. schedulerParallel

boolean

Any

settings. priority

string

* low * normal * important * critical

settings. weight

integer

Any

settings. on_resume

string

* restart * restart_block * stop

variables

object

Optional variables

Any
Examples of payload
{
  "key": "abc",
  "id": "composition_id_1",
  "variables": {
    "var1": "var1_value",
    "var2": "var2_value"
  }
}

zbos/composition/list/get

PUB Get list of compositions

Channel tags

  • Composer

FilteringRequest
Payload

Name

Type

Description

Accepted values

key

string

Any

limit

integer

Any

offset

integer

Any

filters

array (object)

Any

filters. field

string

Field to check on. Note that the field should be camelCase, not snake_case

Any

filters. value

string

Value to check on. For numbers you should use 'min' and 'max'.

Any

filters. min

number

Minimum value, only usable for number fields

Any

filters. max

number

Maximum value, only usable for number fields

Any

filters. direction

string

Direction to sort on. Can be 'asc' or 'desc'. The default direction is 'asc'

* asc * desc

filters. operator

string

Operator for either the child filters, or this filter object itself. Can be 'and', 'or' or 'not'. Default is 'and'. The root operator is always 'and'

* and * or * not

filters. match_type

string

Match type for string values. Can be 'exact', 'contains', 'starts_with', 'ends_with'. The default match_type is 'contains'

* exact * contains * starts_with * ends_with

filters. filters

array (object)

Filters on which the operator will be applied. If there are no child filters, the operator will be applied to the filter object itself.

Any

filters. field_filters

array (object)

Filters to apply on the child fields of the field. Will only work if the field is an object, array/list or map.

Any

sort

array (object)

Any

sort. field

string

Field to check on. Note that the field should be camelCase, not snake_case

Any

sort. value

string

Value to check on. For numbers you should use 'min' and 'max'.

Any

sort. min

number

Minimum value, only usable for number fields

Any

sort. max

number

Maximum value, only usable for number fields

Any

sort. direction

string

Direction to sort on. Can be 'asc' or 'desc'. The default direction is 'asc'

* asc * desc

sort. operator

string

Operator for either the child filters, or this filter object itself. Can be 'and', 'or' or 'not'. Default is 'and'. The root operator is always 'and'

* and * or * not

sort. match_type

string

Match type for string values. Can be 'exact', 'contains', 'starts_with', 'ends_with'. The default match_type is 'contains'

* exact * contains * starts_with * ends_with

sort. filters

array (object)

Filters on which the operator will be applied. If there are no child filters, the operator will be applied to the filter object itself.

Any

sort. field_filters

array (object)

Filters to apply on the child fields of the field. Will only work if the field is an object, array/list or map.

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": "Test123",
  "limit": 50,
  "offset": 10,
  "filters": [
    {
      "field": "metadata",
      "operator": "and",
      "match_type": "contains",
      "field_filters": [
        {
          "field": "tags",
          "operator": "and",
          "match_type": "contains",
          "field_filters": [
            {
              "operator": "or",
              "match_type": "contains"
            }
          ]
        }
      ]
    },
    {
      "field": "lastModified",
      "operator": "and",
      "match_type": "contains"
    },
    {
      "field": "type",
      "value": "simple_composition",
      "operator": "and",
      "match_type": "contains"
    }
  ],
  "sort": [
    {
      "field": "extension",
      "operator": "and",
      "match_type": "contains"
    },
    {
      "field": "name",
      "operator": "and",
      "match_type": "contains"
    }
  ]
}

zbos/composition/list/get/response/\{key}

SUB response: Get list of compositions

Channel tags

  • Composer

Array<CompositionInfo>
Payload

Name

Type

Description

Accepted values

Message Payload

array (object)

Any

Message Payload. id

string

Any

Message Payload. name

string

Any

Message Payload. type

string

* SIMPLE_COMPOSITION * ADVANCED_COMPOSITION

Message Payload. isDefault

boolean

Any

Message Payload. metadata

object

Any

Message Payload.metadata. tags

array (string)

Any

Message Payload.metadata. favourite

boolean

Any

Message Payload.metadata. description

string

Any

Message Payload.metadata. lastModified

number

Any
Example of payload (generated)
[
  {
    "id": "string",
    "name": "string",
    "type": "SIMPLE_COMPOSITION",
    "isDefault": true,
    "metadata": {
      "tags": [
        "string"
      ],
      "favourite": true,
      "description": "string",
      "lastModified": 0
    }
  }
]

zbos/composition/start/id/response/\{key}

SUB Start composition by id response

Channel tags

  • Composer

CompositionStartResponse
Payload

Name

Type

Description

Accepted values

success

boolean

Any

composition_execution_id

string

Any
Examples of payload
{
  "success": true,
  "composition_execution_id": "execution_id_1"
}

zbos/\{source}/start/event

SUB event: Composition started

\[DEPRECATED] Please use either the v2 version, or the matching start response topic.

Content is the composition ID

Channel tags

  • Composer

String
Payload

Name

Type

Description

Accepted values

Message Payload

string

Any
Examples of payload
"composition_id_1"

zbos/composition/start/event/v2

SUB event: Composition started

Channel tags

  • Composer

CompositionStartEvent
Payload

Name

Type

Description

Accepted values

composition_execution_id

string

Any

composition_id

string

Any
Examples of payload
{
  "composition_execution_id": "execution_id_1",
  "composition_id": "composition_id_1"
}

zbos/\{source}/stop

PUB Stop composition

\[DEPRECATED] Please use zbos/composition/stop with a json payload.

Channel tags

  • Composer

EmptyMessage

Empty message

zbos/composition/stop

PUB Stop composition

Channel tags

  • Composer

CompositionStopRequest
Payload

Name

Type

Description

Accepted values

key

string

Required key

Any

composition_execution_id

string

Any
Examples of payload
{
  "key": "abc",
  "composition_execution_id": "composition_id_1"
}

zbos/composition/stop/response/\{key}

PUB Stop composition response

Channel tags

  • Composer

SuccessMessage

Success message

Payload

Name

Type

Description

Accepted values

success

boolean

Any

message

string

Optional error message

Any
Examples of payload
{
  "success": true
}

zbos/\{source}/stop/event

SUB event: Composition stopped

\[DEPRECATED] Please use either the v2 version, or the stop response topic.

Content is the composition ID

Channel tags

  • Composer

String
Payload

Name

Type

Description

Accepted values

Message Payload

string

Any
Examples of payload
"composition_id_1"

zbos/composition/stop/event/v2

SUB event: Composition stopped

Channel tags

  • Composer

CompositionStopEvent
Payload

Name

Type

Description

Accepted values

composition_execution_id

string

Any
Examples of payload
{
  "composition_execution_id": "composition_id_1"
}

zbos/composition/pause

PUB Pause composition

Channel tags

  • Composer

CompositionPauseRequest
Payload

Name

Type

Description

Accepted values

key

string

Required key

Any

composition_execution_id

string

Any
Examples of payload
{
  "key": "abc",
  "composition_execution_id": "composition_id_1"
}

zbos/composition/pause/response/\{key}

PUB Pause composition response

Channel tags

  • Composer

SuccessMessage

Success message

Payload

Name

Type

Description

Accepted values

success

boolean

Any

message

string

Optional error message

Any
Examples of payload
{
  "success": true
}

zbos/composition/pause/event

SUB event: Composition paused

\[DEPRECATED] Please use either the v2 version, or the pause response topic.

Content is the composition ID

Channel tags

  • Composer

String
Payload

Name

Type

Description

Accepted values

Message Payload

string

Any
Examples of payload
"composition_id_1"

zbos/composition/pause/event/v2

SUB event: Composition paused

Channel tags

  • Composer

CompositionPauseEvent
Payload

Name

Type

Description

Accepted values

composition_execution_id

string

Any
Examples of payload
{
  "composition_execution_id": "composition_id_1"
}

zbos/composition/resume

PUB Resume composition

Channel tags

  • Composer

CompositionResumeRequest
Payload

Name

Type

Description

Accepted values

key

string

Required key

Any

composition_execution_id

string

Any
Examples of payload
{
  "key": "abc",
  "composition_execution_id": "composition_id_1"
}

zbos/composition/resume/response/\{key}

PUB Resume composition response

Channel tags

  • Composer

SuccessMessage

Success message

Payload

Name

Type

Description

Accepted values

success

boolean

Any

message

string

Optional error message

Any
Examples of payload
{
  "success": true
}

zbos/composition/resume/event

SUB event: Composition Resumed

\[DEPRECATED] Please use either the v2 version, or the resume response topic.

Content is the composition ID

Channel tags

  • Composer

String
Payload

Name

Type

Description

Accepted values

Message Payload

string

Any
Examples of payload
"composition_id_1"

zbos/composition/resume/event/v2

SUB event: Composition Resumed

Channel tags

  • Composer

CompositionResumeEvent
Payload

Name

Type

Description

Accepted values

composition_execution_id

string

Any
Examples of payload
{
  "composition_execution_id": "composition_id_1"
}

zbos/\{source}/loop/event

SUB event: Composition loop state

Channel tags

  • Composer

CompositionLoopPropertyEvent
Payload

Name

Type

Description

Accepted values

composition_execution_id

string

Any

infinite

boolean

Any

total_loop_count

integer

Total loop count

Any

current_loop_count

integer

current loop count

Any
Examples of payload
{
  "infinite": true,
  "composition_execution_id": "composition_id_1",
  "total_loop_count": 50,
  "current_loop_count": 3
}

zbos/composition/settings

PUB Settings for a given composition

\[DEPRECATED] Please use the Task Manager API instead.

Channel tags

  • Composer

TimelinePropertiesWrapper
Payload

Name

Type

Description

Accepted values

properties

object

Any

properties. loop

object

Any

properties.loop. infinite

boolean

Any

properties.loop. repeatTimes

integer

Total loop count

Any

properties.loop. currentRepeatTimes

integer

current loop count

Any

properties. general

object

Any

properties.general. stoppable

boolean

Any

properties.general. powerManagement

string

* DEFAULT * AWARE * DISABLED

properties. debug

object

Any

properties.debug. enabled

boolean

Any

properties.debug. breakpoints

array (string)

Any

properties.debug. breakEachBlock

boolean

Any

timelineId

string

Composition ID

Any

executionId

string

Execution ID

Any

isScheduler

boolean

Any

type

string

* SIMPLE_COMPOSITION * ADVANCED_COMPOSITION
Examples of payload
{}

zbos/composition/save

PUB Save composition

Channel tags

  • Composer

EmptyMessage

Empty message

zbos/composition/save/multiple

PUB Save multiple compositions

see zbos/composition/save/multiple/response/\{key} for response

Channel tags

  • Composer

SaveMultipleCompositionRequest
Payload

Name

Type

Description

Accepted values

key

string

Required key

Any

compositions

array (object)

Array of compositions

Any

compositions. id

string

Any

compositions. name

string

Any

compositions. type

string

* SIMPLE_COMPOSITION * ADVANCED_COMPOSITION

compositions. isDefault

boolean

Any

compositions. metadata

object

Any

compositions.metadata. tags

array (string)

Any

compositions.metadata. favourite

boolean

Any

compositions.metadata. description

string

Any

compositions.metadata. lastModified

number

Any
Examples of payload
{
  "compositions": [
    {
      "id": "string",
      "name": "string",
      "type": "SIMPLE_COMPOSITION",
      "metadata": {
        "favourite": true
      },
      "default": false
    }
  ]
}

zbos/composition/save/event

SUB event: Composition Saved

Channel tags

  • Composer

String
Payload

Name

Type

Description

Accepted values

Message Payload

string

Any
Examples of payload
"string"

zbos/composition/save/multiple/response/\{key}

SUB response: Save multiple compositions

Channel tags

  • Composer

Map
Payload

Name

Type

Description

Accepted values

Message Payload

object

Any
Example of payload (generated)
{}

zbos/composition/load

PUB Load composition

Channel tags

  • Composer

CompositionLoadRequest
Payload

Name

Type

Description

Accepted values

id

string

Any
Examples of payload
{
  "id": "string"
}

zbos/composition/load/event

SUB event: Composition loaded

Channel tags

  • Composer

CompositionInfo
Payload

Name

Type

Description

Accepted values

id

string

Any

name

string

Any

type

string

* SIMPLE_COMPOSITION * ADVANCED_COMPOSITION

isDefault

boolean

Any

metadata

object

Any

metadata. tags

array (string)

Any

metadata. favourite

boolean

Any

metadata. description

string

Any

metadata. lastModified

number

Any
Examples of payload
{
  "id": "string",
  "name": "string",
  "type": "SIMPLE_COMPOSITION",
  "metadata": {
    "favourite": true,
    "description": "some description"
  },
  "default": true
}

zbos/composition/list

PUB Get list of compositions

\[DEPRECATED] Please use zbos/composition/list/get

Channel tags

  • Composer

EmptyMessage

Empty message

zbos/composition/list/event

SUB event: Get list of compositions

\[DEPRECATED] Please use zbos/composition/list/get/response/\{key}

Channel tags

  • Composer

Array<CompositionInfo>
Payload

Name

Type

Description

Accepted values

Message Payload

array (object)

Any

Message Payload. id

string

Any

Message Payload. name

string

Any

Message Payload. type

string

* SIMPLE_COMPOSITION * ADVANCED_COMPOSITION

Message Payload. isDefault

boolean

Any

Message Payload. metadata

object

Any

Message Payload.metadata. tags

array (string)

Any

Message Payload.metadata. favourite

boolean

Any

Message Payload.metadata. description

string

Any

Message Payload.metadata. lastModified

number

Any
Examples of payload
{
  "id": "string",
  "name": "string",
  "type": "SIMPLE_COMPOSITION",
  "metadata": {
    "tags": [
      "someTag"
    ],
    "favourite": false,
    "description": "some description"
  },
  "default": true
}

zbos/composition/delete

PUB Delete composition by id

see zbos/composition/delete/response for response

Channel tags

  • Composer

CompositionDeleteRequest
Payload

Name

Type

Description

Accepted values

id

string

Any
Examples of payload
{
  "id": "string"
}

zbos/composition/delete/all

PUB Deletes all compositions

see zbos/composition/delete/response for response

Channel tags

  • Composer

EmptyMessage

Empty message

zbos/composition/delete/response

SUB response: Delete composition

Channel tags

  • Composer

SuccessMessage

Success message

Payload

Name

Type

Description

Accepted values

success

boolean

Any

message

string

Optional error message

Any
Examples of payload
{
  "success": true
}

zbos/composition/changed/event

SUB event: Composition changed

Channel tags

  • Composer

EmptyMessage

Empty message

zbos/composition/audio/stop

PUB Stop audio composition

Channel tags

  • Composer

EmptyMessage

Empty message

zbos/composition/video/stop

PUB Stop video composition

Channel tags

  • Composer

EmptyMessage

Empty message

zbos/composition/image/stop

PUB Stop image composition

Channel tags

  • Composer

EmptyMessage

Empty message

zbos/composition/error

SUB event: Composition encountered error

List of possible error reasons: 'INVALID_ID': The block id is malformed/broken. 'INVALID_TYPE': The block type is malformed/broken. 'INVALID_BLOCK': One of the properties aside from id and type is malformed/broken.

Channel tags

  • Composer

CompositionError
Payload

Name

Type

Description

Accepted values

type

string

Block type that caused the error, 'UNKNOWN' if not known

Any

id

string

Block ID that caused the error, 'UNKNOWN' if not known

Any

reasons

array (string)

Any
Examples of payload
{
  "type": "string",
  "id": "string"
}

zbos/api/request

PUB Get api

see zbos/api/response/\{key} for response

Channel tags

  • Composer

ApiRequestBlock
Payload

Name

Type

Description

Accepted values

name

string

Any

endpoint

string

Any

body

string

Any

params

object

Any

headers

object

Any
Examples of payload
{}

zbos/api/response/\{key}

SUB response: Get api

Channel tags

  • Composer

String
Payload

Name

Type

Description

Accepted values

Message Payload

string

Any
Example of payload (generated)
"string"

zbos/composition/default/variable/request

PUB Get default composition variables

Payload "key" is optional see zbos/composition/default/variable/response/\{key} for response

Channel tags

  • Composer

KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

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

zbos/composition/default/variable/response/\{key}

SUB response: Get default composition variables

Payload is array of variable names

Channel tags

  • Composer

Array<String>
Payload

Name

Type

Description

Accepted values

Message Payload

array (string)

Any
Example of payload (generated)
[
  "string"
]

zbos/composition/status/get

PUB Get composition status

see zbos/composition/status/response/\{key} for response

Channel tags

  • Composer

CompositionStatusGetRequest
Payload

Name

Type

Description

Accepted values

key

string

Required key

Any

composition_execution_id

string

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

zbos/composition/status/response/\{key}

SUB response: Composition status

Channel tags

  • Composer

CompositionStatus
Payload

Name

Type

Description

Accepted values

composition_execution_id

string

Any

id

string

Any

state

string

Default, playing or paused

* DEFAULT * PLAYING * PAUSED

activeBlocks

array (string)

Any

properties

object

Composition properties

Any

properties. loop

object

Any

properties.loop. infinite

boolean

Any

properties.loop. repeatTimes

integer

Total loop count

Any

properties.loop. currentRepeatTimes

integer

current loop count

Any

properties. general

object

Any

properties.general. stoppable

boolean

Any

properties.general. powerManagement

string

* DEFAULT * AWARE * DISABLED

properties. debug

object

Any

properties.debug. enabled

boolean

Any

properties.debug. breakpoints

array (string)

Any

properties.debug. breakEachBlock

boolean

Any

playCount

integer

Current repeat iteration

Any
Examples of payload
{
  "id": "string",
  "state": "DEFAULT",
  "activeBlocks": [
    "string"
  ],
  "properties": {
    "loop": {
      "infinite": true,
      "repeatTimes": 50,
      "currentRepeatTimes": 3
    },
    "general": {
      "stoppable": true,
      "powerManagement": "DEFAULT"
    },
    "debug": {
      "enabled": true,
      "breakpoints": [
        "block_1",
        "block_2"
      ],
      "breakEachBlock": false
    }
  },
  "playCount": 5
}

zbos/composition/active/get

SUB Get active compositions

Channel tags

  • Composer

KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

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

zbos/composition/active/get/response/\{key}

SUB response: Get active compositions

Channel tags

  • Composer

Array<ActiveComposition>
Payload

Name

Type

Description

Accepted values

Message Payload

array (object)

Any

Message Payload. execution_id

string

Any

Message Payload. source

string

* scheduler * composer * task_manager

Message Payload. state

string

* DEFAULT * PLAYING * PAUSED

Message Payload. settings

object

Any

Message Payload.settings. concurrent

boolean

Any

Message Payload.settings. schedulerParallel

boolean

Any

Message Payload.settings. priority

string

* low * normal * important * critical

Message Payload.settings. weight

integer

Any

Message Payload.settings. on_resume

string

* restart * restart_block * stop

Message Payload. properties

object

Any

Message Payload.properties. loop

object

Any

Message Payload.properties.loop. infinite

boolean

Any

Message Payload.properties.loop. repeatTimes

integer

Total loop count

Any

Message Payload.properties.loop. currentRepeatTimes

integer

current loop count

Any

Message Payload.properties. general

object

Any

Message Payload.properties.general. stoppable

boolean

Any

Message Payload.properties.general. powerManagement

string

* DEFAULT * AWARE * DISABLED

Message Payload.properties. debug

object

Any

Message Payload.properties.debug. enabled

boolean

Any

Message Payload.properties.debug. breakpoints

array (string)

Any

Message Payload.properties.debug. breakEachBlock

boolean

Any

Message Payload. task

object

Any

Message Payload.task. type

string

Type of the task

* composition * single_block

Message Payload.task. data

object

Data required for the chosen task type

Any
Examples of payload
{
  "source": "task_manager",
  "state": "PLAYING",
  "settings": {
    "concurrent": true,
    "priority": "normal",
    "weight": 0,
    "on_resume": "stop"
  },
  "properties": {
    "loop": {
      "infinite": true,
      "repeatTimes": 50,
      "currentRepeatTimes": 3
    },
    "general": {
      "stoppable": true,
      "powerManagement": "DEFAULT"
    },
    "debug": {
      "enabled": true,
      "breakpoints": [
        "block_1",
        "block_2"
      ],
      "breakEachBlock": false
    }
  },
  "execution_id": "string"
}

zbos/composition/active/update/event

SUB Active compositions have changed

Channel tags

  • Composer

Array<ActiveComposition>
Payload

Name

Type

Description

Accepted values

Message Payload

array (object)

Any

Message Payload. execution_id

string

Any

Message Payload. source

string

* scheduler * composer * task_manager

Message Payload. state

string

* DEFAULT * PLAYING * PAUSED

Message Payload. settings

object

Any

Message Payload.settings. concurrent

boolean

Any

Message Payload.settings. schedulerParallel

boolean

Any

Message Payload.settings. priority

string

* low * normal * important * critical

Message Payload.settings. weight

integer

Any

Message Payload.settings. on_resume

string

* restart * restart_block * stop

Message Payload. properties

object

Any

Message Payload.properties. loop

object

Any

Message Payload.properties.loop. infinite

boolean

Any

Message Payload.properties.loop. repeatTimes

integer

Total loop count

Any

Message Payload.properties.loop. currentRepeatTimes

integer

current loop count

Any

Message Payload.properties. general

object

Any

Message Payload.properties.general. stoppable

boolean

Any

Message Payload.properties.general. powerManagement

string

* DEFAULT * AWARE * DISABLED

Message Payload.properties. debug

object

Any

Message Payload.properties.debug. enabled

boolean

Any

Message Payload.properties.debug. breakpoints

array (string)

Any

Message Payload.properties.debug. breakEachBlock

boolean

Any

Message Payload. task

object

Any

Message Payload.task. type

string

Type of the task

* composition * single_block

Message Payload.task. data

object

Data required for the chosen task type

Any
Examples of payload
{
  "source": "task_manager",
  "state": "PLAYING",
  "settings": {
    "concurrent": true,
    "priority": "normal",
    "weight": 0,
    "on_resume": "stop"
  },
  "properties": {
    "loop": {
      "infinite": true,
      "repeatTimes": 50,
      "currentRepeatTimes": 3
    },
    "general": {
      "stoppable": true,
      "powerManagement": "DEFAULT"
    },
    "debug": {
      "enabled": true,
      "breakpoints": [
        "block_1",
        "block_2"
      ],
      "breakEachBlock": false
    }
  },
  "execution_id": "string"
}

zbos/composition/block/start

PUB Start composition block

Channel tags

  • Composer

Block
Payload

Name

Type

Description

Accepted values

id

string

Block ID

Any

index

integer

Any

blocking

boolean

Any

input

object

Any

input. connectors

array (object)

Any

input.connectors. id

string

Any

input.connectors. connectorType

string

* DEFAULT * TIMEOUT * ALL * SUCCESS * FAIL

input.connectors. connection

object

Any

input.connectors.connection. blockId

string

Any

input.connectors.connection. connectorId

string

Any

output

object

Any

output. connectors

array (object)

Any

output.connectors. id

string

Any

output.connectors. connectorType

string

* DEFAULT * TIMEOUT * ALL * SUCCESS * FAIL

output.connectors. connection

object

Any

output.connectors.connection. blockId

string

Any

output.connectors.connection. connectorId

string

Any

nextBlockId

string

Any
Examples of payload
{
  "index": 5,
  "blocking": false,
  "nextBlockId": "string"
}

zbos/\{source}/block/start/event

SUB event: Composition block started

Channel tags

  • Composer

String
Payload

Name

Type

Description

Accepted values

Message Payload

string

Any
Example of payload (generated)
"string"

zbos/composition/block/stop

PUB Stop composition block

Block ID to stop, when key = "all", all active blocks will be stopped.

Channel tags

  • Composer

KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

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

zbos/\{source}/block/end/event

SUB event: Composition block ended

Channel tags

  • Composer

String
Payload

Name

Type

Description

Accepted values

Message Payload

string

Any
Example of payload (generated)
"string"

zbos/\{source}/block/pause/event

SUB event: Composition block paused

Channel tags

  • Composer

String
Payload

Name

Type

Description

Accepted values

Message Payload

string

Any
Example of payload (generated)
"string"

zbos/composition/block/stringoperation/types/get

PUB Get all string operation typessee zbos/composition/block/stringoperation/types/response/\{key} for response

Channel tags

  • Composer

TypesRequest
Payload

Name

Type

Description

Accepted values

key

string

Required random key

Any

language

string

Optional. Set the language for all labels. Otherwise it will be the default language. The language format is ISO 639-1 language code, Eg: 'en' or 'en-US'

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

zbos/composition/block/stringoperation/types/response/\{key}

SUB response: String operation types

Channel tags

  • Composer

Array<StringOperation>
Payload

Name

Type

Description

Accepted values

Message Payload

array (object)

Any

Message Payload. type

string

* UPPERCASE * LOWERCASE * CAPITALIZE * TITLE * REMOVE * REPLACE * LENGTH * COUNT * SLICE * STARTS_WITH * ENDS_WITH * CONTAINS

Message Payload. label

string

Human-readable label

Any

Message Payload. label_key

string

Translation key for human-readable label

Any

Message Payload. arguments

object

Map of arguments for this string operation

Any
Examples of payload
{
  "type": "SLICE",
  "label": "Slice",
  "arguments": {
    "start": {
      "optional": true,
      "label_key": "some_category.start",
      "can_regex": false
    },
    "end": {
      "optional": true,
      "label_key": "some_category.end",
      "can_regex": false
    }
  },
  "label_key": "some_category.slice"
}
{
  "type": "REPLACE",
  "label": "Replace",
  "arguments": {
    "target": {
      "optional": false,
      "label_key": "some_category.target",
      "can_regex": true
    },
    "replacement": {
      "optional": false,
      "label_key": "some_category.replacement",
      "can_regex": true
    }
  },
  "label_key": "some_category.replace"
}

zbos/composition/block/mathoperation/types/get

PUB Get all math operation typessee zbos/composition/block/mathoperation/types/get/response/\{key} for response

Channel tags

  • Composer

TypesRequest
Payload

Name

Type

Description

Accepted values

key

string

Required random key

Any

language

string

Optional. Set the language for all labels. Otherwise it will be the default language. The language format is ISO 639-1 language code, Eg: 'en' or 'en-US'

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

zbos/composition/block/mathoperation/types/get/response/\{key}

SUB response: Math operation types

Channel tags

  • Composer

Array<MathOperation>
Payload

Name

Type

Description

Accepted values

Message Payload

array (object)

Any

Message Payload. type

string

* + * - * / * * * ^ * mod * sqrt * root

Message Payload. label

string

Human-readable label

Any

Message Payload. label_key

string

Translation key for human-readable label

Any

Message Payload. has_second_argument

boolean

Determines whether a second argument is used for this operation

Any
Examples of payload
{
  "type": "+",
  "label": "ADD",
  "label_key": "some_category.ADD",
  "has_second_argument": true
}
{
  "type": "-",
  "label": "SUBTRACT",
  "label_key": "some_category.SUBTRACT",
  "has_second_argument": true
}
{
  "type": "/",
  "label": "DIVIDE",
  "label_key": "some_category.DIVIDE",
  "has_second_argument": true
}
{
  "type": "*",
  "label": "MULTIPLY",
  "label_key": "some_category.MULTIPLY",
  "has_second_argument": true
}
{
  "type": "^",
  "label": "POWER",
  "label_key": "some_category.POWER",
  "has_second_argument": true
}
{
  "type": "mod",
  "label": "MODULO",
  "label_key": "some_category.MODULO",
  "has_second_argument": true
}
{
  "type": "sqrt",
  "label": "SQUARE_ROOT",
  "label_key": "some_category.SQUARE_ROOT",
  "has_second_argument": false
}
{
  "type": "root",
  "label": "ROOT",
  "label_key": "some_category.ROOT",
  "has_second_argument": true
}

zbos/composition/block/datetime/info/get

PUB Get datetime operation infosee zbos/composition/block/datetime/info/get/response/\{key} for response

Channel tags

  • Composer

TypesRequest
Payload

Name

Type

Description

Accepted values

key

string

Required random key

Any

language

string

Optional. Set the language for all labels. Otherwise it will be the default language. The language format is ISO 639-1 language code, Eg: 'en' or 'en-US'

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

zbos/composition/block/datetime/info/get/response/\{key}

SUB response: Datetime operation info

Channel tags

  • Composer

DateTimeOperationInfo
Payload

Name

Type

Description

Accepted values

types

array (object)

Any

types. type

string

Any

types. label

string

Human-readable label

Any

types. label_key

string

Translation key for human-readable label

Any

types. requires_value

boolean

Whether this type requires a value to be passed

Any

fields

array (object)

Any

fields. field

string

Any

fields. label

string

Human-readable label

Any

fields. label_key

string

Translation key for human-readable label

Any
Examples of payload
{
  "types": [
    {
      "type": "GET",
      "label": "Get",
      "label_key": "category_get",
      "requires_value": false
    }
  ],
  "fields": [
    {
      "field": "YEARS",
      "label": "Years",
      "label_key": "category_years"
    }
  ]
}

zbos/composition/block/dynamic/get

PUB Get dynamic block listsee zbos/composition/block/dynamic/get/response/\{key} for response

Channel tags

  • Composer

KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

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

zbos/composition/block/dynamic/get/response/\{key}

SUB response: Get dynamic block list

Channel tags

  • Composer

Array<DynamicBlock>
Payload

Name

Type

Description

Accepted values

Message Payload

array (object)

Any

Message Payload. id

string

Any

Message Payload. name

string

Any

Message Payload. description

string

Any
Examples of payload
{
  "id": "api_google",
  "name": "Google API",
  "description": "This is the Google API"
}

zbos/composition/block/dynamic/event

SUB event: New dynamic blocks found

Channel tags

  • Composer

Array<DynamicBlock>
Payload

Name

Type

Description

Accepted values

Message Payload

array (object)

Any

Message Payload. id

string

Any

Message Payload. name

string

Any

Message Payload. description

string

Any
Example of payload (generated)
[
  {
    "id": "string",
    "name": "string",
    "description": "string"
  }
]

zbos/composition/block/dynamic/settings/get

PUB Get the next set of settings for a dynamic block, an empty response indicates no more settingssee zbos/composition/block/dynamic/settings/get/response/\{key} for response

Channel tags

  • Composer

UpdateSettingsRequest
Payload

Name

Type

Description

Accepted values

key

string

Any

category_name

string

Any

category

object

Any

category. settings

object

Any

category. subcategories

object

Optional subcategories

Any
Examples of payload
{
  "key": "test",
  "category": {
    "settings": {
      "server": {
        "value": "production"
      }
    }
  },
  "category_name": "api_google"
}

zbos/composition/block/dynamic/settings/get/response/\{key}

SUB response: Get the next set of settings for a dynamic block

Channel tags

  • Composer

DynamicSettingsGetResponse
Payload

Name

Type

Description

Accepted values

success

boolean

Any

message

string

Any

response

object

Any

response. label_key

string

Translation key should use the dot notation: \{category}.\{key}

Any

response. description_key

string

Optional description key Translation key should use the dot notation: \{category}.\{key}

Any

response. settings

object

Any

response. subcategories

object

Optional subcategories

Any

response. orphaned

boolean

The orphaned state indicates that this category was not added again since boot.

Any
Examples of payload
{
  "settings": {
    "server": {
      "type": "select_single",
      "label": "Server",
      "options": [
        {
          "key": "production",
          "value": "production",
          "label": "production"
        }
      ],
      "required": true
    },
    "server_variables": {
      "properties": {
        "token": {
          "type": "string",
          "label": "Token",
          "description": "Access token",
          "required": true
        }
      },
      "type": "object",
      "label": "Server variables",
      "required": true
    }
  }
}

zbos/composition/debug/log/add/event

PUB event: Composition debug log added

Channel tags

  • Composer

CompositionDebugLog
Payload

Name

Type

Description

Accepted values

execution_id

string

Any

composition_id

string

Any

block_id

string

Optional, only if logged from a block

Any

timestamp

number

Any

level

string

* info * warning * error

message

string

Any
Examples of payload
{
  "timestamp": 1648555986.773,
  "level": "info",
  "message": "Composition started",
  "execution_id": "execution_id_1",
  "composition_id": "composition_id_1"
}
{
  "timestamp": 1648555986.773,
  "level": "info",
  "message": "Block started",
  "execution_id": "execution_id_1",
  "composition_id": "composition_id_1",
  "block_id": "block_id_1"
}

zbos/composition/debug/variables/get

PUB Get composition variables

Channel tags

  • Composer

CompositionGetVariablesRequest
Payload

Name

Type

Description

Accepted values

key

string

Required random key

Any

execution_id

string

Any

composition_id

string

Will be ignored if execution_id is filled in

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

zbos/composition/debug/variables/get/response/\{key}

PUB response: Get composition variables

Channel tags

  • Composer

CompositionGetVariablesResponse
Payload

Name

Type

Description

Accepted values

variables

object

Any
Examples of payload
{
  "variables": {
    "variable_1": "value_1",
    "variable_2": "value_2"
  }
}

zbos/composition/debug/variables/change/event

PUB event: Composition variables changed

Channel tags

  • Composer

CompositionVariablesChangeEvent
Payload

Name

Type

Description

Accepted values

execution_id

string

Any

composition_id

string

Any

variables

object

Any
Examples of payload
{
  "variables": {
    "variable_1": "value_1",
    "variable_2": "value_2"
  },
  "execution_id": "execution_id_1",
  "composition_id": "composition_id_1"
}

zbos/composition/debug/breakpoint/hit/event

SUB event: Breakpoint hit

Channel tags

  • Composer

CompositionBreakpointHitEvent
Payload

Name

Type

Description

Accepted values

execution_id

string

Any

composition_id

string

Any

block_id

string

Any

variables

object

Any
Examples of payload
{
  "variables": {
    "variable_1": "value_1",
    "variable_2": "value_2"
  },
  "execution_id": "execution_id_1",
  "composition_id": "composition_id_1",
  "block_id": "block_id_1"
}