Verkada API Overview
The Verkada API is a RESTful API built to expose insights captured by Verkada cameras. It allows customers to programmatically access and consume data in a simple, secure, and scalable manner, removing barriers to enterprise automation and increasing productivity. The Verkada API returns JSON-encoded responses and uses standard HTTP response codes. Each request requires an API key and organization ID that are unique to an organization in Command.
API Documentation
Comprehensive documentation on the Verkada API is available at https://apidocs.verkada.com/
Enabling API
Verkada API can be enabled by navigating to Admin > Org Settings > Verkada API. From this page, you can select "Enable API".
Accessing the API Settings
Once enabled only users with Organization Admin privileges can access the Verkada API setting in Command. Navigate to Admin > Org Settings > Verkada API. This screen will display your Organization ID and allow you to generate an API Key. Both the Organization ID and API Key are required when making an API request to Verakda Command.
Webhooks Overview
Verkada webhooks are a powerful way to programmatically access notifications from Verkada Command in real-time. These notifications are exposed with a JSON formatted message and are sent to a user-specified URL where they can be processed or stored. Verkada webhooks can be used to monitor your physical space for critical events around the clock. They can also be used to integrate the resulting notifications with other systems for enhanced automation and reporting.
Enabling Webhooks
Once the Verkada API is enabled, Webhooks can be enabled within the API settings. Click Enable and then provide your Webhook URL as well as a Shared Secret and click save. Once enabled Verkada Command will send all alerts to your Webhook URL endpoint as described in the API documentation.
