Event Payload Details

This provides the structure of the response sent as a payload to the webhook URL mentioned in the create subscription call.

Event Payload attributes:

Attribute Name	Attribute Type	Description
id	UUID	Database table primary ID
eventTime	Timestamp	Event timestamp
domain	string	Event category or type (LockEvent, MobileEvent, KeyEvent, etc.)
event	string	Event sub-category or sub-type (Lock/Unlock, Checkout, Checkin, etc.)
data	JSON	Event associated details (keySN, lockSN, userID, storeID, result, etc.)
result	string	Result state as per the data
errorCode	string
entityId	string	Entity ID (Lock SN, User Id, Key SN, etc.)
entityName	string	Entity Name (Lock Name, User Name, Key Name, etc.)
operator	JSON	This generally contains the details of the user performing an action such as login/logout, checkin/checkout, lock/unlock, etc.
UserFullName	string	Associated user's full name configured in the access manager
createdAt	Timestamp	Database record creation timestamp
store_id	Integer	Store or site database ID
shiftLength	Integer	User shift length as configured in the access manager, e.g., 8 hrs, 12 hrs, 24 hrs, etc.
userType	string	User type as configured in the access manager, e.g., User, Admin, etc.
deviceZone	string	Device's (LIVE Lock, Lock) mapped zone name as configured in the access manager
deviceName	string	Device's (LIVE Lock, Lock) name as configured in the access manager
deviceDescription	string	Device's (LIVE Lock, Lock) description as configured in the access manager
sounderEnabled	Boolean
eventMode	string
description	string	Formatted or parsed message description based on all the info in the event payload

Sample Event Payload Structure :

• Parsed or formatted one
• Reference: Lock event

{
    "id": "003b2c62-d4e8-0033-0007-4be538e39261",
    "eventTime": "2023-01-20 18:05:45+05:30",
    "domain": "LockEvent",
    "event": "Lock/Unlock",
    "entityName": "New Device, 2023-01-20, 07:27:03",
    "operator": {
        "id": "1",
        "fullname": "Test X",
        "username": "akash",
        "employeeid": "123456"
    },
    "UserFullName": "Test X",
    "store_id": 2,
    "shiftLength": 8,
    "userType": "Admin",
    "deviceZone": "Zone 1",
    "deviceName": "New Device, 2023-01-20, 07:27:03",
    "deviceDescription": "",
    "description": ""
}