alarmgroup:armed

The alarmgroup:armed event is emitted when an alarm group is set to armed, overriding its schedule.

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

Read more about alarm groups.

Resets the alarmgroup:disarmed and alarmgroup:schedule events.

Event specific attributes

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

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)

Peripheral origin

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

• Peripheral ID (name: peripheralId, type: string)
• Peripheral name (name: peripheralName, type: string)

Central station origin

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

• Central station ID (name: centralStationId, type: string)
• Central station name (name: centralStationName, type: string)

Payload example for user origin

{
    "eventTopic": "alarmgroup",
    "eventCode": "armed",
    "eventDescription": "Alarm group armed",
    "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"
        }
    }
}

Payload example for peripheral origin

{
    "eventTopic": "alarmgroup",
    "eventCode": "armed",
    "eventDescription": "Alarm group armed",
    "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": "peripheral",
        "originData": {
            "peripheralId": "cbd9e89a-b97b-11f0-a01a-e337b5563b4d",
            "peripheralName": "ALARM-PANEL"
        }
    }
}

Payload example for central station origin

{
    "eventTopic": "alarmgroup",
    "eventCode": "armed",
    "eventDescription": "Alarm group armed",
    "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": "centralstation",
        "originData": {
            "centralStationId": "94794ea0-7c2a-11f1-a49e-2800af38c3a9",
            "centralStationName": "monitoring-alarm-company-1"
        }
    }
}