|  Developer
Updated on November 29, 2022


  • Broadcast sent when some changes happened to an item (broadcast contains only changes).
Field Type Required Description
_id string + an id of the item
deviceId string + related device._id
deviceName string + related device.name
deviceCategory string + a device category
deviceSubcategory string + a device subcategory
parentDeviceId string If related device have a parent, this field will have it’s id
roomName string + a room name
userNotification bool + Special flag for Cloud for converting this broadcast to User Notification
notifications JsonArray + List of user ids for sending broadcast notification to users( null – all users / – no one )
name string + see item.name(type)
deviceArmed bool related device.armed state
serviceNotification bool + Special mark from related device
syncNotification bool + Special mark to request data synchronization between Cloud and controller (true only if name of item was changed)
fwTimestampMs int64 + A hub system timestamp in milliseconds when the event has happened.
elementsMaxNumber int Max allowed elements of a dictionary value
stringRestriction string Regexp restriction for a value in item of value type
userCodeRestriction string Regexp restriction for a field in any value of value type. E.g. it’s used in item .
userCodeModes JsonArray List of available pin code modes. It’s used in item.
protectNotification bool Whether this broadcast should be treated by Cloud as a protect notification (Ezlo Protect)
protectService string A Ezlo Protect service associated with the device. Will appear only if the Ezlo Protect service is on, the device is an armed panic button, and an item is a . One of: , , .

Item fields which may be updated (__ITEM_CHANGEABLE_FIELD):

Field Type Description
show bool whether to show the item (on the UI) or not
valueFormatted string an item value formatted
value object an item value
minValue number lower limit of item’s value field
maxValue number upper limit of item’s value field
valueIndent JsonObject Defining minimal value indent between different items
valueIndent.item string Item id of another item
valueIndent.minIndent float Minimal indent between current item and another item
          "id": "ui_broadcast",
          "msg_subclass": "hub.item.updated",
          "result": {
            "_id": "588b7eb528b12d03be86f36f",
            "deviceId": "<DEVICE_ID>",
            "deviceName": "<DEVICE_NAME>",
            "deviceCategory" : "<DEVICE_CATEGORY>",
            "deviceSubcategory" : "<DEVICE_SUBCATEGORY>",
            "roomName" : "<DEVICE_ROOM_NAME>",
            "userNotification": false,
            "parentDeviceId": "<OPTIONAL_PARENT_DEVICE_ID>",
            "fwTimestampMs": 16300011122244,
            "notifications": [ "12314324", "978343" ],
            "deviceArmed": false,
            "name": "alarm_water",
            "elementsMaxNumber": 2,
            "userCodeRestriction": "\d{4}",