Skip to content

Worker Feedback command

The Worker Feedback command enables you to send messages to the connected devices in order to play specific feedback sequences. Use it to notify workers about an event to enhance their workflow and help with daily tasks completion.

Response: An Error event in case of error.

Fields

Name Type Description Accepted values Constraints Required
api_version string The input API schema version number. 1.0 Yes
event_type string The message type. feedback! Yes
event_id string The message identifier. This can be used to reference it. Any UUID format UUID format [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12} Yes
time_created integer The time of creation client-side, used to determine the order of incoming messages. Unix time stamp in milliseconds. Any 1546300800000 <= value <= 99999999999999 Yes
device_serial string The serial number of a worker device. Any 1 <= length <= 128 Yes
feedback_action_id string The predefined feedback action that should be signaled. FEEDBACK_POSITIVE FEEDBACK_NEGATIVE FEEDBACK_SPECIAL_YELLOW FEEDBACK_SPECIAL_PURPLE FEEDBACK_SPECIAL_CYAN Yes

Example

{
  "api_version": "1.0",
  "event_type": "feedback!",
  "event_id": "02114da8-feae-46e3-8b00-a3f7ea8672df",
  "time_created": 1546300800000,
  "device_serial": "M2MR111100928",
  "feedback_action_id": "FEEDBACK_POSITIVE"
}

Feedback action identifiers

Feedback GIF
FEEDBACK_POSITIVE FEEDBACK_POSITIVE
FEEDBACK_NEGATIVE FEEDBACK_NEGATIVE
FEEDBACK_SPECIAL_CYAN FEEDBACK_SPECIAL_CYAN
FEEDBACK_SPECIAL_YELLOW FEEDBACK_SPECIAL_YELLOW
FEEDBACK_SPECIAL_PURPLE FEEDBACK_SPECIAL_PURPLE