Events
An event is an action that occurs within an organization and its resources. A door being unlocked, access being shared to a user, a scheduled unlock starting, a door forced open and other actions will be recorded as events.
Event types
The following table shows Kisi resources and all the events that you may encounter when interacting with them.
Camera
- Destroy
- Import
- Update
Card
- Activate
- Activate with token
- Assign
- Assign user
- Deactivate
- Deactivate with token
- Deassign
- Deassign with user
Door
- Cancel lockdown
- Closed
- Create
- Destroy
- Forced open
- Held open
- Lockdown
- Locked
- Opened
- Other unlocks
- Scheduled unlocks ended
- Scheduled unlocks started
- Unlock (by a user)
- Update
Elevator
- Create
- Destroy
- Permit
- Permitted
Event Export
- Create
- Download
- Finished
Gateway
- Update
Group
- Create
- Destroy
- Update
Integration
- Create
- Destroy
- Update
- Disabled due to error rate
- Elevated error rate
- Update
Login
- Create
- Destroy
- Sign in
- Sign out
Member
- Assign backup card
- Assign card
- Create
- Deassign backup card
- Destroy
- Disable backup card
- Disable card
- Enable backup card
- Enable card
- Update
Subscription
- Cancel
- Update
User
- Create
- Create backup code
- Activate 2-factor authentication
- Deactivate 2-factor authentication
- Destroy
- Update
For a more comprehensive list of event types, refer to our API documentation.
Forced open vs Held open
Forced open and Held open are door-related event types in Kisi, triggered by contact sensors.
A Forced open event is created when Kisi doesn't detect any unlock, but the contact sensor reports the door being open.
A Held open event is created when Kisi detects an unlock, but the contact sensor reports the door being open longer than the duration set by the organization admin.
To configure how long the contact sensor should wait after an Unlock event before triggering a Held open event, read Configure contact sensors.
Event logs
The recorded event is called an event log. Event logs store the user responsible for the event, the event type (e.g. lock.unlock), and the date and time of it.
Event logs can be viewed in real time in the Kisi web and mobile apps, or they can be exported as event reports. An exported event report is a CSV file containing all events for a defined time period. This report can be filtered to search for a user's email address, the time of access, access groups, or specific access points. This gives admins an audit trail with a highly granular level of detail to allow for tracing security-related events back to their source.
You can use events to trigger alerts by setting up alert policies. Through integrations, events can also be forwarded to external 3rd party services.
Kisi event retention
Kisi retains events indefinitely. Event retention settings will be supported in the near future.