Lock

---

Device List Information

Key	Value Type	Description
deviceId	String	device ID
deviceName	String	device name
deviceType	String	device type. Smart Lock
enableCloudService	Boolean	determines if Cloud Service is enabled or not for the current device
hubDeviceId	String	device's parent Hub ID
group	Boolean	determines if a Lock is grouped with another Lock or not
master	Boolean	determines if a Lock is the master device or not when grouped with another Lock in Dual Lock mode
groupName	String	the name of the Lock group
lockDevicesIds	Array	a list of Lock device IDs such that the Lock devices are being grouped in Dual Lock mode

---

Device Status

Key	Value Type	Description
deviceId	String	device ID
deviceType	String	device type. Smart Lock
hubDeviceId	String	device's parent Hub ID
battery	Integer	Four-segment battery level division,<10%, shown as 10;10%~20%, shown as 20;20%~60%, shown as 60;≥60%, shown as 100
version	String	the current firmware version, e.g. V4.2
lockState	String	determines if locked or not
doorState	String	determines if the door is closed or not
calibrate	Boolean	determines if Lock has been calibrated or not

---

Control Commands

deviceType	commandType	Command	command parameter	Description
Lock	command	lock	default	rotate to locked position
Lock	command	unlock	default	rotate to unlocked position
Lock	command	deadbolt	default	disengage deadbolt or latch

---

Webhook Events

Key Name	Value Type	Description
eventType	String	the type of events
eventVersion	String	the current event version
context	Object	the detail info of the event
deviceType	String	the type of the device
deviceMac	String	the MAC address of the device
lockState	String	the state of the device, "LOCKED" stands for the motor is rotated to locking position; "UNLOCKED" stands for the motor is rotated to unlocking position; "JAMMED" stands for the motor is jammed while rotating
battery	Integer	the current battery level, 0-100
timeOfSample	Long	the time stamp when the event is sent

{
    "eventType": "changeReport",
    "eventVersion": "1",
    "context": {
        "deviceType": "WoLock",
        "deviceMac": DEVICE_MAC_ADDR,
        "lockState": "LOCKED",
        "battery":100,
        "timeOfSample": 123456789
    }
}