Cloud API for communication with ZBOS cloud by Zora Robotics. Channels push/{serial}/alarm/set PUB Request cloud to trigger an alarm RaiseAlarmRequest Payload Name Type Description Accepted values key string Any alarmServiceProvider string Any metadata object Any Example of payload (generated) { "key": "string", "alarmServiceProvider": "string", "metadata": {} } zbos/{serial}/alarm/set/response/{key} SUB Response to an alarm trigger RaiseAlarmResponse Payload Name Type Description Accepted values id string Any Example of payload (generated) { "id": "string" } zbos/{serial}/cloud/webhook/event SUB Event for the robot when a webhook has been triggered WebhookTriggeredEvent Payload Name Type Description Accepted values id string Any data string Any Example of payload (generated) { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "data": "string" } push/{serial}/cloud/govirtual/login PUB perform a user login (this links the robot to the user) GoVirtualLoginRequest Payload Name Type Description Accepted values key string Any jwt string Any Example of payload (generated) { "key": "string", "jwt": "string" } zbos/{serial}/cloud/govirtual/login/response/{key} SUB result of logging in BaseResponse Payload Name Type Description Accepted values success boolean Any error string Any Example of payload (generated) { "success": true, "error": "string" } push/{serial}/cloud/govirtual/rooms/get PUB get list of rooms BaseListRequest Payload Name Type Description Accepted values key string Any offset integer Any limit integer Any search string Any Example of payload (generated) { "key": "string", "offset": 0, "limit": 0, "search": "string" } zbos/{serial}/cloud/govirtual/rooms/get/response/{key} SUB a list with rooms RoomListResponse Payload Name Type Description Accepted values success boolean Any error string Any offset integer Any limit integer Any numResults integer Any rooms array (object) Any rooms. id string Any rooms. name string Any rooms. description string Any rooms. createdTimestamp number Any rooms. maxSize integer Any rooms. currentSize integer Any rooms. environment string Any rooms. startingEnvironment string Any rooms. matrixId string Any rooms. environments array (object) Any rooms.environments. id string Any rooms.environments. clientId string Any rooms.environments. modifiedTimestamp number Any Example of payload (generated) { "success": true, "error": "string", "offset": 0, "limit": 0, "numResults": 0, "rooms": [] } push/{serial}/cloud/govirtual/room/get PUB get the current room of the robot BaseRequest Payload Name Type Description Accepted values key string Any Example of payload (generated) { "key": "string" } zbos/{serial}/cloud/govirtual/room/get/response/{key} SUB room that the robot is a member of CurrentRoomResponse Payload Name Type Description Accepted values success boolean Any error string Any room object Any room. id string Any room. name string Any room. description string Any room. createdTimestamp number Any room. maxSize integer Any room. currentSize integer Any room. environment string Any room. startingEnvironment string Any room. matrixId string Any room. environments array (object) Any room.environments. id string Any room.environments. clientId string Any room.environments. modifiedTimestamp number Any membership object Any membership. userId string Any membership. robotSerial string Any membership. robotName string Any membership. models array (object) Any membership.models. id string Any membership.models. name string Any membership.models. modelId string Any membership.models. state object Any Example of payload (generated) { "success": true, "error": "string", "room": { "id": "string", "name": "string", "description": "string", "createdTimestamp": 0, "maxSize": 0, "currentSize": 0, "environment": "string", "startingEnvironment": "string", "matrixId": "string", "environments": [] }, "membership": { "userId": "string", "robotSerial": "string", "robotName": "", "models": [] } } push/{serial}/cloud/govirtual/room/create PUB make a new room and join it CreateRoomRequest Payload Name Type Description Accepted values key string Any name string Any size integer Any robotName string Any models array (object) Any models. id string Any models. name string Any models. modelId string Any models. state object Any Example of payload (generated) { "key": "string", "name": "string", "size": 0, "robotName": "", "models": [] } push/{serial}/cloud/govirtual/room/create/response/{key} SUB result of creating a govirtual room CreateRoomResponse Payload Name Type Description Accepted values success boolean Any error string Any id string Any Example of payload (generated) { "success": true, "error": "string", "id": "string" } push/{serial}/cloud/govirtual/rooms/{room}/join PUB join a room JoinRoomRequest Payload Name Type Description Accepted values key string Any robotName string Any models array (object) Any models. id string Any models. name string Any models. modelId string Any models. state object Any Example of payload (generated) { "key": "string", "robotName": "", "models": [] } zbos/{serial}/cloud/govirtual/rooms/{room}/join/response/{key} SUB result of joining a room JoinRoomResponse Payload Name Type Description Accepted values success boolean Any error string Any room object Any room. id string Any room. name string Any room. description string Any room. createdTimestamp number Any room. maxSize integer Any room. currentSize integer Any room. environment string Any room. startingEnvironment string Any room. matrixId string Any room. environments array (object) Any room.environments. id string Any room.environments. clientId string Any room.environments. modifiedTimestamp number Any membership object Any membership. userId string Any membership. robotSerial string Any membership. robotName string Any membership. models array (object) Any membership.models. id string Any membership.models. name string Any membership.models. modelId string Any membership.models. state object Any Example of payload (generated) { "success": true, "error": "string", "room": { "id": "string", "name": "string", "description": "string", "createdTimestamp": 0, "maxSize": 0, "currentSize": 0, "environment": "string", "startingEnvironment": "string", "matrixId": "string", "environments": [] }, "membership": { "userId": "string", "robotSerial": "string", "robotName": "", "models": [] } } push/{serial}/cloud/govirtual/rooms/{room}/members/get PUB get members of the specified room BaseListRequest Payload Name Type Description Accepted values key string Any offset integer Any limit integer Any search string Any Example of payload (generated) { "key": "string", "offset": 0, "limit": 0, "search": "string" } zbos/{serial}/cloud/govirtual/rooms/{room}/members/get/response/{key} SUB a list with members of the room RoomMemberListResponse Payload Name Type Description Accepted values success boolean Any error string Any offset integer Any limit integer Any numResults integer Any members array (object) Any members. userId string Any members. robotSerial string Any members. robotName string Any members. models array (object) Any members.models. id string Any members.models. name string Any members.models. modelId string Any members.models. state object Any Example of payload (generated) { "success": true, "error": "string", "offset": 0, "limit": 0, "numResults": 0, "members": [ { "userId": "string", "robotSerial": "string", "robotName": "", "models": [] } ] } push/{serial}/cloud/govirtual/rooms/{room}/leave PUB leave a room BaseRequest Payload Name Type Description Accepted values key string Any Example of payload (generated) { "key": "string" } zbos/{serial}/cloud/govirtual/rooms/{room}/leave/response/{key} SUB make a new room and join it BaseResponse Payload Name Type Description Accepted values success boolean Any error string Any Example of payload (generated) { "success": true, "error": "string" } push/{serial}/cloud/govirtual/rooms/{room}/animation/start PUB robot starts an animation StartAnimationRequest Payload Name Type Description Accepted values modelId string Any data object Any Example of payload (generated) { "modelId": "string", "data": {} } push/{serial}/cloud/govirtual/rooms/{room}/animation/stop PUB robot stops the animation StopAnimationRequest Payload Name Type Description Accepted values modelId string Any data object Any Example of payload (generated) { "modelId": "string", "data": {} } push/{serial}/cloud/govirtual/rooms/{room}/position/set PUB robot sends its place in the world (xyz + rotation) SetPositionRequest Payload Name Type Description Accepted values modelId string Any state object Any Example of payload (generated) { "modelId": "string", "state": {} } push/{serial}/cloud/govirtual/rooms/{room}/position/action/set PUB robot sends its progress on position events SetPositionActionRequest Payload Name Type Description Accepted values modelId string Any action object Any Example of payload (generated) { "modelId": "string", "action": {} } push/{serial}/cloud/govirtual/rooms/{room}/objects/get PUB get list with info about all world objects in the room BaseListRequest Payload Name Type Description Accepted values key string Any offset integer Any limit integer Any search string Any Example of payload (generated) { "key": "string", "offset": 0, "limit": 0, "search": "string" } zbos/{serial}/cloud/govirtual/rooms/{room}/objects/get/response/{key} SUB list with world objects in the room WorldObjectListResponse Payload Name Type Description Accepted values success boolean Any error string Any offset integer Any limit integer Any numResults integer Any objects array (object) Any objects. id string Any objects. name string Any objects. state string Any objects. disabled boolean Any objects. supportsMedia boolean Any objects. switchesEnvironmentTo string Any objects. concurrentUsageLimit integer Any objects. lastChangedTimestamp number Any objects. lastChangedBy string Any objects. mediaFileId string Any objects. inUseBy array (string) Any Example of payload (generated) { "success": true, "error": "string", "offset": 0, "limit": 0, "numResults": 0, "objects": [ { "id": "string", "name": "string", "state": "string", "disabled": false, "supportsMedia": false, "switchesEnvironmentTo": "", "concurrentUsageLimit": 0, "lastChangedTimestamp": 0, "lastChangedBy": "string", "mediaFileId": "2391033b-772d-4a9e-be79-92514a3a73f5", "inUseBy": [] } ] } push/{serial}/cloud/govirtual/rooms/{room}/objects/{object}/get PUB get info about a world object BaseRequest Payload Name Type Description Accepted values key string Any Example of payload (generated) { "key": "string" } zbos/{serial}/cloud/govirtual/rooms/{room}/objects/{object}/get/response/{key} SUB info about a world object GetWorldObjectResponse Payload Name Type Description Accepted values success boolean Any error string Any object object Any object. id string Any object. name string Any object. state string Any object. disabled boolean Any object. supportsMedia boolean Any object. switchesEnvironmentTo string Any object. concurrentUsageLimit integer Any object. lastChangedTimestamp number Any object. lastChangedBy string Any object. mediaFileId string Any object. inUseBy array (string) Any Example of payload (generated) { "success": true, "error": "string", "object": { "id": "string", "name": "string", "state": "string", "disabled": false, "supportsMedia": false, "switchesEnvironmentTo": "", "concurrentUsageLimit": 0, "lastChangedTimestamp": 0, "lastChangedBy": "string", "mediaFileId": "2391033b-772d-4a9e-be79-92514a3a73f5", "inUseBy": [] } } push/{serial}/cloud/govirtual/rooms/{room}/objects/{object}/set PUB change a world object SetWorldObjectRequest Payload Name Type Description Accepted values state string Any mediaFileId string Any inUse boolean Any Example of payload (generated) { "state": "string", "mediaFileId": "string", "inUse": true } push/{serial}/cloud/govirtual/rooms/{room}/models/get PUB model info for the room BaseListRequest Payload Name Type Description Accepted values key string Any offset integer Any limit integer Any search string Any Example of payload (generated) { "key": "string", "offset": 0, "limit": 0, "search": "string" } zbos/{serial}/cloud/govirtual/rooms/{room}/models/get/response/{key} SUB info about models in the room ModelListResponse Payload Name Type Description Accepted values success boolean Any error string Any offset integer Any limit integer Any numResults integer Any models array (object) Any models. id string Any models. name string Any models. version integer Any models. public boolean Any models. ownerId string Any Example of payload (generated) { "success": true, "error": "string", "offset": 0, "limit": 0, "numResults": 0, "models": [ { "id": "string", "name": "string", "version": 0, "public": true, "ownerId": "string" } ] } push/{serial}/cloud/govirtual/models/get PUB get list of models the robot can use as its avatar BaseListRequest Payload Name Type Description Accepted values key string Any offset integer Any limit integer Any search string Any Example of payload (generated) { "key": "string", "offset": 0, "limit": 0, "search": "string" } zbos/{serial}/cloud/govirtual/models/get/response/{key} SUB list of available models ModelListResponse Payload Name Type Description Accepted values success boolean Any error string Any offset integer Any limit integer Any numResults integer Any models array (object) Any models. id string Any models. name string Any models. version integer Any models. public boolean Any models. ownerId string Any Example of payload (generated) { "success": true, "error": "string", "offset": 0, "limit": 0, "numResults": 0, "models": [ { "id": "string", "name": "string", "version": 0, "public": true, "ownerId": "string" } ] } push/{serial}/cloud/govirtual/animations/get PUB get list of animations the robot can use on its avatar BaseListRequest Payload Name Type Description Accepted values key string Any offset integer Any limit integer Any search string Any Example of payload (generated) { "key": "string", "offset": 0, "limit": 0, "search": "string" } zbos/{serial}/cloud/govirtual/animations/get/response/{key} SUB list of animations AnimationListResponse Payload Name Type Description Accepted values success boolean Any error string Any offset integer Any limit integer Any numResults integer Any animations array (object) Any animations. id string Any animations. name string Any animations. category string Any animations. version integer Any Example of payload (generated) { "success": true, "error": "string", "offset": 0, "limit": 0, "numResults": 0, "animations": [ { "id": "string", "name": "string", "category": "string", "version": 0 } ] } cloud/govirtual/rooms/{room}/members/join/event SUB send when someone joins the room RoomJoinLeaveEvent Payload Name Type Description Accepted values membership object Any membership. userId string Any membership. robotSerial string Any membership. robotName string Any membership. models array (object) Any membership.models. id string Any membership.models. name string Any membership.models. modelId string Any membership.models. state object Any Example of payload (generated) { "membership": { "userId": "string", "robotSerial": "string", "robotName": "", "models": [] } } cloud/govirtual/rooms/{room}/members/leave/event SUB send when someone leaves the room RoomJoinLeaveEvent Payload Name Type Description Accepted values membership object Any membership. userId string Any membership. robotSerial string Any membership. robotName string Any membership. models array (object) Any membership.models. id string Any membership.models. name string Any membership.models. modelId string Any membership.models. state object Any Example of payload (generated) { "membership": { "userId": "string", "robotSerial": "string", "robotName": "", "models": [] } } cloud/govirtual/rooms/{room}/animation/start/event SUB send on animation start AnimationStartEvent Payload Name Type Description Accepted values robotSerial string Any animation object Any animation. modelId string Any animation. data object Any Example of payload (generated) { "robotSerial": "string", "animation": { "modelId": "string", "data": {} } } cloud/govirtual/rooms/{room}/animation/stop/event SUB send when an animation ends AnimationStopEvent Payload Name Type Description Accepted values robotSerial string Any animation object Any animation. modelId string Any animation. data object Any Example of payload (generated) { "robotSerial": "string", "animation": { "modelId": "string", "data": {} } } cloud/govirtual/rooms/{room}/position/event SUB send when a robot position changes PositionEvent Payload Name Type Description Accepted values robotSerial string Any modelId string Any state object Any Example of payload (generated) { "robotSerial": "string", "modelId": "string", "state": {} } cloud/govirtual/rooms/{room}/position/action/event SUB send when a robot position action changes PositionActionEvent Payload Name Type Description Accepted values robotSerial string Any modelId string Any action object Any Example of payload (generated) { "robotSerial": "string", "modelId": "string", "action": {} } cloud/govirtual/rooms/{room}/object/event SUB send when a world object changes WorldObjectChangeEvent Payload Name Type Description Accepted values data object Any data. id string Any data. name string Any data. state string Any data. disabled boolean Any data. supportsMedia boolean Any data. switchesEnvironmentTo string Any data. concurrentUsageLimit integer Any data. lastChangedTimestamp number Any data. lastChangedBy string Any data. mediaFileId string Any data. inUseBy array (string) Any Example of payload (generated) { "data": { "id": "string", "name": "string", "state": "string", "disabled": false, "supportsMedia": false, "switchesEnvironmentTo": "", "concurrentUsageLimit": 0, "lastChangedTimestamp": 0, "lastChangedBy": "string", "mediaFileId": "2391033b-772d-4a9e-be79-92514a3a73f5", "inUseBy": [] } } cloud/{account}/govirtual/model/event SUB GoVirtualModelChangeEvent Payload Name Type Description Accepted values id string Any name string Any status string Any multiplayerApproved boolean Any Example of payload (generated) { "id": "string", "name": "string", "status": "string", "multiplayerApproved": true } cloud/{account}/govirtual/model/scan/session/event SUB GoVirtualModelScanSessionChangeEvent Payload Name Type Description Accepted values id string Any status string Any Example of payload (generated) { "id": "string", "status": "string" } push/{serial}/cloud/login PUB request a new cloud auth token for a robot BaseRequest Payload Name Type Description Accepted values key string Any Example of payload (generated) { "key": "string" } zbos/{serial}/cloud/login/response/{key} SUB login response with an auth token for the robot RobotLoginResponse Payload Name Type Description Accepted values success boolean Any error string Any token string Any Example of payload (generated) { "success": true, "error": "string", "token": "string" } cloud/{account}/robots PUB request a list with all the robots linked to a cloud account BaseListRequest Payload Name Type Description Accepted values key string Any offset integer Any limit integer Any search string Any Example of payload (generated) { "key": "string", "offset": 0, "limit": 0, "search": "string" } cloud/{account}/robots/response/{key} SUB response to robots linked to a cloud account request RobotListResponse Payload Name Type Description Accepted values success boolean Any error string Any offset integer Any limit integer Any numResults integer Any robots array (string) Any Example of payload (generated) { "success": true, "error": "string", "offset": 0, "limit": 0, "numResults": 0, "robots": [ "string" ] } push/{serial}/cloud/user/list PUB request a list with all the accounts linked to a robot BaseListRequest Payload Name Type Description Accepted values key string Any offset integer Any limit integer Any search string Any Example of payload (generated) { "key": "string", "offset": 0, "limit": 0, "search": "string" } zbos/{serial}/cloud/user/list/response/{key} SUB response to accounts linked to a robot request UserListResponse Payload Name Type Description Accepted values success boolean Any error string Any offset integer Any limit integer Any numResults integer Any accounts array (object) Any accounts. id string Any accounts. username string Any accounts. email string Any accounts. picture string Any accounts. admin boolean Any accounts. mqttAccount string Any Example of payload (generated) { "success": true, "error": "string", "offset": 0, "limit": 0, "numResults": 0, "accounts": [ { "id": "string", "username": "string", "email": "string", "picture": "string", "admin": true, "mqttAccount": "string" } ] } push/{serial}/cloud/link/request PUB Create a new link request for a user and this robot CreateRobotLinkRequest Payload Name Type Description Accepted values key string Any userId string Any admin boolean Any createLinkRequest boolean Any Example of payload (generated) { "key": "string", "userId": "string", "admin": false, "createLinkRequest": false } zbos/{serial}/cloud/link/request/response/{key} SUB answer to the request to link a robot to an account (with direct link confirm or approval needed info) CreateRobotLinkResponse Payload Name Type Description Accepted values success boolean Any error string Any status string Any adminInfo object Any adminInfo. count integer Any adminInfo. oldestAdminUsers array (string) Any adminInfo. oldestAdmins array (object) Any adminInfo.oldestAdmins. id string Any adminInfo.oldestAdmins. name string Any adminInfo.oldestAdmins. email string Any Example of payload (generated) { "success": true, "error": "string", "status": "string", "adminInfo": { "count": 0, "oldestAdminUsers": [ "string" ], "oldestAdmins": [ { "id": "string", "name": "string", "email": "string" } ] } } cloud/{account}/link/request/response/{key} SUB answer to the request to link a robot to an account (with direct link confirm or approval needed info) CreateRobotLinkResponse Payload Name Type Description Accepted values success boolean Any error string Any status string Any adminInfo object Any adminInfo. count integer Any adminInfo. oldestAdminUsers array (string) Any adminInfo. oldestAdmins array (object) Any adminInfo.oldestAdmins. id string Any adminInfo.oldestAdmins. name string Any adminInfo.oldestAdmins. email string Any Example of payload (generated) { "success": true, "error": "string", "status": "string", "adminInfo": { "count": 0, "oldestAdminUsers": [ "string" ], "oldestAdmins": [ { "id": "string", "name": "string", "email": "string" } ] } } cloud/{account}/registration/delete PUB request to unlink a cloud account from a robot, can be done by both the robot and the account RobotUnlinkRequest Payload Name Type Description Accepted values key string Any serial string Any Example of payload (generated) { "key": "string", "serial": "string" } zbos/{serial}/registration/delete/response/{key} SUB response to request to unlink a robot from an account BaseResponse Payload Name Type Description Accepted values success boolean Any error string Any Example of payload (generated) { "success": true, "error": "string" } cloud/{account}/registration/delete/response/{key} SUB response to request to unlink a robot from an account BaseResponse Payload Name Type Description Accepted values success boolean Any error string Any Example of payload (generated) { "success": true, "error": "string" } cloud/{account}/robot/link/event SUB a robot was linked to an account RobotLinkEvent Payload Name Type Description Accepted values serial string Any admin boolean Any Example of payload (generated) { "serial": "string", "admin": true } cloud/{account}/robot/unlink/event SUB a robot was unlinked from an account RobotUnlinkEvent Payload Name Type Description Accepted values serial string Any admin boolean Any Example of payload (generated) { "serial": "string", "admin": true } cloud/{account}/storage/file/event SUB a file is fully processed after being uploaded CloudFileEvent Payload Name Type Description Accepted values id string Any status string Any mimetype string Any name string Any folder string Any Example of payload (generated) { "id": "string", "status": "string", "mimetype": "string", "name": "string", "folder": "string" } zbos/{serial}/cloud/storage/file/event SUB a file is fully processed after being uploaded CloudFileEvent Payload Name Type Description Accepted values id string Any status string Any mimetype string Any name string Any folder string Any Example of payload (generated) { "id": "string", "status": "string", "mimetype": "string", "name": "string", "folder": "string" } cloud/{account}/sale/order/event SUB a sale order has changed state SaleOrderEvent Payload Name Type Description Accepted values id string Any status string Any Example of payload (generated) { "id": "string", "status": "string" } push/{serial}/cloud/mail/send PUB request cloud to send a mail TriggerCommunicationRequest Payload Name Type Description Accepted values key string Any trigger string Any parameters object Any Example of payload (generated) { "key": "string", "trigger": "string", "parameters": {} } zbos/{serial}/cloud/mail/send/response/{key} SUB result of sending mail BaseResponse Payload Name Type Description Accepted values success boolean Any error string Any Example of payload (generated) { "success": true, "error": "string" } push/{serial}/cloud/push-notification/send PUB request cloud to send a push notification to a mobile device TriggerCommunicationRequest Payload Name Type Description Accepted values key string Any trigger string Any parameters object Any Example of payload (generated) { "key": "string", "trigger": "string", "parameters": {} } zbos/{serial}/cloud/push-notification/send/response/{key} SUB result of sending push notification BaseResponse Payload Name Type Description Accepted values success boolean Any error string Any Example of payload (generated) { "success": true, "error": "string" } push/{serial}/cloud/license/list PUB request to get the active licenses of a robot BaseListRequest Payload Name Type Description Accepted values key string Any offset integer Any limit integer Any search string Any Example of payload (generated) { "key": "string", "offset": 0, "limit": 0, "search": "string" } zbos/{serial}/cloud/license/list/response/{key} SUB request to get the active licenses of a robot LicenseListResponse Payload Name Type Description Accepted values success boolean Any error string Any offset integer Any limit integer Any numResults integer Any licenses array (object) Any licenses. id string Any licenses. type string Any licenses. createdTimestamp number Any licenses. validFrom integer Any licenses. validUntil integer Any licenses. trial boolean Any licenses. serial string Any licenses. softwareId string Any Example of payload (generated) { "success": true, "error": "string", "offset": 0, "limit": 0, "numResults": 0, "licenses": [ { "id": "string", "type": "string", "createdTimestamp": 0, "validFrom": 0, "validUntil": 0, "trial": false, "serial": "string", "softwareId": "string" } ] } push/{serial}/cloud/huddle/create PUB create a huddle from a robot HuddleCreateRequest Payload Name Type Description Accepted values key string Any password string Any Example of payload (generated) { "key": "string", "password": "string" } zbos/{serial}/cloud/huddle/create/response/{key} SUB result of huddle creation HuddleCreateResponse Payload Name Type Description Accepted values success boolean Any error string Any id string Any Example of payload (generated) { "success": true, "error": "string", "id": "string" } control/{account}/cloud/huddle/create PUB create a huddle from a user HuddleCreateRequest Payload Name Type Description Accepted values key string Any password string Any Example of payload (generated) { "key": "string", "password": "string" } control/{account}/cloud/huddle/create/response/{key} SUB result of huddle creation HuddleCreateResponse Payload Name Type Description Accepted values success boolean Any error string Any id string Any Example of payload (generated) { "success": true, "error": "string", "id": "string" } push/{serial}/cloud/huddle/{huddle}/join PUB join an existing huddle HuddleJoinRequest Payload Name Type Description Accepted values key string Any password string Any Example of payload (generated) { "key": "string", "password": "string" } zbos/{serial}/cloud/huddle/{huddle}/join/response/{key} SUB result of robot trying to join a huddle BaseResponse Payload Name Type Description Accepted values success boolean Any error string Any Example of payload (generated) { "success": true, "error": "string" } control/{account}/cloud/huddle/{huddle}/join PUB create a huddle from a user HuddleJoinRequest Payload Name Type Description Accepted values key string Any password string Any Example of payload (generated) { "key": "string", "password": "string" } control/{account}/cloud/huddle/{huddle}/join/response/{key} SUB result of user trying to join a huddle BaseResponse Payload Name Type Description Accepted values success boolean Any error string Any Example of payload (generated) { "success": true, "error": "string" } push/{serial}/cloud/huddle/{huddle}/leave PUB leave a huddle from a robot BaseRequest Payload Name Type Description Accepted values key string Any Example of payload (generated) { "key": "string" } zbos/{serial}/cloud/huddle/{huddle}/leave/response/{key} SUB result of robot trying to leave a huddle BaseResponse Payload Name Type Description Accepted values success boolean Any error string Any Example of payload (generated) { "success": true, "error": "string" } control/{account}/cloud/huddle/{huddle}/leave PUB leave the huddle from a user BaseRequest Payload Name Type Description Accepted values key string Any Example of payload (generated) { "key": "string" } control/{account}/cloud/huddle/{huddle}/leave/response/{key} SUB result of user trying to leave the huddle BaseResponse Payload Name Type Description Accepted values success boolean Any error string Any Example of payload (generated) { "success": true, "error": "string" }