Manage Scenarios via API
Manage Verkada scenarios with third-party platforms
Scenarios can be managed programmatically through the Verkada API, including listing available scenarios, activating one, or releasing an active one. Emergency scenarios are pre-configured emergency responses that admins can activate to lock and unlock doors and notify the right people when something happens, organized into five types: Lockdown, Hold, Secure, Evacuate, and Shelter.
Command configuration
Organization level
In Verkada Command, go to All Products > Access.
On the left navigation, click Access Settings.
Toggle on Enable Lockdown and Scenario Control via API.
Generate API key
In Verkada Command, go to All Products > Admin.
Under Org Settings, click API & Integrations.
From the API & Integration settings, select API Keys > Add.
a. Select New Key and click Next. b. Enter a unique name. c. Under Endpoints, select Access Control. d. Set the permissions to Read/Write. e. Set the expiration date. f. Click Generate API.
Available API actions
Once you configure Command to allow API control of scenarios, you can perform the following actions:
List Scenarios: Retrieve all configured scenarios across your organization.
Activate a Scenario: Trigger a scenario programmatically in response to an event or condition.
Release a Scenario: End or deactivate an active scenario.
See Verkada API Docs for more details on specific Access Control API endpoints.
Activate and release a scenario via API
When a scenario, such as a lockdown, is activated or released through the API, it behaves the same as if it were activated manually in Command.
Using the API to activate or release a scenario will:
Execute all configured scenario actions, such as locking doors, unlocking doors, triggering alerts, or activating AUX outputs.
Update the scenario’s status in both the Command interface and the Verkada Pass app.
Generate event logs for each action, visible in the Events report and the Command audit log.
Last updated
Was this helpful?