Skip to content

KISI Access Control

This template will configure UIP to use KISI access control to open a door and process events.

UIP Resources

The provided template utilizes the following UIP resources.

Adapters

  • KISI - used to communicate with the KISI API to unlock doors etc.
  • Built In Commands - used for data mapping to store KISI security tokens for users

Workflows

  • Kisi Unlock Door - used to unlock/open a door.
  • Kisi Process Webhook Event - used to process webhook events received from Kisi
  • Kisi Create Access Link - used to create access links for external users to open doors

Triggers

  • Kisi Webhook - advanced webhook endpoint for KISI to send event notifications. (This trigger must always point to the "Kisi Process Webhook" workflow to remove possible duplicate events sent from KISI)
  • Kisi Event - includes all events sent from KISI. Individual event types can be filtered as necessary in a workflow.
  • Kisi Door UnLocked (lock_unlocked) Event - can be used to track door open success/failures
  • Kisi Door Forced Open (lock_forced_open) Event - can be used to send an email, SMS notification, or trigger an alarm
  • Kisi Door Held Open (lock_held_open) - can be used to send an email, SMS notification, or trigger an alarm

Prerequisites

  • KISI Controller Pro hardware installed and configured.
  • KISI API Key - used for UIP to API authentication

KISI Configuration

Configuring UIP Webhook

KISI uses a webhook trigger in UIP to send events. (i.e. Door Opened, Door Closed, etc.) Use the following steps below to configure KISI integration:

Note

This template creates a UIP Webhook trigger that will have the following URL pattern:

URL - https://[hostname]/wfe/api/advancedwebhook/kisievents

**[hostname]** - DNS name of UIP.

Set up the integration

  1. Sign in to Kisi
  2. Under Organization Setup, click on Integrations
  3. Click on Add Integration
  4. Define the name of your new event webhook integration. (i.e. "UIP events")
  5. Open the Type drop down and select Event Webhook

  6. Under Event Webhook URL, enter the UIP Webhook URL as shown in the note above.

  7. Select the following minimum event types to include in the event webhook:

    • lock.forced_open
    • lock_held_open
    • lock.opened
    • lock.unlock
    • lock_closed

  8. Enable the integration

  9. Click Add

Note

The terms "lock" and "door" are used interchangeably.

Template

Right-Click Here and Save link as to download the UIP Import Configuration template file for this template.

Input Properties

The template requires the following properties to be input before the template can be imported successfully:

  • KISI Api Key - The KISI API Key used for authentication

Import Configuration Template

Refer to Templates > Import Configuration Template for more details about how to import the downloaded template file.