barrier:control_unlocked

The barrier:control_unlocked event is emitted when a platform user has clicked the Unlock button in the applications.

Event specific attributes

• Origin code (name: originCode, type: string:enum, values: user)
• Origin data (name: originData, type: object)

For now, origin code will only be user, but that may change in the future when other origins, such as action and centralstation may exist.

The schema of origin data depends on the origin code.

User origin

When the origin code is user, the following origin data will have the following attributes:

• User ID (name: userId, type: string)
• User name (name: userName, type: string)
• User email (name: userEmail, type: string)

Example for user origin

{
    "eventTopic": "barrier",
    "eventCode": "control_unlocked",
    "eventDescription": "Barrier unlocked via control",
    "eventOccurred": "2023-09-07T10:18:41+02:00",
    "eventId": "1ee4d572-7b62-6136-86c8-35b55032bfe2",
    "eventData": {
        "barrierId": "6630e036-ee13-11ef-bc15-b33a54d715fa",
        "barrierName": "The barrier name",
        "barrierDescription": "The barrier description",
        "deviceId": "0eeb5774-e88d-11ef-95f8-afbaa9403ab9",
        "deviceName": "The controller name",
        "deviceDescription": "The controller description",
        "siteId": "182140d9-d99c-4dc8-ae14-0071a01d7e98",
        "siteName": "The site name",
        "siteDescription": "The site description",
        "groupId": "cf84e116-ee61-4bd8-b078-3d2fadfcc9ac",
        "groupName": "The alarm group name",
        "groupDescription": "The alarm group description",
        "groupActive": true,
        "groupState": "schedule",
        "originCode": "user",
        "originData": {
            "userId": "1ed40bf2-f3ac-6e95-bd58-513ccd4eb85b",
            "userName": "Name of the user that clicked",
            "userEmail": "john.doe@acme.org"
        }
    }
}