Adapter - KISI

This page describes version 2.0.2 of the adapter.

Overview

This adapter interfaces with the KISI Access Control API and is limited to unlocking doors and creating web access links.

Configuration

Use the following steps to create an API Key:

1. Using a web browser, Sign in to the Kisi web UI for your organization. https://web.kisi.io/
2. On the top right corner, click on your name and then My Account
3. Next, select the API tab and click on Add API key
4. Enter your name, your Kisi password, and your verification code and click Add
5. Copy the API key shown on the screen and click Close
6. Paste the API key into the adapter's API Key property and click save.

Webhook Event Processing

The Kisi Access Control System uses an event webhook to post events to UIP. For on-premise UIP systems, the UIP must be in the DMZ or have port forwarding configured.

Webhook post events sent from Kisi should be processed by the adapter's Process Webhook command to filter out duplicate events. The adapter command will also create new event triggers that can be consumed by another workflow (i.e. door unlock/lock events). Use the following steps to create a workflow and webhook listener to process the events:

1. Create a Workflow that implements the Process Webhook command. Set the Kisi Event property to "{kisiEvent}".
2. Create an Advanced Webhook that points to the Workflow in step 1 above. Set both the Authentication Type and Response Type properties to None. Add a property called "kisiEvent" and set its value to "{wfsystem.body}" and save.
3. Create an event trigger that can be used to monitor for example, door unlocks attempts.

Unlock Command Usage

The unlock command requires an authorization token to unlock a door for a user. User authorization tokens are created for a user using the "Create Login" command. The "Create Login" command takes the user's email address associated with a Kisi account and returns an authorization token. The created authorization token must be re-used each time a door is unlocked for the user. Creating a new authorization token for each unlock process is NOT recommend by Kisi. It is recommended to create a workflow that uses Mapping Data to track the created tokens for each user. When using mapping data, the authorization token should be validated before attempting to unlock a door. The "Validate Login" command can be used to validate an authorization token before unlocking a door.

The following workflow diagram shows an example of how an authorization token can be re-used to unlock a door:

Kisi API Rate Limitations

The Kisi API enforces limits on the number of request that can be made per second. If the request rate limit is exceeded an error will be returned by the API with the code 429. In some cases it may be necessary to create multiple UIP Kisi adapter instances connecting as different users to accommodate the rate limitation.

For more information about these limits refer to the Kisi API documentation website at https://api.kisi.io/docs#/#rate-limits.



Properties

Name	Display	Is Required	Comments	Type	Default Value	Maximum Value	Minimum Value	Maximum Length	Minimum Length
kisiurl	Kisi API URL	True	The base URL for the Kisi API service (e.g. 'https://api.kisi.io')	string	https://api.kisi.io			1024	1
apikey	API Key	True	The API key is a token necessary for making API calls.	password				1024	1



Commands

Create Group Access Link (createGroupAccessLink)

Creates Group Access Link.

Request Properties

Name	Display	Description	Is Required	Type
name	Recipient's Name	The recipient's name that will use the access link.	True	string
group_id	Group ID or Name	The group id or group name of the access link.	True	string
email	Email Address	The email address to the person who should have access.	True	string
valid_from	Valid From	When the group access link starts to be valid (UTC). Format: 'YYYY-MM-DDTHH:mm:00Z'	False	string
valid_until	Valid Until	When the group access link stops to be valid (UTC). Format: 'YYYY-MM-DDTHH:mm:00Z'	False	string

Response Properties

Name	Description	Type
apiErrorCode	The API Error Code returned from the service.	string
apiErrorMessage	The API Error Message returned from the service.	string
accessLink	Array of access links.	array
accessLink.id	The access link identifier or ID.	string
accessLink.name	The access link name.	string
accessLink.email	The email to the person who should have access.	string
accessLink.valid_from	When the access link starts to be valid. (UTC)	string
accessLink.valid_until	When the access link stops to be valid. (UTC)	string
accessLink.created_at	When the access link was created. (UTC)	string
accessLink.updated_at	When the access link was last updated. (UTC)	string
accessLink.group_id	The group ID of this access link.	string
accessLink.issued_by_id	The Issued-By ID of the access link.	string
accessLink.issued_by.id	The User ID of the user that issued the access link.	string
accessLink.issued_by.name	The User Name of the user that issued the access link.	string
accessLink.issued_by.email	The User Email of the user that issued the access link.	string
accessLink.secret	The secret value used for authentication	string

Create Login (createLogin)

Creates a new login for a user that is used to unlock a door.

Request Properties

Name	Display	Description	Is Required	Type
email	Email Address	The email address of the person that the login is being created for.	True	string

Response Properties

Name	Description	Type
token	The authorization token to use for unlocking a door.	string
apiErrorCode	The API Error Code returned from the service.	string
apiErrorMessage	The API Error Message returned from the service.	string

Delete Group Access Link (deleteGroupAccessLink)

Delete Group Access Link.

Request Properties

Name	Display	Description	Is Required	Type
link_id	Access Link ID	The group access link Id to delete.	True	string

Response Properties

Name	Description	Type
apiErrorCode	The API Error Code returned from the service.	string
apiErrorMessage	The API Error Message returned from the service.	string

Fetch Group Access Links (fetchGroupAccessLinks)

Returns Group Access Links. If no filters are set, all group access links are returned.

Request Properties

Name	Display	Description	Is Required	Type
group_id	Group ID	Filter by group ID.	False	string
ids	Link IDs	Filter by access link IDs. Parameter must be comma delimited if more than one ID.	False	string
query	Query	Filter by the name, email or group name. Also, filters on issued_by's email.	False	string

Response Properties

Name	Description	Type
apiErrorCode	The API Error Code returned from the service.	string
apiErrorMessage	The API Error Message returned from the service.	string
accessLink	Array of access links.	array
accessLink.id	The access link identifier or ID.	string
accessLink.name	The access link name.	string
accessLink.email	The email to the person who should have access.	string
accessLink.valid_from	When the access link starts to be valid. (UTC)	string
accessLink.valid_until	When the access link stops to be valid. (UTC)	string
accessLink.created_at	When the access link was created. (UTC)	string
accessLink.updated_at	When the access link was last updated. (UTC)	string
accessLink.group_id	The group ID of this access link.	string
accessLink.issued_by_id	The Issued-By ID of the access link.	string
accessLink.issued_by.id	The User ID of the user that issued the access link.	string
accessLink.issued_by.name	The User Name of the user that issued the access link.	string
accessLink.issued_by.email	The User Email of the user that issued the access link.	string

Fetch Groups (fetchGroups)

Returns group information. If no filters are set, all groups are returned.

Request Properties

Name	Display	Description	Is Required	Type
elevator_stop_id	Elevator Stop ID	Filter by elevator stop ID	False	string
ids	Group IDs Filter	Filter by Group IDs. Parameter must be comma delimited if more than one ID.	False	string
lock_id	Lock ID	Filter by Lock/Door ID	False	string
place_id	Place ID	Filter by Place ID	False	string
query	Query	Filter by a free text string. Properties searched: Group Name	False	string
scope	Scope	Filter by Scope. Allowed values: organization, place	False	string

Response Properties

Name	Description	Type
apiErrorCode	The API Error Code returned from the service.	string
apiErrorMessage	The API Error Message returned from the service.	string
group	Array of Groups.	array
group.id	The group identifier or ID.	string
group.name	The group name.	string
group.description	The description of the group.	string
group.created_at	When the group was created. (UTC)	string
group.updated_at	When the group was last updated. (UTC)	string
group.geofence_restriction_enabled	Whether geofence restriction is enabled	string
group.geofence_restriction_radius	The geofence restriction radius.	string
group.primary_device_restriction_enabled	Whether primary device restriction is enabled	string
group.reader_restriction_enabled	Whether reader restriction is enabled	string
group.time_restriction_enabled	Whether time restriction is enabled	string
group.login_enabled	Whether application access is enabled	string
group.members_count	The number of members in the group.	string
group.locks_count	The number of locks/doors in the group.	string
group.elevator_stops_count	The number of elevator stops in the group.	string
group.place_id	The place id of the group.	string
group.place.id	The place id of the group.	string
group.place.name	The place name of the group.	string

Fetch Locks (fetchLocks)

Returns lock information. If no filters are configured, all locks are returned.

Request Properties

Name	Display	Description	Is Required	Type
query	Query	Filter by a free text string. Properties searched: Lock Name	False	string
ids	Lock IDs Filter	Filter by Lock IDs. Parameter must be comma delimited if more than one ID.	False	string
locked_down	Locked Down	Filter by locked down locks. If not set both locked down and non-locked down locks are returned.	False	string
online	Online	Filter by online locks. If not set both online and offline locks are returned.	False	string
unlocked	Unlocked	Filter by unlocked locks. If not set both locked and unlocked locks are returned.	False	string
configured	Configured	Filter by configured locks. If not set both configured and not configured locks are returned.	False	string

Response Properties

Name	Description	Type
apiErrorCode	The API Error Code returned from the service.	string
apiErrorMessage	The API Error Message returned from the service.	string
lock	Array of Locks.	array
lock.id	The lock identifier or ID.	string
lock.name	The lock name.	string
lock.description	The description of the lock.	string
lock.created_at	When the lock was created. (UTC)	string
lock.updated_at	When the lock was last updated. (UTC)	string
lock.latitue	The latitude of the lock.	string
lock.longitude	The longitude of the lock.	string
lock.configured	Whether or not the lock has been configured.	string
lock.online	Whether or not the lock is online.	string
lock.unlocked	Whether or not the lock unlocked.	string
lock.unlocked_until	The time and date the lock will be unlocked.	string
lock.locked_down	Whether or not the lock is locked down. When locked down the lock is locked for everyone.	string
lock.locked_down_since	The time and date the lock was locked down.	string
lock.open	Whether the lock is open or not.	string
lock.geofence_restriction_enabled	Whether the lock is geofence restricted. Geofence restriction enforces that users may only unlock when they are near the lock.	string
lock.geofence_restriction_radius	The radius of the geofence restriction.	string
lock.reader_restriction_enabled	Whether reader restriction is enabled. Reader restriction enforces that users may only unlock when standing in front of the door.	string
lock.time_restriction_enabled	Whether the lock is time restricted. Time restriction enforces that users may only unlock at specific hours.	string
lock.time_restriction_time_zone	What time zone the time restriction applies to.	string
lock.groups_count	The number of groups this lock is associated to.	string
lock.place.id	The ID of the place	string
lock.place.name	The name of the place	string
lock.place.latitude	The latitude of the place	string
lock.place.longitude	The longitude of the place	string
lock.floor_id	The floor ID of the lock.	string
lock.integration_id	The integration ID of the lock. Only used by integration-based locks. The only integration that is currently supported is Smartalock. When this field is set, all unlocks will go through the integration.	string

Fetch Members (fetchMembers)

Returns member information. If no filters are set, all members are returned.

Request Properties

Name	Display	Description	Is Required	Type
ids	Member IDs Filter	Filter by Member IDs. Parameter must be comma delimited if more than one ID.	False	string
query	Query	Filter by a free text string. Properties searched: Group Name	False	string
confirmed	Confirmed	Filter by Confirmed members	False	string

Response Properties

Name	Description	Type
apiErrorCode	The API Error Code returned from the service.	string
apiErrorMessage	The API Error Message returned from the service.	string
member	Array of Members.	array
member.id	The member identifier or ID.	string
member.name	The member name.	string
member.image	The URL to the profile picture of the member.	string
member.confirmed	Whether the member has confirmed their account.	string
member.card_assigned	Whether the member has a card assigned.	string
member.card_assigned_at	When the card was assigned.	string
member.backup_card_assigned	Whether the member has a backup card assigned.	string
member.backup_card_assigned_at	When the backup card was assigned.	string
member.login_last_used_at	When the login was last used.	string
member.password_flow_enabled	Whether the member can login with password flow. Only relevant for organizations.	string
member.cards_count	The number of cards assigned to a member.	string
member.shares_count	Count of shares assigned to member.	string
member.card_activation_required	Whether the member needs to activate the card to gain access.	string
member.access_enabled	Whether the member is allowed to access locks and elevators. If the user is managed by SCIM, user access will be disabled unless both the access_enabled field and scim_access_enabled fields are set to true.	string
member.scim_access_enabled	Whether the member is allowed to access locks and elevators. This field is read-only and can only be managed using SCIM. (See access_enabled)	string
member.last_access_at	When the user last accessed a door.	string
member.created_at	When the member was created.	string
member.updated_at	When the member was last updated.	string
member.role_id	The role id of the member.	string
member.notes	The notes of the member.	string
member.organization_id	The organization id of the member.	string
member.user_id	The user id of the member	string
member.user.id	The user id of the member.	string
member.user.name	The user name of the member.	string
member.user.email	The user email of the member.	string
member.user.otp_required_for_login	Whether OTP/2FA is required for login.	string
member.card_assigned_by_id	The card_assigned_by ID of the member.	string
member.card_assigned_by.id	The ID of the user.	string
member.card_assigned_by.name	The name of the user.	string
member.card_assigned_by.email	The email of the user.	string
member.card_id	The card ID of the member.	string
member.card.id	The ID of the card.	string
member.card.created_at	When the card was created.	string
member.card.updated_at	When the card was last updated.	string
member.card.type	The type of card. (mifare_desfire_ev1, legacy)	string
member.card.token	The token of the card. Only returned for assigned cards, cards in an organization, or cards looked up by UID or token.	string
member.card.third_party	Whether the card is manufactured by a third party, and not by Kisi.	string
member.card.assigned	Whether the card was assigned.	string
member.card.assigned_at	When the card was assigned.	string
member.card.activated	Whether the card is activated.	string
member.card.last_used_at	When the card was last used.	string
member.card.activated_at	When the card activated.	string
member.card.deactivated_at	When the card deactivated.	string
member.backup_card_assigned_by_id	The backup_card_assigned_by ID of the member.	string
member.backup_card_assigned_by.id	The ID of the user.	string
member.backup_card_assigned_by.name	The name of the user.	string
member.backup_card_assigned_by.email	The email of the user.	string
member.backup_card_id	The backup card ID of the member.	string
member.backup_card.id	The ID of the card.	string
member.backup_card.created_at	When the backup card was created.	string
member.backup_card.updated_at	When the backup card was updated.	string
member.backup_card.type	The type of backup card.	string
member.backup_card.token	The token of the card. Only returned for assigned cards, cards in an organization, or cards looked up by UID or token.	string
member.backup_card.third_party	Whether the card is manufactured by a third party, and not by Kisi.	string
member.backup_card.assigned	Whether the card was assigned.	string
member.backup_card.assigned_at	When the card was assigned.	string
member.backup_card.activated	Whether the card is activated.	string
member.backup_card.last_used_at	When the card was last used.	string
member.backup_card.activated_at	When the card activated.	string
member.backup_card.deactivated_at	When the card deactivated.	string

Process Webhook (processWebhook)

Processes a custom webhook event from Kisi.

Request Properties

Name	Display	Description	Is Required	Type
kisiEvent	Kisi Event	The Kisi Event received as JSON.	True	string

Response Properties

Name	Description	Type
id	The ID of the event.	string
created_at	When the event was created	string
actor_type	The type of actor of the event. (User, GroupLink)	string
actor_id	The ID of the actor of the event.	string
actor_name	The name of the actor of the event	string
action	The action of the event.	string
authenticated_by_id	The ID of the authentication object.	string
authenticated_by_type	The type of the authentication object. (null, Login, Card, GroupLink)	string
object_type	The type of the object of the event.	string
object_id	The ID of the object of the event.	string
object_name	The name of the object of the event.	string
error_code	An error code, in case the action was not successful.	string
error_message	An error message, in case the action was not successful.	string
success	Whether the action was successful.	string
sequence	An identifier used to group related events that were created as part of the same action.	string
camera_snapshots	Whether the event has any camera snapshots.	string
references	An array of references related to the event.	array
references.id	The ID of the reference.	string
references.type	The type of the reference.	string
details	The details.	string
via	by way of	string
code	code (deprecated)	string
message	message (deprecated)	string

Unlock Door (unlock)

Unlocks a door for a user.

Request Properties

Name	Display	Description	Is Required	Type
token	User Authorization Token	The authorization token of the user that will be used to unlock the door. Refer to adapter documentation on generating tokens for users.	True	string
id	Lock ID or Name	The lock identifier or door lock name to unlock.	True	string
latitude	Latitude	Latitude of user's current location (based on the WGS 84 coordinate system). Used for Geo-fence restricted locks/groups.	False	string
longitude	Longitude	Longitude of user's current location (based on the WGS 84 coordinate system). Used for Geo-fence restricted locks/groups.	False	string
proximity_proof	Proximity Proof	Proximity proof to verify proximity to lock.	False	string

Response Properties

Name	Description	Type
apiErrorCode	The API Error Code returned from the service.	string
apiErrorMessage	The API Error Message returned from the service.	string
message	The result message	string

Update Door Lock (updateLock)

Updates a door lock

Request Properties

Name	Display	Description	Is Required	Type
description	Description	The description of the lock.	False	string
favorite	Favorite	Whether the lock is marked as a favorite by the user. Only shown if requested.	False	string
floor_id	Floor ID	The floor ID of the lock	False	string
geofence_restriction_enabled	Geofence Restriction Enable	Whether the lock is geofence restricted. Geofence restriction enforces that users may only unlock when they are near the lock.	False	boolean
id	Lock ID	The lock identifier	True	string
integration_id	Integration ID	The integration ID of the lock. Only used by integration-based locks. The only integration that is currently supported is Smartalock. When this field is set, all unlocks will go through the integration.	False	string
latitude	Latitude	The latitude of the door lock.	False	string
longitude	Longitude	The longitude of the door lock.	False	string
name	Door Lock Name	The name of the door lock.	True	string
order_id	Order ID	The position of the lock, determining the sort order of the locks.	False	string
reader_restriction_enabled	Reader Restriction Enable	Whether the lock is geofence restricted. Geofence restriction enforces that users may only unlock when they are near the lock.	False	boolean
time_restriction_enabled	Time Restriction Enable	Whether the lock is time restricted. Time restriction enforces that users may only unlock at specific hours.	False	boolean

Response Properties

Name	Description	Type
apiErrorCode	The API Error Code returned from the service.	string
apiErrorMessage	The API Error Message returned from the service.	string

Lockdown Door Set (lockdownDoorSet)

Puts the selected door in lockdown.

Request Properties

Name	Display	Description	Is Required	Type
id	Lock ID or Name	The lock identifier or door lock name to put in lockdown.	True	string

Response Properties

Name	Description	Type
apiErrorCode	The API Error Code returned from the service.	string
apiErrorMessage	The API Error Message returned from the service.	string

Lockdown Door Cancel (lockdownDoorCancel)

Cancels lockdown for the selected door.

Request Properties

Name	Display	Description	Is Required	Type
id	Lock ID or Name	The lock identifier or door lock name to take out of lockdown.	True	string

Response Properties

Name	Description	Type
apiErrorCode	The API Error Code returned from the service.	string
apiErrorMessage	The API Error Message returned from the service.	string

Lockdown Place Set (lockdownPlaceSet)

Puts the selected place in lockdown.

Request Properties

Name	Display	Description	Is Required	Type
id	Place ID or Name	The place identifier or place name to put in lockdown.	True	string

Response Properties

Name	Description	Type
apiErrorCode	The API Error Code returned from the service.	string
apiErrorMessage	The API Error Message returned from the service.	string

Lockdown Place Cancel (lockdownPlaceCancel)

Cancels lockdown for the selected place.

Request Properties

Name	Display	Description	Is Required	Type
id	Place ID or Name	The place identifier or place name to take out of lockdown.	True	string

Response Properties

Name	Description	Type
apiErrorCode	The API Error Code returned from the service.	string
apiErrorMessage	The API Error Message returned from the service.	string

Validate Login (validateLogin)

Validates that a login account for a user is valid.

Request Properties

Name	Display	Description	Is Required	Type
token	Authorization Token	The authorization token to validate	True	string

Response Properties

Name	Description	Type
isValid	Returns 'true' if the authorization token is valid for a user.	string

Fetch Places (fetchPlaces)

Returns organization place information. If no filters are set, all places are returned.

Request Properties

Name	Display	Description	Is Required	Type
ids	Place IDs Filter	Filter by Place IDs. Parameter must be comma delimited if more than one ID.	False	string
query	Query	Filter by a free text string. Properties searched: Place Name	False	string

Response Properties

Name	Description	Type
apiErrorCode	The API Error Code returned from the service.	string
apiErrorMessage	The API Error Message returned from the service.	string
place	Array of Places.	array
place.id	The place identifier or ID.	string
place.name	The place name.	string
place.description	The description of the place.	string
place.created_at	When the place was created. (UTC)	string
place.updated_at	When the place was last updated. (UTC)	string
place.latitude	The latitude of the place.	string
place.longitude	The longitude of the place.	string
place.address	The address of the place	string
place.color	The color of the place.	string
place.image	The URI to the image of the place. The image can be uploaded by first using the Signed upload URL endpoint to generate a signed URL and then using the URL to upload the image.	string
place.logo	The URI to the logo of the place.The logo can be uploaded by first using the Signed upload URL endpoint to generate a signed URL and then using the URL to upload the logo.	string
place.time_zone	The time zone of the place. It is converted to it's IANA equivalent if it's not a valid IANA time zone.	string
place.tz_time_zone	The time zone of the place.	string
place.locks_count	The number of locks/doors in the place.	string
place.members_count	The number of members in the place.	string
place.integrations_count	The number of integrations in the place.	string
place.locked_down	Whether the place is locked down. When locked down the place is locked down for everyone.	string
place.locked_down_since	Since when the place has been locked down.	string
place.occupancy_rate	What is the occupancy rate for an associated capacity record.	string
place.organization.id	The ID of the organization.	string
place.organization.name	The name of the organization.	string
place.organization.domain	The domain of the organization.	string

Events

Controller Input Closed (controller_input_closed)

A controller input closed event occurred.

Event Properties

Name	Display	Description	Type
id	Event ID	The ID of the event.	string
created_at	Created At	When the event was created	string
actor_type	Actor Type	The type of actor of the event. (User, GroupLink)	string
actor_id	Actor ID	The ID of the actor of the event.	string
actor_name	Actor Name	The name of the actor of the event	string
action	Action	The action of the event.	string
authenticated_by_id	Authenticated By ID	The ID of the authentication object.	string
authenticated_by_type	Authenticated By Type	The type of the authentication object. (null, Login, Card, GroupLink)	string
object_type	Object Type	The type of the object of the event.	string
object_id	Object ID	The ID of the object of the event.	string
object_name	Object Name	The name of the object of the event.	string
error_code	Error Code	An error code, in case the action was not successful.	string
error_message	Error Message	An error message, in case the action was not successful.	string
success	Event Success	Whether the action was successful.	string
sequence	Sequence	An identifier used to group related events that were created as part of the same action.	string
camera_snapshots	Camera Snapshots Available	Whether the event has any camera snapshots.	string
references	References	An array of references related to the event.	array
references.id	Reference ID	The ID of the reference.	string
references.type	Reference Type	The type of the reference.	string
details	Details	The details.	string
via	Via	by way of	string
code	Code	code (deprecated)	string
message	message	message (deprecated)	string

Controller Input Opened (controller_input_opened)

A controller input opened event occurred.

Event Properties

Name	Display	Description	Type
id	Event ID	The ID of the event.	string
created_at	Created At	When the event was created	string
actor_type	Actor Type	The type of actor of the event. (User, GroupLink)	string
actor_id	Actor ID	The ID of the actor of the event.	string
actor_name	Actor Name	The name of the actor of the event	string
action	Action	The action of the event.	string
authenticated_by_id	Authenticated By ID	The ID of the authentication object.	string
authenticated_by_type	Authenticated By Type	The type of the authentication object. (null, Login, Card, GroupLink)	string
object_type	Object Type	The type of the object of the event.	string
object_id	Object ID	The ID of the object of the event.	string
object_name	Object Name	The name of the object of the event.	string
error_code	Error Code	An error code, in case the action was not successful.	string
error_message	Error Message	An error message, in case the action was not successful.	string
success	Event Success	Whether the action was successful.	string
sequence	Sequence	An identifier used to group related events that were created as part of the same action.	string
camera_snapshots	Camera Snapshots Available	Whether the event has any camera snapshots.	string
references	References	An array of references related to the event.	array
references.id	Reference ID	The ID of the reference.	string
references.type	Reference Type	The type of the reference.	string
details	Details	The details.	string
via	Via	by way of	string
code	Code	code (deprecated)	string
message	message	message (deprecated)	string

Controller Input Tamper (controller_input_tamper)

A controller input tamper event occurred.

Event Properties

Name	Display	Description	Type
id	Event ID	The ID of the event.	string
created_at	Created At	When the event was created	string
actor_type	Actor Type	The type of actor of the event. (User, GroupLink)	string
actor_id	Actor ID	The ID of the actor of the event.	string
actor_name	Actor Name	The name of the actor of the event	string
action	Action	The action of the event.	string
authenticated_by_id	Authenticated By ID	The ID of the authentication object.	string
authenticated_by_type	Authenticated By Type	The type of the authentication object. (null, Login, Card, GroupLink)	string
object_type	Object Type	The type of the object of the event.	string
object_id	Object ID	The ID of the object of the event.	string
object_name	Object Name	The name of the object of the event.	string
error_code	Error Code	An error code, in case the action was not successful.	string
error_message	Error Message	An error message, in case the action was not successful.	string
success	Event Success	Whether the action was successful.	string
sequence	Sequence	An identifier used to group related events that were created as part of the same action.	string
camera_snapshots	Camera Snapshots Available	Whether the event has any camera snapshots.	string
references	References	An array of references related to the event.	array
references.id	Reference ID	The ID of the reference.	string
references.type	Reference Type	The type of the reference.	string
details	Details	The details.	string
via	Via	by way of	string
code	Code	code (deprecated)	string
message	message	message (deprecated)	string

Controller Input Triggered (controller_input_triggered)

A controller input triggered event occurred.

Event Properties

Name	Display	Description	Type
id	Event ID	The ID of the event.	string
created_at	Created At	When the event was created	string
actor_type	Actor Type	The type of actor of the event. (User, GroupLink)	string
actor_id	Actor ID	The ID of the actor of the event.	string
actor_name	Actor Name	The name of the actor of the event	string
action	Action	The action of the event.	string
authenticated_by_id	Authenticated By ID	The ID of the authentication object.	string
authenticated_by_type	Authenticated By Type	The type of the authentication object. (null, Login, Card, GroupLink)	string
object_type	Object Type	The type of the object of the event.	string
object_id	Object ID	The ID of the object of the event.	string
object_name	Object Name	The name of the object of the event.	string
error_code	Error Code	An error code, in case the action was not successful.	string
error_message	Error Message	An error message, in case the action was not successful.	string
success	Event Success	Whether the action was successful.	string
sequence	Sequence	An identifier used to group related events that were created as part of the same action.	string
camera_snapshots	Camera Snapshots Available	Whether the event has any camera snapshots.	string
references	References	An array of references related to the event.	array
references.id	Reference ID	The ID of the reference.	string
references.type	Reference Type	The type of the reference.	string
details	Details	The details.	string
via	Via	by way of	string
code	Code	code (deprecated)	string
message	message	message (deprecated)	string

Controller Tamper (controller_tamper)

A controller tamper event occurred.

Event Properties

Name	Display	Description	Type
id	Event ID	The ID of the event.	string
created_at	Created At	When the event was created	string
actor_type	Actor Type	The type of actor of the event. (User, GroupLink)	string
actor_id	Actor ID	The ID of the actor of the event.	string
actor_name	Actor Name	The name of the actor of the event	string
action	Action	The action of the event.	string
authenticated_by_id	Authenticated By ID	The ID of the authentication object.	string
authenticated_by_type	Authenticated By Type	The type of the authentication object. (null, Login, Card, GroupLink)	string
object_type	Object Type	The type of the object of the event.	string
object_id	Object ID	The ID of the object of the event.	string
object_name	Object Name	The name of the object of the event.	string
error_code	Error Code	An error code, in case the action was not successful.	string
error_message	Error Message	An error message, in case the action was not successful.	string
success	Event Success	Whether the action was successful.	string
sequence	Sequence	An identifier used to group related events that were created as part of the same action.	string
camera_snapshots	Camera Snapshots Available	Whether the event has any camera snapshots.	string
references	References	An array of references related to the event.	array
references.id	Reference ID	The ID of the reference.	string
references.type	Reference Type	The type of the reference.	string
details	Details	The details.	string
via	Via	by way of	string
code	Code	code (deprecated)	string
message	message	message (deprecated)	string

Elevator Permit (elevator_permit)

An elevator permit event occurred.

Event Properties

Name	Display	Description	Type
id	Event ID	The ID of the event.	string
created_at	Created At	When the event was created	string
actor_type	Actor Type	The type of actor of the event. (User, GroupLink)	string
actor_id	Actor ID	The ID of the actor of the event.	string
actor_name	Actor Name	The name of the actor of the event	string
action	Action	The action of the event.	string
authenticated_by_id	Authenticated By ID	The ID of the authentication object.	string
authenticated_by_type	Authenticated By Type	The type of the authentication object. (null, Login, Card, GroupLink)	string
object_type	Object Type	The type of the object of the event.	string
object_id	Object ID	The ID of the object of the event.	string
object_name	Object Name	The name of the object of the event.	string
error_code	Error Code	An error code, in case the action was not successful.	string
error_message	Error Message	An error message, in case the action was not successful.	string
success	Event Success	Whether the action was successful.	string
sequence	Sequence	An identifier used to group related events that were created as part of the same action.	string
camera_snapshots	Camera Snapshots Available	Whether the event has any camera snapshots.	string
references	References	An array of references related to the event.	array
references.id	Reference ID	The ID of the reference.	string
references.type	Reference Type	The type of the reference.	string
details	Details	The details.	string
via	Via	by way of	string
code	Code	code (deprecated)	string
message	message	message (deprecated)	string

Elevator-Stop Cancel Lockdown (elevator_stop_cancel_lockdown)

An elevator-stop cancel lockdown event occurred.

Event Properties

Name	Display	Description	Type
id	Event ID	The ID of the event.	string
created_at	Created At	When the event was created	string
actor_type	Actor Type	The type of actor of the event. (User, GroupLink)	string
actor_id	Actor ID	The ID of the actor of the event.	string
actor_name	Actor Name	The name of the actor of the event	string
action	Action	The action of the event.	string
authenticated_by_id	Authenticated By ID	The ID of the authentication object.	string
authenticated_by_type	Authenticated By Type	The type of the authentication object. (null, Login, Card, GroupLink)	string
object_type	Object Type	The type of the object of the event.	string
object_id	Object ID	The ID of the object of the event.	string
object_name	Object Name	The name of the object of the event.	string
error_code	Error Code	An error code, in case the action was not successful.	string
error_message	Error Message	An error message, in case the action was not successful.	string
success	Event Success	Whether the action was successful.	string
sequence	Sequence	An identifier used to group related events that were created as part of the same action.	string
camera_snapshots	Camera Snapshots Available	Whether the event has any camera snapshots.	string
references	References	An array of references related to the event.	array
references.id	Reference ID	The ID of the reference.	string
references.type	Reference Type	The type of the reference.	string
details	Details	The details.	string
via	Via	by way of	string
code	Code	code (deprecated)	string
message	message	message (deprecated)	string

Elevator-Stop Lockdown (elevator_stop_lock_down)

An elevator-stop lockdown event occurred.

Event Properties

Name	Display	Description	Type
id	Event ID	The ID of the event.	string
created_at	Created At	When the event was created	string
actor_type	Actor Type	The type of actor of the event. (User, GroupLink)	string
actor_id	Actor ID	The ID of the actor of the event.	string
actor_name	Actor Name	The name of the actor of the event	string
action	Action	The action of the event.	string
authenticated_by_id	Authenticated By ID	The ID of the authentication object.	string
authenticated_by_type	Authenticated By Type	The type of the authentication object. (null, Login, Card, GroupLink)	string
object_type	Object Type	The type of the object of the event.	string
object_id	Object ID	The ID of the object of the event.	string
object_name	Object Name	The name of the object of the event.	string
error_code	Error Code	An error code, in case the action was not successful.	string
error_message	Error Message	An error message, in case the action was not successful.	string
success	Event Success	Whether the action was successful.	string
sequence	Sequence	An identifier used to group related events that were created as part of the same action.	string
camera_snapshots	Camera Snapshots Available	Whether the event has any camera snapshots.	string
references	References	An array of references related to the event.	array
references.id	Reference ID	The ID of the reference.	string
references.type	Reference Type	The type of the reference.	string
details	Details	The details.	string
via	Via	by way of	string
code	Code	code (deprecated)	string
message	message	message (deprecated)	string

Elevator-Stop Locked (elevator_stop_locked)

An elevator-stop locked event occurred.

Event Properties

Name	Display	Description	Type
id	Event ID	The ID of the event.	string
created_at	Created At	When the event was created	string
actor_type	Actor Type	The type of actor of the event. (User, GroupLink)	string
actor_id	Actor ID	The ID of the actor of the event.	string
actor_name	Actor Name	The name of the actor of the event	string
action	Action	The action of the event.	string
authenticated_by_id	Authenticated By ID	The ID of the authentication object.	string
authenticated_by_type	Authenticated By Type	The type of the authentication object. (null, Login, Card, GroupLink)	string
object_type	Object Type	The type of the object of the event.	string
object_id	Object ID	The ID of the object of the event.	string
object_name	Object Name	The name of the object of the event.	string
error_code	Error Code	An error code, in case the action was not successful.	string
error_message	Error Message	An error message, in case the action was not successful.	string
success	Event Success	Whether the action was successful.	string
sequence	Sequence	An identifier used to group related events that were created as part of the same action.	string
camera_snapshots	Camera Snapshots Available	Whether the event has any camera snapshots.	string
references	References	An array of references related to the event.	array
references.id	Reference ID	The ID of the reference.	string
references.type	Reference Type	The type of the reference.	string
details	Details	The details.	string
via	Via	by way of	string
code	Code	code (deprecated)	string
message	message	message (deprecated)	string

Elevator-Stop Opened (elevator_stop_opened)

An elevator-stop opened event occurred.

Event Properties

Name	Display	Description	Type
id	Event ID	The ID of the event.	string
created_at	Created At	When the event was created	string
actor_type	Actor Type	The type of actor of the event. (User, GroupLink)	string
actor_id	Actor ID	The ID of the actor of the event.	string
actor_name	Actor Name	The name of the actor of the event	string
action	Action	The action of the event.	string
authenticated_by_id	Authenticated By ID	The ID of the authentication object.	string
authenticated_by_type	Authenticated By Type	The type of the authentication object. (null, Login, Card, GroupLink)	string
object_type	Object Type	The type of the object of the event.	string
object_id	Object ID	The ID of the object of the event.	string
object_name	Object Name	The name of the object of the event.	string
error_code	Error Code	An error code, in case the action was not successful.	string
error_message	Error Message	An error message, in case the action was not successful.	string
success	Event Success	Whether the action was successful.	string
sequence	Sequence	An identifier used to group related events that were created as part of the same action.	string
camera_snapshots	Camera Snapshots Available	Whether the event has any camera snapshots.	string
references	References	An array of references related to the event.	array
references.id	Reference ID	The ID of the reference.	string
references.type	Reference Type	The type of the reference.	string
details	Details	The details.	string
via	Via	by way of	string
code	Code	code (deprecated)	string
message	message	message (deprecated)	string

Elevator-Stop Scheduled Permit Ended (elevator_stop_scheduled_permit_ended)

An elevator-stop scheduled permit ended event occurred.

Event Properties

Name	Display	Description	Type
id	Event ID	The ID of the event.	string
created_at	Created At	When the event was created	string
actor_type	Actor Type	The type of actor of the event. (User, GroupLink)	string
actor_id	Actor ID	The ID of the actor of the event.	string
actor_name	Actor Name	The name of the actor of the event	string
action	Action	The action of the event.	string
authenticated_by_id	Authenticated By ID	The ID of the authentication object.	string
authenticated_by_type	Authenticated By Type	The type of the authentication object. (null, Login, Card, GroupLink)	string
object_type	Object Type	The type of the object of the event.	string
object_id	Object ID	The ID of the object of the event.	string
object_name	Object Name	The name of the object of the event.	string
error_code	Error Code	An error code, in case the action was not successful.	string
error_message	Error Message	An error message, in case the action was not successful.	string
success	Event Success	Whether the action was successful.	string
sequence	Sequence	An identifier used to group related events that were created as part of the same action.	string
camera_snapshots	Camera Snapshots Available	Whether the event has any camera snapshots.	string
references	References	An array of references related to the event.	array
references.id	Reference ID	The ID of the reference.	string
references.type	Reference Type	The type of the reference.	string
details	Details	The details.	string
via	Via	by way of	string
code	Code	code (deprecated)	string
message	message	message (deprecated)	string

Elevator-Stop Scheduled Permit Started (elevator_stop_scheduled_permit_started)

An elevator-stop scheduled permit started event occurred.

Event Properties

Name	Display	Description	Type
id	Event ID	The ID of the event.	string
created_at	Created At	When the event was created	string
actor_type	Actor Type	The type of actor of the event. (User, GroupLink)	string
actor_id	Actor ID	The ID of the actor of the event.	string
actor_name	Actor Name	The name of the actor of the event	string
action	Action	The action of the event.	string
authenticated_by_id	Authenticated By ID	The ID of the authentication object.	string
authenticated_by_type	Authenticated By Type	The type of the authentication object. (null, Login, Card, GroupLink)	string
object_type	Object Type	The type of the object of the event.	string
object_id	Object ID	The ID of the object of the event.	string
object_name	Object Name	The name of the object of the event.	string
error_code	Error Code	An error code, in case the action was not successful.	string
error_message	Error Message	An error message, in case the action was not successful.	string
success	Event Success	Whether the action was successful.	string
sequence	Sequence	An identifier used to group related events that were created as part of the same action.	string
camera_snapshots	Camera Snapshots Available	Whether the event has any camera snapshots.	string
references	References	An array of references related to the event.	array
references.id	Reference ID	The ID of the reference.	string
references.type	Reference Type	The type of the reference.	string
details	Details	The details.	string
via	Via	by way of	string
code	Code	code (deprecated)	string
message	message	message (deprecated)	string

Kisi Event (kisiEvent)

A custom webhook event sent from kisi and processed using the adapters Process Webhook command.

Event Properties

Name	Display	Description	Type
id	Event ID	The ID of the event.	string
created_at	Created At	When the event was created	string
actor_type	Actor Type	The type of actor of the event. (User, GroupLink)	string
actor_id	Actor ID	The ID of the actor of the event.	string
actor_name	Actor Name	The name of the actor of the event	string
action	Action	The action of the event.	string
authenticated_by_id	Authenticated By ID	The ID of the authentication object.	string
authenticated_by_type	Authenticated By Type	The type of the authentication object. (null, Login, Card, GroupLink)	string
object_type	Object Type	The type of the object of the event.	string
object_id	Object ID	The ID of the object of the event.	string
object_name	Object Name	The name of the object of the event.	string
error_code	Error Code	An error code, in case the action was not successful.	string
error_message	Error Message	An error message, in case the action was not successful.	string
success	Event Success	Whether the action was successful.	string
sequence	Sequence	An identifier used to group related events that were created as part of the same action.	string
camera_snapshots	Camera Snapshots Available	Whether the event has any camera snapshots.	string
references	References	An array of references related to the event.	array
references.id	Reference ID	The ID of the reference.	string
references.type	Reference Type	The type of the reference.	string
details	Details	The details.	string
via	Via	by way of	string
code	Code	code (deprecated)	string
message	message	message (deprecated)	string

Door Cancel LockDown (lock_cancel_lockdown)

A door cancel lock down event occurred.

Event Properties

Name	Display	Description	Type
id	Event ID	The ID of the event.	string
created_at	Created At	When the event was created	string
actor_type	Actor Type	The type of actor of the event. (User, GroupLink)	string
actor_id	Actor ID	The ID of the actor of the event.	string
actor_name	Actor Name	The name of the actor of the event	string
action	Action	The action of the event.	string
authenticated_by_id	Authenticated By ID	The ID of the authentication object.	string
authenticated_by_type	Authenticated By Type	The type of the authentication object. (null, Login, Card, GroupLink)	string
object_type	Object Type	The type of the object of the event.	string
object_id	Object ID	The ID of the object of the event.	string
object_name	Object Name	The name of the object of the event.	string
error_code	Error Code	An error code, in case the action was not successful.	string
error_message	Error Message	An error message, in case the action was not successful.	string
success	Event Success	Whether the action was successful.	string
sequence	Sequence	An identifier used to group related events that were created as part of the same action.	string
camera_snapshots	Camera Snapshots Available	Whether the event has any camera snapshots.	string
references	References	An array of references related to the event.	array
references.id	Reference ID	The ID of the reference.	string
references.type	Reference Type	The type of the reference.	string
details	Details	The details.	string
via	Via	by way of	string
code	Code	code (deprecated)	string
message	message	message (deprecated)	string

Door Closed (lock_closed)

A door closed event occurred.

Event Properties

Name	Display	Description	Type
id	Event ID	The ID of the event.	string
created_at	Created At	When the event was created	string
actor_type	Actor Type	The type of actor of the event. (User, GroupLink)	string
actor_id	Actor ID	The ID of the actor of the event.	string
actor_name	Actor Name	The name of the actor of the event	string
action	Action	The action of the event.	string
authenticated_by_id	Authenticated By ID	The ID of the authentication object.	string
authenticated_by_type	Authenticated By Type	The type of the authentication object. (null, Login, Card, GroupLink)	string
object_type	Object Type	The type of the object of the event.	string
object_id	Object ID	The ID of the object of the event.	string
object_name	Object Name	The name of the object of the event.	string
error_code	Error Code	An error code, in case the action was not successful.	string
error_message	Error Message	An error message, in case the action was not successful.	string
success	Event Success	Whether the action was successful.	string
sequence	Sequence	An identifier used to group related events that were created as part of the same action.	string
camera_snapshots	Camera Snapshots Available	Whether the event has any camera snapshots.	string
references	References	An array of references related to the event.	array
references.id	Reference ID	The ID of the reference.	string
references.type	Reference Type	The type of the reference.	string
details	Details	The details.	string
via	Via	by way of	string
code	Code	code (deprecated)	string
message	message	message (deprecated)	string

Door Forced Open (lock_forced_open)

A door forced open event occurred.

Event Properties

Name	Display	Description	Type
id	Event ID	The ID of the event.	string
created_at	Created At	When the event was created	string
actor_type	Actor Type	The type of actor of the event. (User, GroupLink)	string
actor_id	Actor ID	The ID of the actor of the event.	string
actor_name	Actor Name	The name of the actor of the event	string
action	Action	The action of the event.	string
authenticated_by_id	Authenticated By ID	The ID of the authentication object.	string
authenticated_by_type	Authenticated By Type	The type of the authentication object. (null, Login, Card, GroupLink)	string
object_type	Object Type	The type of the object of the event.	string
object_id	Object ID	The ID of the object of the event.	string
object_name	Object Name	The name of the object of the event.	string
error_code	Error Code	An error code, in case the action was not successful.	string
error_message	Error Message	An error message, in case the action was not successful.	string
success	Event Success	Whether the action was successful.	string
sequence	Sequence	An identifier used to group related events that were created as part of the same action.	string
camera_snapshots	Camera Snapshots Available	Whether the event has any camera snapshots.	string
references	References	An array of references related to the event.	array
references.id	Reference ID	The ID of the reference.	string
references.type	Reference Type	The type of the reference.	string
details	Details	The details.	string
via	Via	by way of	string
code	Code	code (deprecated)	string
message	message	message (deprecated)	string

Door Held Open (lock_held_open)

A door held open event occurred.

Event Properties

Name	Display	Description	Type
id	Event ID	The ID of the event.	string
created_at	Created At	When the event was created	string
actor_type	Actor Type	The type of actor of the event. (User, GroupLink)	string
actor_id	Actor ID	The ID of the actor of the event.	string
actor_name	Actor Name	The name of the actor of the event	string
action	Action	The action of the event.	string
authenticated_by_id	Authenticated By ID	The ID of the authentication object.	string
authenticated_by_type	Authenticated By Type	The type of the authentication object. (null, Login, Card, GroupLink)	string
object_type	Object Type	The type of the object of the event.	string
object_id	Object ID	The ID of the object of the event.	string
object_name	Object Name	The name of the object of the event.	string
error_code	Error Code	An error code, in case the action was not successful.	string
error_message	Error Message	An error message, in case the action was not successful.	string
success	Event Success	Whether the action was successful.	string
sequence	Sequence	An identifier used to group related events that were created as part of the same action.	string
camera_snapshots	Camera Snapshots Available	Whether the event has any camera snapshots.	string
references	References	An array of references related to the event.	array
references.id	Reference ID	The ID of the reference.	string
references.type	Reference Type	The type of the reference.	string
details	Details	The details.	string
via	Via	by way of	string
code	Code	code (deprecated)	string
message	message	message (deprecated)	string

Door LockDown (lock_lockdown)

A door lock down event occurred.

Event Properties

Name	Display	Description	Type
id	Event ID	The ID of the event.	string
created_at	Created At	When the event was created	string
actor_type	Actor Type	The type of actor of the event. (User, GroupLink)	string
actor_id	Actor ID	The ID of the actor of the event.	string
actor_name	Actor Name	The name of the actor of the event	string
action	Action	The action of the event.	string
authenticated_by_id	Authenticated By ID	The ID of the authentication object.	string
authenticated_by_type	Authenticated By Type	The type of the authentication object. (null, Login, Card, GroupLink)	string
object_type	Object Type	The type of the object of the event.	string
object_id	Object ID	The ID of the object of the event.	string
object_name	Object Name	The name of the object of the event.	string
error_code	Error Code	An error code, in case the action was not successful.	string
error_message	Error Message	An error message, in case the action was not successful.	string
success	Event Success	Whether the action was successful.	string
sequence	Sequence	An identifier used to group related events that were created as part of the same action.	string
camera_snapshots	Camera Snapshots Available	Whether the event has any camera snapshots.	string
references	References	An array of references related to the event.	array
references.id	Reference ID	The ID of the reference.	string
references.type	Reference Type	The type of the reference.	string
details	Details	The details.	string
via	Via	by way of	string
code	Code	code (deprecated)	string
message	message	message (deprecated)	string

Door Locked (lock_locked)

A door lock event occurred.

Event Properties

Name	Display	Description	Type
id	Event ID	The ID of the event.	string
created_at	Created At	When the event was created	string
actor_type	Actor Type	The type of actor of the event. (User, GroupLink)	string
actor_id	Actor ID	The ID of the actor of the event.	string
actor_name	Actor Name	The name of the actor of the event	string
action	Action	The action of the event.	string
authenticated_by_id	Authenticated By ID	The ID of the authentication object.	string
authenticated_by_type	Authenticated By Type	The type of the authentication object. (null, Login, Card, GroupLink)	string
object_type	Object Type	The type of the object of the event.	string
object_id	Object ID	The ID of the object of the event.	string
object_name	Object Name	The name of the object of the event.	string
error_code	Error Code	An error code, in case the action was not successful.	string
error_message	Error Message	An error message, in case the action was not successful.	string
success	Event Success	Whether the action was successful.	string
sequence	Sequence	An identifier used to group related events that were created as part of the same action.	string
camera_snapshots	Camera Snapshots Available	Whether the event has any camera snapshots.	string
references	References	An array of references related to the event.	array
references.id	Reference ID	The ID of the reference.	string
references.type	Reference Type	The type of the reference.	string
details	Details	The details.	string
via	Via	by way of	string
code	Code	code (deprecated)	string
message	message	message (deprecated)	string

Door Opened (lock_opened)

A door opened event occurred.

Event Properties

Name	Display	Description	Type
id	Event ID	The ID of the event.	string
created_at	Created At	When the event was created	string
actor_type	Actor Type	The type of actor of the event. (User, GroupLink)	string
actor_id	Actor ID	The ID of the actor of the event.	string
actor_name	Actor Name	The name of the actor of the event	string
action	Action	The action of the event.	string
authenticated_by_id	Authenticated By ID	The ID of the authentication object.	string
authenticated_by_type	Authenticated By Type	The type of the authentication object. (null, Login, Card, GroupLink)	string
object_type	Object Type	The type of the object of the event.	string
object_id	Object ID	The ID of the object of the event.	string
object_name	Object Name	The name of the object of the event.	string
error_code	Error Code	An error code, in case the action was not successful.	string
error_message	Error Message	An error message, in case the action was not successful.	string
success	Event Success	Whether the action was successful.	string
sequence	Sequence	An identifier used to group related events that were created as part of the same action.	string
camera_snapshots	Camera Snapshots Available	Whether the event has any camera snapshots.	string
references	References	An array of references related to the event.	array
references.id	Reference ID	The ID of the reference.	string
references.type	Reference Type	The type of the reference.	string
details	Details	The details.	string
via	Via	by way of	string
code	Code	code (deprecated)	string
message	message	message (deprecated)	string

Door Scheduled Unlock Ended (lock_scheduled_unlock_ended)

A door scheduled unlock ended event occurred.

Event Properties

Name	Display	Description	Type
id	Event ID	The ID of the event.	string
created_at	Created At	When the event was created	string
actor_type	Actor Type	The type of actor of the event. (User, GroupLink)	string
actor_id	Actor ID	The ID of the actor of the event.	string
actor_name	Actor Name	The name of the actor of the event	string
action	Action	The action of the event.	string
authenticated_by_id	Authenticated By ID	The ID of the authentication object.	string
authenticated_by_type	Authenticated By Type	The type of the authentication object. (null, Login, Card, GroupLink)	string
object_type	Object Type	The type of the object of the event.	string
object_id	Object ID	The ID of the object of the event.	string
object_name	Object Name	The name of the object of the event.	string
error_code	Error Code	An error code, in case the action was not successful.	string
error_message	Error Message	An error message, in case the action was not successful.	string
success	Event Success	Whether the action was successful.	string
sequence	Sequence	An identifier used to group related events that were created as part of the same action.	string
camera_snapshots	Camera Snapshots Available	Whether the event has any camera snapshots.	string
references	References	An array of references related to the event.	array
references.id	Reference ID	The ID of the reference.	string
references.type	Reference Type	The type of the reference.	string
details	Details	The details.	string
via	Via	by way of	string
code	Code	code (deprecated)	string
message	message	message (deprecated)	string

Door Scheduled Unlock Started (lock_scheduled_unlock_started)

A door scheduled unlock started event occurred.

Event Properties

Name	Display	Description	Type
id	Event ID	The ID of the event.	string
created_at	Created At	When the event was created	string
actor_type	Actor Type	The type of actor of the event. (User, GroupLink)	string
actor_id	Actor ID	The ID of the actor of the event.	string
actor_name	Actor Name	The name of the actor of the event	string
action	Action	The action of the event.	string
authenticated_by_id	Authenticated By ID	The ID of the authentication object.	string
authenticated_by_type	Authenticated By Type	The type of the authentication object. (null, Login, Card, GroupLink)	string
object_type	Object Type	The type of the object of the event.	string
object_id	Object ID	The ID of the object of the event.	string
object_name	Object Name	The name of the object of the event.	string
error_code	Error Code	An error code, in case the action was not successful.	string
error_message	Error Message	An error message, in case the action was not successful.	string
success	Event Success	Whether the action was successful.	string
sequence	Sequence	An identifier used to group related events that were created as part of the same action.	string
camera_snapshots	Camera Snapshots Available	Whether the event has any camera snapshots.	string
references	References	An array of references related to the event.	array
references.id	Reference ID	The ID of the reference.	string
references.type	Reference Type	The type of the reference.	string
details	Details	The details.	string
via	Via	by way of	string
code	Code	code (deprecated)	string
message	message	message (deprecated)	string

Door UnLocked (lock_unlocked)

A door unlock event occurred.

Event Properties

Name	Display	Description	Type
id	Event ID	The ID of the event.	string
created_at	Created At	When the event was created	string
actor_type	Actor Type	The type of actor of the event. (User, GroupLink)	string
actor_id	Actor ID	The ID of the actor of the event.	string
actor_name	Actor Name	The name of the actor of the event	string
action	Action	The action of the event.	string
authenticated_by_id	Authenticated By ID	The ID of the authentication object.	string
authenticated_by_type	Authenticated By Type	The type of the authentication object. (null, Login, Card, GroupLink)	string
object_type	Object Type	The type of the object of the event.	string
object_id	Object ID	The ID of the object of the event.	string
object_name	Object Name	The name of the object of the event.	string
error_code	Error Code	An error code, in case the action was not successful.	string
error_message	Error Message	An error message, in case the action was not successful.	string
success	Event Success	Whether the action was successful.	string
sequence	Sequence	An identifier used to group related events that were created as part of the same action.	string
camera_snapshots	Camera Snapshots Available	Whether the event has any camera snapshots.	string
references	References	An array of references related to the event.	array
references.id	Reference ID	The ID of the reference.	string
references.type	Reference Type	The type of the reference.	string
details	Details	The details.	string
via	Via	by way of	string
code	Code	code (deprecated)	string
message	message	message (deprecated)	string

Place Cancel Lockdown (place_cancel_lockdown)

A place cancel lockdown event occurred.

Event Properties

Name	Display	Description	Type
id	Event ID	The ID of the event.	string
created_at	Created At	When the event was created	string
actor_type	Actor Type	The type of actor of the event. (User, GroupLink)	string
actor_id	Actor ID	The ID of the actor of the event.	string
actor_name	Actor Name	The name of the actor of the event	string
action	Action	The action of the event.	string
authenticated_by_id	Authenticated By ID	The ID of the authentication object.	string
authenticated_by_type	Authenticated By Type	The type of the authentication object. (null, Login, Card, GroupLink)	string
object_type	Object Type	The type of the object of the event.	string
object_id	Object ID	The ID of the object of the event.	string
object_name	Object Name	The name of the object of the event.	string
error_code	Error Code	An error code, in case the action was not successful.	string
error_message	Error Message	An error message, in case the action was not successful.	string
success	Event Success	Whether the action was successful.	string
sequence	Sequence	An identifier used to group related events that were created as part of the same action.	string
camera_snapshots	Camera Snapshots Available	Whether the event has any camera snapshots.	string
references	References	An array of references related to the event.	array
references.id	Reference ID	The ID of the reference.	string
references.type	Reference Type	The type of the reference.	string
details	Details	The details.	string
via	Via	by way of	string
code	Code	code (deprecated)	string
message	message	message (deprecated)	string

Place Lockdown (place_lock_down)

A place lockdown event occurred.

Event Properties

Name	Display	Description	Type
id	Event ID	The ID of the event.	string
created_at	Created At	When the event was created	string
actor_type	Actor Type	The type of actor of the event. (User, GroupLink)	string
actor_id	Actor ID	The ID of the actor of the event.	string
actor_name	Actor Name	The name of the actor of the event	string
action	Action	The action of the event.	string
authenticated_by_id	Authenticated By ID	The ID of the authentication object.	string
authenticated_by_type	Authenticated By Type	The type of the authentication object. (null, Login, Card, GroupLink)	string
object_type	Object Type	The type of the object of the event.	string
object_id	Object ID	The ID of the object of the event.	string
object_name	Object Name	The name of the object of the event.	string
error_code	Error Code	An error code, in case the action was not successful.	string
error_message	Error Message	An error message, in case the action was not successful.	string
success	Event Success	Whether the action was successful.	string
sequence	Sequence	An identifier used to group related events that were created as part of the same action.	string
camera_snapshots	Camera Snapshots Available	Whether the event has any camera snapshots.	string
references	References	An array of references related to the event.	array
references.id	Reference ID	The ID of the reference.	string
references.type	Reference Type	The type of the reference.	string
details	Details	The details.	string
via	Via	by way of	string
code	Code	code (deprecated)	string
message	message	message (deprecated)	string

Place Locked (place_locked)

A place locked event occurred.

Event Properties

Name	Display	Description	Type
id	Event ID	The ID of the event.	string
created_at	Created At	When the event was created	string
actor_type	Actor Type	The type of actor of the event. (User, GroupLink)	string
actor_id	Actor ID	The ID of the actor of the event.	string
actor_name	Actor Name	The name of the actor of the event	string
action	Action	The action of the event.	string
authenticated_by_id	Authenticated By ID	The ID of the authentication object.	string
authenticated_by_type	Authenticated By Type	The type of the authentication object. (null, Login, Card, GroupLink)	string
object_type	Object Type	The type of the object of the event.	string
object_id	Object ID	The ID of the object of the event.	string
object_name	Object Name	The name of the object of the event.	string
error_code	Error Code	An error code, in case the action was not successful.	string
error_message	Error Message	An error message, in case the action was not successful.	string
success	Event Success	Whether the action was successful.	string
sequence	Sequence	An identifier used to group related events that were created as part of the same action.	string
camera_snapshots	Camera Snapshots Available	Whether the event has any camera snapshots.	string
references	References	An array of references related to the event.	array
references.id	Reference ID	The ID of the reference.	string
references.type	Reference Type	The type of the reference.	string
details	Details	The details.	string
via	Via	by way of	string
code	Code	code (deprecated)	string
message	message	message (deprecated)	string

Place Occupancy limit Reached (place_occupancy_rate_limit_reach)

A place occupancy limit reached event occurred.

Event Properties

Name	Display	Description	Type
id	Event ID	The ID of the event.	string
created_at	Created At	When the event was created	string
actor_type	Actor Type	The type of actor of the event. (User, GroupLink)	string
actor_id	Actor ID	The ID of the actor of the event.	string
actor_name	Actor Name	The name of the actor of the event	string
action	Action	The action of the event.	string
authenticated_by_id	Authenticated By ID	The ID of the authentication object.	string
authenticated_by_type	Authenticated By Type	The type of the authentication object. (null, Login, Card, GroupLink)	string
object_type	Object Type	The type of the object of the event.	string
object_id	Object ID	The ID of the object of the event.	string
object_name	Object Name	The name of the object of the event.	string
error_code	Error Code	An error code, in case the action was not successful.	string
error_message	Error Message	An error message, in case the action was not successful.	string
success	Event Success	Whether the action was successful.	string
sequence	Sequence	An identifier used to group related events that were created as part of the same action.	string
camera_snapshots	Camera Snapshots Available	Whether the event has any camera snapshots.	string
references	References	An array of references related to the event.	array
references.id	Reference ID	The ID of the reference.	string
references.type	Reference Type	The type of the reference.	string
details	Details	The details.	string
via	Via	by way of	string
code	Code	code (deprecated)	string
message	message	message (deprecated)	string

Wireless Lock Battery Warning (wirelesslock_battery_warning)

A wireless lock battery warning event occurred.

Event Properties

Name	Display	Description	Type
id	Event ID	The ID of the event.	string
created_at	Created At	When the event was created	string
actor_type	Actor Type	The type of actor of the event. (User, GroupLink)	string
actor_id	Actor ID	The ID of the actor of the event.	string
actor_name	Actor Name	The name of the actor of the event	string
action	Action	The action of the event.	string
authenticated_by_id	Authenticated By ID	The ID of the authentication object.	string
authenticated_by_type	Authenticated By Type	The type of the authentication object. (null, Login, Card, GroupLink)	string
object_type	Object Type	The type of the object of the event.	string
object_id	Object ID	The ID of the object of the event.	string
object_name	Object Name	The name of the object of the event.	string
error_code	Error Code	An error code, in case the action was not successful.	string
error_message	Error Message	An error message, in case the action was not successful.	string
success	Event Success	Whether the action was successful.	string
sequence	Sequence	An identifier used to group related events that were created as part of the same action.	string
camera_snapshots	Camera Snapshots Available	Whether the event has any camera snapshots.	string
references	References	An array of references related to the event.	array
references.id	Reference ID	The ID of the reference.	string
references.type	Reference Type	The type of the reference.	string
details	Details	The details.	string
via	Via	by way of	string
code	Code	code (deprecated)	string
message	message	message (deprecated)	string

Wireless Lock Closed (wirelesslock_closed)

A wireless lock closed event occurred.

Event Properties

Name	Display	Description	Type
id	Event ID	The ID of the event.	string
created_at	Created At	When the event was created	string
actor_type	Actor Type	The type of actor of the event. (User, GroupLink)	string
actor_id	Actor ID	The ID of the actor of the event.	string
actor_name	Actor Name	The name of the actor of the event	string
action	Action	The action of the event.	string
authenticated_by_id	Authenticated By ID	The ID of the authentication object.	string
authenticated_by_type	Authenticated By Type	The type of the authentication object. (null, Login, Card, GroupLink)	string
object_type	Object Type	The type of the object of the event.	string
object_id	Object ID	The ID of the object of the event.	string
object_name	Object Name	The name of the object of the event.	string
error_code	Error Code	An error code, in case the action was not successful.	string
error_message	Error Message	An error message, in case the action was not successful.	string
success	Event Success	Whether the action was successful.	string
sequence	Sequence	An identifier used to group related events that were created as part of the same action.	string
camera_snapshots	Camera Snapshots Available	Whether the event has any camera snapshots.	string
references	References	An array of references related to the event.	array
references.id	Reference ID	The ID of the reference.	string
references.type	Reference Type	The type of the reference.	string
details	Details	The details.	string
via	Via	by way of	string
code	Code	code (deprecated)	string
message	message	message (deprecated)	string

Wireless Lock Opened (wirelesslock_opened)

A wireless lock opened event occurred.

Event Properties

Name	Display	Description	Type
id	Event ID	The ID of the event.	string
created_at	Created At	When the event was created	string
actor_type	Actor Type	The type of actor of the event. (User, GroupLink)	string
actor_id	Actor ID	The ID of the actor of the event.	string
actor_name	Actor Name	The name of the actor of the event	string
action	Action	The action of the event.	string
authenticated_by_id	Authenticated By ID	The ID of the authentication object.	string
authenticated_by_type	Authenticated By Type	The type of the authentication object. (null, Login, Card, GroupLink)	string
object_type	Object Type	The type of the object of the event.	string
object_id	Object ID	The ID of the object of the event.	string
object_name	Object Name	The name of the object of the event.	string
error_code	Error Code	An error code, in case the action was not successful.	string
error_message	Error Message	An error message, in case the action was not successful.	string
success	Event Success	Whether the action was successful.	string
sequence	Sequence	An identifier used to group related events that were created as part of the same action.	string
camera_snapshots	Camera Snapshots Available	Whether the event has any camera snapshots.	string
references	References	An array of references related to the event.	array
references.id	Reference ID	The ID of the reference.	string
references.type	Reference Type	The type of the reference.	string
details	Details	The details.	string
via	Via	by way of	string
code	Code	code (deprecated)	string
message	message	message (deprecated)	string

Wireless Lock Tamper (wirelesslock_tampered)

A wireless lock tamper event occurred.

Event Properties

Name	Display	Description	Type
id	Event ID	The ID of the event.	string
created_at	Created At	When the event was created	string
actor_type	Actor Type	The type of actor of the event. (User, GroupLink)	string
actor_id	Actor ID	The ID of the actor of the event.	string
actor_name	Actor Name	The name of the actor of the event	string
action	Action	The action of the event.	string
authenticated_by_id	Authenticated By ID	The ID of the authentication object.	string
authenticated_by_type	Authenticated By Type	The type of the authentication object. (null, Login, Card, GroupLink)	string
object_type	Object Type	The type of the object of the event.	string
object_id	Object ID	The ID of the object of the event.	string
object_name	Object Name	The name of the object of the event.	string
error_code	Error Code	An error code, in case the action was not successful.	string
error_message	Error Message	An error message, in case the action was not successful.	string
success	Event Success	Whether the action was successful.	string
sequence	Sequence	An identifier used to group related events that were created as part of the same action.	string
camera_snapshots	Camera Snapshots Available	Whether the event has any camera snapshots.	string
references	References	An array of references related to the event.	array
references.id	Reference ID	The ID of the reference.	string
references.type	Reference Type	The type of the reference.	string
details	Details	The details.	string
via	Via	by way of	string
code	Code	code (deprecated)	string
message	message	message (deprecated)	string

Wireless Lock Unlocked (wirelesslock_unlocked)

A wireless lock unlocked event occurred.

Event Properties

Name	Display	Description	Type
id	Event ID	The ID of the event.	string
created_at	Created At	When the event was created	string
actor_type	Actor Type	The type of actor of the event. (User, GroupLink)	string
actor_id	Actor ID	The ID of the actor of the event.	string
actor_name	Actor Name	The name of the actor of the event	string
action	Action	The action of the event.	string
authenticated_by_id	Authenticated By ID	The ID of the authentication object.	string
authenticated_by_type	Authenticated By Type	The type of the authentication object. (null, Login, Card, GroupLink)	string
object_type	Object Type	The type of the object of the event.	string
object_id	Object ID	The ID of the object of the event.	string
object_name	Object Name	The name of the object of the event.	string
error_code	Error Code	An error code, in case the action was not successful.	string
error_message	Error Message	An error message, in case the action was not successful.	string
success	Event Success	Whether the action was successful.	string
sequence	Sequence	An identifier used to group related events that were created as part of the same action.	string
camera_snapshots	Camera Snapshots Available	Whether the event has any camera snapshots.	string
references	References	An array of references related to the event.	array
references.id	Reference ID	The ID of the reference.	string
references.type	Reference Type	The type of the reference.	string
details	Details	The details.	string
via	Via	by way of	string
code	Code	code (deprecated)	string
message	message	message (deprecated)	string

Release History

Version	Type	Description	Tracking #	Date
2.0.1	Initial	First release in the Adapter Type store.		2023-05-16
2.0.2	Maintenance	Updated third-party components and improved maintainability.	NAP-27635	2024-07-31

Categories

• Access Control
• Door
• Sensor