Survey

API for communication with ZBOS by Zora Robotics.

Channels

zbos/survey/start

PUB Start the survey app

Can specify survey ID or survey name, when left blank the survey picker will be shown

Channel tags

  • Survey

SimpleSurvey
Payload

Name

Type

Description

Accepted values

id

string

Any

name

string

Any

type

string

* SURVEY * QUIZ

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": "some_id"
}
{
  "name": "some_name"
}
{}

zbos/survey/start/event

SUB event: A survey has started

Published when a survey has started

Channel tags

  • Survey

SurveyEvent
Payload

Name

Type

Description

Accepted values

id

string

Any

name

string

Any

type

string

* SURVEY * QUIZ

language

string

Any
Examples of payload
{
  "id": "some_id",
  "name": "some_name",
  "type": "SURVEY",
  "language": "en-US"
}

zbos/survey/question/event

SUB event: A survey question has been asked

Published when a survey question has been asked

Channel tags

  • Survey

SurveyQuestionEvent
Payload

Name

Type

Description

Accepted values

id

string

Any

name

string

Any

type

string

* SURVEY * QUIZ

language

string

Any

question

object

Any

question. id

string

Any

question. title

string

Any

question. type

string

* SLIDER * TEXT * MULTIPLE_CHOICE

question. option_type

string

Only relevant for multiple choice questions

* HORIZONTAL * VERTICAL

question. multi_select

boolean

Only relevant for multiple choice questions

Any

question. options

array (object)

Only relevant for multiple choice questions

Any

question.options. id

string

Any

question.options. image

string

Any

question.options. text

string

Any

question.options. text_position

string

* TOP * BOTTOM

question. slider

object

Only relevant for slider questions

Any

question.slider. id

string

Any

question.slider. min

integer

Any

question.slider. max

integer

Any

question.slider. correct_number

integer

The slider value counted as a correct answer

Any

question.slider. step

integer

Any
Examples of payload
{
  "id": "some_id",
  "name": "some_name",
  "type": "SURVEY",
  "language": "en-US",
  "question": {
    "id": "some_question_id",
    "title": "Please enter your favourite food",
    "type": "TEXT"
  }
}
{
  "id": "some_id",
  "name": "some_name",
  "type": "QUIZ",
  "language": "en-US",
  "question": {
    "id": "some_question_id",
    "title": "When was the first world war?",
    "type": "SLIDER"
  }
}
{
  "id": "some_id",
  "name": "some_name",
  "type": "SURVEY",
  "language": "en-US",
  "question": {
    "id": "some_question_id",
    "title": "Please select your favourite food",
    "type": "MULTIPLE_CHOICE",
    "option_type": "HORIZONTAL",
    "multi_select": false
  }
}

zbos/survey/answer/event

SUB event: A survey question has been answered

Published when a survey question has been answered

Channel tags

  • Survey

SurveyAnswerEvent
Payload

Name

Type

Description

Accepted values

id

string

Any

name

string

Any

type

string

* SURVEY * QUIZ

language

string

Any

question

object

Any

question. id

string

Any

question. title

string

Any

question. type

string

* SLIDER * TEXT * MULTIPLE_CHOICE

question. option_type

string

Only relevant for multiple choice questions

* HORIZONTAL * VERTICAL

question. multi_select

boolean

Only relevant for multiple choice questions

Any

question. options

array (object)

Only relevant for multiple choice questions

Any

question.options. id

string

Any

question.options. image

string

Any

question.options. text

string

Any

question.options. text_position

string

* TOP * BOTTOM

question. slider

object

Only relevant for slider questions

Any

question.slider. id

string

Any

question.slider. min

integer

Any

question.slider. max

integer

Any

question.slider. correct_number

integer

The slider value counted as a correct answer

Any

question.slider. step

integer

Any

answers

array (object)

Any

answers. index

integer

The index of the corresponding option, only relevant for multiple choice questions

Any

answers. text

string

Only relevant for text input questions

Any

answers. correct

boolean

Only relevant for quizzes

Any
Examples of payload
{
  "id": "some_id",
  "name": "some_name",
  "type": "SURVEY",
  "language": "en-US",
  "question": {
    "id": "some_question_id",
    "title": "Please enter your favourite food",
    "type": "TEXT"
  },
  "answers": [
    {
      "text": "Pizza"
    }
  ]
}
{
  "id": "some_id",
  "name": "some_name",
  "type": "SURVEY",
  "language": "en-US",
  "question": {
    "id": "some_question_id",
    "title": "Please select your favourite foods",
    "type": "MULTIPLE_CHOICE",
    "option_type": "HORIZONTAL",
    "multi_select": true
  },
  "answers": [
    {
      "index": 0
    },
    {
      "index": 1
    }
  ]
}

zbos/survey/finish/event

SUB event: A survey has finished

Published when a survey has finished

Channel tags

  • Survey

SurveyEvent
Payload

Name

Type

Description

Accepted values

id

string

Any

name

string

Any

type

string

* SURVEY * QUIZ

language

string

Any
Examples of payload
{
  "id": "some_id",
  "name": "some_name",
  "type": "SURVEY",
  "language": "en-US"
}

zbos/survey/stop/event

SUB event: A survey has stopped

Published when a survey has stopped

Channel tags

  • Survey

SurveyEvent
Payload

Name

Type

Description

Accepted values

id

string

Any

name

string

Any

type

string

* SURVEY * QUIZ

language

string

Any
Examples of payload
{
  "id": "some_id",
  "name": "some_name",
  "type": "SURVEY",
  "language": "en-US"
}

zbos/survey/get

PUB Get survey

see zbos/survey/get/response/\{key} for response

Channel tags

  • Survey

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}

SUB response: Get survey

Channel tags

  • Survey

String
Payload

Name

Type

Description

Accepted values

Message Payload

string

Any
Example of payload (generated)
"string"

zbos/survey/all/get

PUB Get all surveys

see zbos/survey/all/get/response/\{key} for response

Channel tags

  • Survey

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}

SUB response: Get all surveys

Channel tags

  • Survey

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

* SURVEY * QUIZ

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/current/get

PUB Get active survey

see zbos/survey/current/get/response/\{key} for response

Channel tags

  • Survey

KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

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

zbos/survey/current/get/response/\{key}

SUB response: Get active survey

Channel tags

  • Survey

SurveyEvent
Payload

Name

Type

Description

Accepted values

id

string

Any

name

string

Any

type

string

* SURVEY * QUIZ

language

string

Any
Examples of payload
{
  "id": "some_id",
  "name": "some_name"
}

zbos/survey/save

PUB Add/save survey

Channel tags

  • Survey

SimpleSurvey
Payload

Name

Type

Description

Accepted values

id

string

Any

name

string

Any

type

string

* SURVEY * QUIZ

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

SUB event: Survey added/saved

Channel tags

  • Survey

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

PUB Delete survey

Channel tags

  • Survey

SimpleSurvey
Payload

Name

Type

Description

Accepted values

id

string

Any

name

string

Any

type

string

* SURVEY * QUIZ

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

SUB event: Survey deleted

Channel tags

  • Survey

SuccessMessage

Success message

Payload

Name

Type

Description

Accepted values

success

boolean

Any

message

string

Optional error message

Any
Examples of payload
{
  "success": true
}