Survey

API for communication with ZBOS by Zora Robotics.

Channels

zbos/survey/get

publish

Get survey

Channel tags
  • Survey

Message KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

Any

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

zbos/survey/get/response/{key}

subscribe

response: Get survey

Channel tags
  • Survey

Message String
Payload

Name

Type

Description

Accepted values

Message Payload

string

Any

Example of payload (generated)
"string"

zbos/survey/all/get

publish

Get all surveys

Channel tags
  • Survey

Message KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

Any

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

zbos/survey/all/get/response/{key}

subscribe

response: Get all surveys

Channel tags
  • Survey

Message Array<SimpleSurvey>
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

Any

Message Payload.meta

object

Any

Message Payload.meta.languages

array(string)

Any

Message Payload.meta.default_language

string

Any

Message Payload.meta.version

string

Any

Message Payload.meta.created_on

string

Any

Message Payload.meta.last_updated_on

string

Any

Examples of payload
{
  "id": "string",
  "name": "string"
}

zbos/survey/save

publish

Add/save survey

Channel tags
  • Survey

Message SimpleSurvey
Payload

Name

Type

Description

Accepted values

id

string

Any

name

string

Any

type

string

Any

meta

object

Any

meta.languages

array(string)

Any

meta.default_language

string

Any

meta.version

string

Any

meta.created_on

string

Any

meta.last_updated_on

string

Any

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

zbos/survey/save/event

subscribe

event: Survey added/saved

Channel tags
  • Survey

Message SuccessMessage

Success message

Payload

Name

Type

Description

Accepted values

success

boolean

Any

message

string

Optional error message

Any

Examples of payload
{
  "success": true
}

zbos/survey/delete

publish

Delete survey

Channel tags
  • Survey

Message SimpleSurvey
Payload

Name

Type

Description

Accepted values

id

string

Any

name

string

Any

type

string

Any

meta

object

Any

meta.languages

array(string)

Any

meta.default_language

string

Any

meta.version

string

Any

meta.created_on

string

Any

meta.last_updated_on

string

Any

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

zbos/survey/delete/event

subscribe

event: Survey deleted

Channel tags
  • Survey

Message SuccessMessage

Success message

Payload

Name

Type

Description

Accepted values

success

boolean

Any

message

string

Optional error message

Any

Examples of payload
{
  "success": true
}