The information sent to webhook URLs when an alarm site changes state
An alarm webhook object contains the following fields:
Attribute | Type | Description |
---|---|---|
webhook_type | String | alarm_site_state_change |
webhook_id | String | Verkada defined Id for notification webhook |
org_id | String | Organization Id from which webhook is created. |
created_at | Integer | Time at which webhook was created. Measured in seconds since the Unix epoch. |
data | Object | The data associated with the notification. See below |
The data
object contains these fields:
Attribute | Type | Description |
---|---|---|
event_type | String | What kind of event occurred. One of:armed , disarmed , alarm , silent_alarm , resolved . |
site_id | String | The unique identifier of the alarm site that the event occurred in. |
site_name | String | The name of the site that has changed state |
site_state | String | What state the alarm site is now in. One of: armed , disarmed , alarm , silent_alarm . |
site_security_level | String | The security level rules that the site is set to |
timestamp | Integer | Time at which event occurred. Measured in seconds since the Unix epoch. |
Sample object:
{
"org_id": "a96fec42-edee-4bb4-8457-a89b90d3d258",
"webhook_type": "alarm_site_state_changed",
"created_at": 1685129790,
"webhook_id": "aa01db73-34ac-4b29-a50a-e2b52191825c",
"data": {
"event_type": "resolved",
"timestamp": 1685129786,
"site_id": "f53e3b84-e534-4de5-821c-5263d96d3623",
"site_state": "disarmed",
"site_name": "Office 1st Floor",
"site_security_level": "custom"
}
}
When the event_type
is alarm
or silent_alarm
, additional fields are added:
Attribute | Type | Description |
---|---|---|
device_name | String | The name of the device that tripped the alarm whenevent_type is alarm or silent_alarm |
device_id | String | The unique identifier of the device that tripped the alarm when event_type is alarm or silent_alarm |
device_event_type | String | The type of event type that occurred on the device that triggered the alarm. One of: glass_break , pressed , wet , opened , motion , smoke , wet , trigger , tamper . |
Sample alarm event object:
{
"org_id": "c926e7d6-be46-4ae8-9e24-11ad5a52fb42",
"webhook_type": "alarm_site_state_changed",
"created_at": 1685129775,
"webhook_id": "7c03289b-c80e-4766-ab58-e82c157c5990",
"data": {
"event_type": "alarm",
"timestamp": 1685129774,
"site_id": "f53e3b84-e534-4de5-821c-5263d96d3623",
"site_state": "alarm",
"site_name": "Office 1st Floor",
"site_security_level": "custom",
"device_name": "Reception Panic Button",
"device_id": "013ac542-3152-4477-9f85-f28007c9227e",
"device_event_type": "pressed"
}
}