alarmgroup:schedule

The alarmgroup:schedule event is emitted when an alarm group is set to follow its schedule.

This operation is performed by a user, via either web- or mobile applications.

Read more about alarm groups.

Resets the alarmgroup:armed and alarmgroup:disarmed events.

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 centralstation may exist.

The schema of origin data depends on the origin code.

User origin

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

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

Payload example for user origin

{
    "eventTopic": "alarmgroup",
    "eventCode": "schedule",
    "eventDescription": "Alarm group set to follow schedule",
    "eventOccurred": "2023-09-07T10:18:41+02:00",
    "eventId": "1ee4d572-7b62-6136-86c8-35b55032bfe2",
    "eventData": {
        "groupId": "cf84e116-ee61-4bd8-b078-3d2fadfcc9ac",
        "groupName": "F1",
        "groupDescription": "Floor 1",
        "siteId": "182140d9-d99c-4dc8-ae14-0071a01d7e98",
        "siteName": "HQ",
        "siteDescription": "Company headquarters in NYC",
    },
    "originCode": "user",
    "originData": {
        "userId": "1ed40bf2-f3ac-6e95-bd58-513ccd4eb85b",
        "userName": "Name of the user that clicked",
        "userEmail": "john.doe@acme.org"
    }
}