Skip to content

Button press event

The Button press is an event sent by the Gateway when a button is pressed on the connected scanning device.


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. button_pressed Yes
event_id string The message identifier. This can be used to reference it. Any 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 the worker device. Any 1 <= length <= 128 Yes
gateway_serial string The serial number of the Gateway. Any 1 <= length <= 128 No
trigger_gesture string The button gesture that triggers the event. TRIGGER_DOUBLE_CLICK Yes


  "api_version": "1.0",
  "event_type": "button_pressed",
  "event_id": "02114da8-feae-46e3-8b00-a3f7ea8672df",
  "time_created": 1546300800000,
  "device_serial": "M2MR111100928",
  "gateway_serial": "PGGW000000058",
  "trigger_gesture": "TRIGGER_DOUBLE_CLICK"