Access Events Webhooks

Notification Webhook Objects that are access control related will have the Access Control Events Webhook Object as their data attribute. All events that you would see in the Access Control reports section on Command will flow through this webhook as well. Below we have outlined all relevant objects that are nested in the Access Control Webhook data payload.

Access Control Notification Object

AttributeTypeDescription
webhook_typeString"notification"
webhook_idStringVerkada defined Id for notification webhook
org_idStringOrganization Id from which webhook is created.
created_atIntegerTime at which webhook was created. Measured in seconds since the Unix epoch.
dataMain Access Webhook ObjectSee Below.

Main Access Webhook Object

AttributeTypeDescription
device_idStringThe Verkada ID of the access control object associated with the event.
created_atINTThe Epoch timestamp of the event.
notification_typeStringThe type of Access Control Event.
input_valueStringThe Input value associated with the relevant event.
door_idStringThe ID of the device that triggered the access event.
aux_infoObjectThe information about the AUX device that caused this access event, if one was present.
user_infoObjectThe information about the user associated with this access event, if one was present.
lockdown_infoObjectThe information about the lockdown triggered on this access event, if one was triggered.
door_infoObjectThe information about the door associated with the access event.

Aux Information Object

AttributeTypeDescription
aux_input_idStringThe ID of the AUX that triggered the event.
aux_input_nameStringThe name of the AUX that triggered the event.
siteSite ObjectInformation about the site the AUX device that triggered the event is in.

User Information Object

AttributeTypeDescription
user_idStringThe ID of the user that triggered the event.
nameStringThe name of the user that triggered the event.
emailStringThe email of the user that triggered the event.
first_nameStringThe first name of the user that triggered the event.
last_nameStringThe last name of the user that triggered the event.
phoneStringThe phone number of the user that triggered the event.

Lockdown Information Object

AttributeTypeDescription
lockdown_idStringThe ID number of the lockdown associated with the event.
lockdown_nameStringThe name of the lockdown associated with the event.
messageStringThe message of the lockdown associated with the event.
actionStringThe action on the lockdown associated with the event.
enabledStringBoolean indicating whether the lockdown has been enabled.
siteSite ObjectInformation about the site where the lockdown occurred.

Door Information Object

AttributeTypeDescription
acu_nameStringThe name of the ACU to which the door is attached.
acu_idStringThe ID of the ACU to which the door is attached.
nameStringThe name of the door.
siteSite ObjectInformation about the site the door is in.

Site Object

AttributeTypeDescription
nameStringThe name of the site.
site_idStringThe ID of the site.

Example Payloads

Key Card Rejected Event

{
  "org_id": "a74fc6a6-4fc5-4e5c-88e5-57301683327a",
  "webhook_type": "notification",
  "created_at": 1692131003,
  "webhook_id": "457eb610-03b4-4fa0-a8c7-c06f3142df50",
  "data": {
    "device_id": "dd47e8e4-dc18-47d9-8249-4607eaa884dd",
    "created": 1692131000,
    "notification_type": "door_keycard_entered_rejected",
    "device_type": "access_control",
    "door_id": "dd47e8e4-dc18-47d9-8249-4607eaa884dd",
    "input_value": "151|39924",
    "aux_info": null,
    "user_info": null,
    "lockdown_info": null,
    "door_info": null
  }
}

Door Remote Unlock Accepted Event

{
  "org_id": "a74fc6a6-4fc5-4e5c-88e5-57301683327a",
  "webhook_type": "notification",
  "created_at": 1692235651,
  "webhook_id": "60a168de-df82-40bb-b31e-a7fd7c49d79d",
  "data": {
    "device_id": "a1faa47c-330a-45aa-8fe6-cacb293400c2",
    "created": 1692235647,
    "notification_type": "door_remote_unlock_accepted",
    "device_type": "access_control",
    "door_id": "a1faa47c-330a-45aa-8fe6-cacb293400c2",
    "input_value": null,
    "aux_info": null,
    "user_info": {
      "user_id": "47c39a50-3575-40ee-bfe9-46e0fa8447db",
      "name": "John Smith",
      "email": "[email protected]",
      "first_name": "John",
      "last_name": "Smith",
      "phone": "+1234567890"
    },
    "lockdown_info": null,
    "door_info": {
      "acu_name": "Lobby Door Controller",
      "acu_id": "8adf16e0-a52a-45d1-8b68-efc5d6fb64ba",
      "name": "Front Door"
    }
  }
}