|  Developer
Updated on November 23, 2021

Type of events:

Edit

gets sent if a Zigbee device inclusion status changed

				
					{
    event = "include_device"
    status = "started"
}				
			
fields type description
event string type of an event
status string actual event status
Edit

gets sent if a Zigbee device inclusion progress changed

				
					{
    event = "include_device_progress"
    value = 50
}				
			
fields type description
event string type of an event
value int progress in percents (0-100)
Edit

gets sent if a Zigbee Door Lock user codes scan progress changed,/p>

				
					{
    event = "user_codes_request_progress",
    node_id = 42,
    endpoint_id = 1,
    value = 50
}				
			
fields type description
event string type of an event
node_id int node ID
endpoint_id int endpoint ID
value int progress in percents (0-100)
Edit

gets sent if a new Zigbee device has been included

				
					{
    event = "node_added",
    node_id = 2
}				
			
fields type description
event string type of an event
node_id int a unique id of a Zigbee device within a Zigbee network
Edit

gets sent if a Zigbee device has been rejoined

				
					{
    event = "node_rejoined",
    node_id = 2
}				
			
fields type description
event string type of an event
node_id int a unique id of a Zigbee device within a Zigbee network
Edit

gets sent if a Zigbee device has been excluded from hub network

				
					{
    event = "node_removed",
    node_id = 2,
    manufactured_id = "Ezlo",
    model_id = "Ezlo plug"
}				
			
fields type description
event string type of an event
node_id int
manufactured_id string
model_id string
Edit

gets sent if a pcp value has been changed

				
					{
    event = "attribute_value_updated",
    node_id = 2,
    endpoint_id = 1,
    cluster_name = "ias_zone",
    attribute = {...}
}				
			
fields type description
event string type of an event
node_id int node ID
endpoint_id int endpoint ID
cluster_name string name of attribute cluster
attribute table attribute with new value
Edit

gets sent if a manufacturer specific pcp value has been changed

				
					{
    event = "mfg_specific_attribute_value_updated",
    node_id = 2,
    endpoint_id = 1,
    cluster_id = 35,
    attribute = {...}
}				
			
fields type description
event string type of an event
node_id int node ID
endpoint_id int endpoint ID
cluster_id int attribute cluster ID
attribute table attribute with new value
Edit

gets sent if an unknown attribute(that wasn’t reported during inclusion process) value has been changed

				
					{
    event = "unknown_attribute_value_updated",
    node_id = 2,
    endpoint_id = 1,
    cluster_id = 15,
    cluster_name = "ias_zone",
    attribute_id = 0,
    attribute_name = "ZoneStatus",
    value = "1"
}				
			
fields type description
event string type of an event
node_id int node ID
endpoint_id int endpoint ID
cluster_id int ID of attribute cluster
cluster_name string name of attribute cluster
attribute_id int attribute ID
attribute_name int attribute name
value string new attribute value
Edit

gets sent if command without parameters received

				
					{
    event = "simple_command_received",
    node_id = 2,
    endpoint_id = 1,
    cluster_name = "ias_zone",
    command_id = 0,
    command_name = "Panic"
}				
			
fields type description
event string type of an event
node_id int node ID
endpoint_id int endpoint ID
cluster_name string name of attribute cluster
command_id int command ID
command_name string name of command
Edit

gets sent if IAS Ace Arm command received

				
					{
    event = "arm_command_received",
    node_id = 2,
    endpoint_id = 1,
    cluster_name = "ias_ace",
    command_id = 0,
    command_name = "Arm",
    arm_mode = "disarm"
    pin_code = "1234"
}				
			
fields type description
event string type of an event
node_id int node ID
endpoint_id int endpoint ID
cluster_name string name of attribute cluster
command_id int command ID
command_name string name of command
arm_mode string action to be applied on zone
pin_code string pin code
Possible arm modes
disarm
arm_day_home_zones_only
arm_night_home_zones_only
arm_all_zones
Edit

gets sent if Door Lock Get User Response command received

Edit
				
					{
    event = "arm_command_received",
    node_id = 2,
    endpoint_id = 1,
    cluster_name = "ias_ace",
    command_id = 0,
    command_name = "Arm",
    arm_mode = "disarm"
    pin_code = "1234"
}				
			
Edit
fields type description
event string type of an event
node_id int node ID
endpoint_id int endpoint ID
cluster_name string name of attribute cluster
command_id int command ID
command_name string name of command
user_id int user ID
user_status string user status
user_type string user type
pin_code string pin code
Edit
Possible user statuses
available
occupied_enabled
occupied_disabled
not_supported
Edit
Possible user types
unrestricted_user
year_day_schedule_user
week_day_schedule_user
master_user
non_access_user
not_supported
Edit

gets sent if Door Lock Operating Event Notification command received

Edit
				
					{
    event = "door_lock_operating_event_notification_received",
    node_id = 2,
    endpoint_id = 1,
    cluster_name = "door_lock",
    command_id = 32,
    command_name = "OperatingEventNotification",
    event_source = "keypad",
    event_name = "lock",
    user_id = 1,
    pin_code = "1234"
}				
			
Edit
fields type description
event string type of an event
node_id int node ID
endpoint_id int endpoint ID
cluster_name string name of attribute cluster
command_id int command ID
command_name string name of command
event_source string event source
event_name string event name
user_id int user ID
pin_code string pin code
Edit
Possible event sources
keypad
rf
manual_or_reserved
rfid
indeterminate
Edit
Possible event names
unknown_or_mfg_specific
lock
unlock
lock_failure_invalid_pin_or_id
lock_failure_invalid_schedule
unlock_failure_invalid_pin_or_id
unlock_failure_invalid_schedule
one_touch_lock
key_lock
key_unlock
auto_lock
schedule_lock
schedule_unlock
manual_lock
manual_unlock
non_access_user_operational_event
Edit

gets sent if Door Lock Programming Event Notification command received

Edit
				
					{
    event = "door_lock_programming_event_notification_received",
    node_id = 2,
    endpoint_id = 1,
    cluster_name = "door_lock",
    command_id = 33,
    command_name = "ProgrammingEventNotification",
    event_source = "keypad",
    event_name = "pin_code_added",
    user_id = 1,
    pin_code = "1234",
    user_status = "available",
    user_type = "unrestricted_user"
}				
			
Edit
fields type description
event string type of an event
node_id int node ID
endpoint_id int endpoint ID
cluster_name string name of attribute cluster
command_id int command ID
command_name string name of command
event_source string event source
event_name string event name
user_id int user ID
pin_code string pin code
user_status string user status
user_type string user type
Edit
Edit
Possible event sources
keypad
rf
manual_or_reserved
rfid
indeterminate
Edit
Possible event names
unknown_or_mfg_specific
master_code_changed
pin_code_added
pin_code_deleted
pin_code_changed
rfig_code_added
rfid_code_deleted
Edit
Possible user statuses
available
occupied_enabled
occupied_disabled
not_supported
Edit
Possible user types
unrestricted_user
year_day_schedule_user
week_day_schedule_user
master_user
non_access_user
not_supported
Edit

gets sent if a pcp value has been changed

				
					{
    "event": "module_reset",
    "status": "invoked"
}				
			
fields type description
event string type of an event
status string actual event status
Edit

gets sent if a Zigbee device reachable state has been changed

				
					{
    event = "reachable_state_updated",
    node_id = 2,
    value = true
}				
			
fields type description
event string type of an event
node_id int a unique id of a Zigbee device within a Zigbee network
value bool if Zigbee device is reachable, otherwise