API Documentation
API Documents
HomeHelp CenterCommand

Access Events Guide

Overview

The Events API for Access Control allows customers to retrieve specific Verkada access events within a set time range or receive real-time event data through Verkada Webhooks.

This API is great for analyzing your Verkada access control event data with third-party applications.

API Endpoints

  • Get Access Events - Retrieves specified access events within a designated time range

Verkada Webhooks

If you would like to receive all Verkada access events in real time, you can subscribe to Verkada's event data using a webhook. For more information about Verkada Webhooks refer to the Verkada Webhooks section in this guide and the Access Events Webhooks object definitions.

Using the Access Events API

Getting Started

Refer to the Quick Start Guide for instructions on generating a Verkada API key and making your first API requests.

Example Use Case

Employee Time Tracking through Third Party Application

Use the Access Events API to track how long your employees are in the office. This is particularly useful for companies with in-office policies that need to ensure employees are spending a significant portion of the day on-site.

Example integration steps for this use case:

  • Step 1 - Retrieve all scan events : Call the Get Access Events API endpoint for a given day, specifying that you only want door_mobile_nfc_scan_accepted, door_keycard_entered_accepted, and door_ble_unlock_attempt_accepted events. These are the events that require the user to be present at a door they are allowed access to.
  • Step 2 - Sort these scan events: Sort the events from the previous step into buckets based on userId, userName, or email, so that you can easily see which events are associated with which user.
  • Step 3 - Find first and last scan for each user: For the events associated with each of the users, find the minimum and maximum scan time in order to determine when they first arrived at the office and last left the office. You can then calculate the difference to determine the total amount of time an employee was in the office on a given day.