Zapier App

The KleverKey Zapier App  currently provides 1 trigger and 3 actions, but we welcome requests for additional triggers and actions. The currently existing actions focus on the integration of booking platforms and coworking management services.

KleverKey also provides an API and Webhooks for use cases where the Zapier app doesn't fit.

Triggers 

New Lock Activity

This event gets triggered each time a lock of your organization creates a new lock activity.

The Zapier Trigger will receive lock activities with properties like activity time, type and status, as well as user, device and lock information. Please go to the Lock Activity web event documentation for a detailed description.

Actions

Create, Update or Cancel Booking

If your source service is a booking platform, this action lets you submit bookings to KleverKey.

The resulting invitations and permissions will contain a time slot that corresponds to the booking.

The user reference ID will create an identity mapping in KleverKey based on the email address. That identity mapping can be retrieved later to send data back to the booking platform, if it requires the original user ID. And that identity mapping is also used to keep users connected across services even when their email address changes.

The booking reference ID needs to be a unique ID in the booking platform. It will be used to identify time slots in KleverKey permissions.

Booking lock IDs point to the locks that correspond to the booked resource (e.g. meeting/hotel room, apartment, etc.). For booked resources that have more than one lock (e.g. multiple doors, lift, main door,  etc.) this property supports a list of IDs. Usually these IDs are mapped from the booked resource ID in a previous Zapier action (e.g. Room 101 → KleverKey Lock 5, Room 102 → KleverKey Lock 6, etc.)

Create, Update or Cancel Access Plan

If your source service supports access plans, this action lets you submit access plans to KleverKey.

The resulting invitations and permissions will contain a time profile that corresponds to those access plans.

The user reference ID will create an identity mapping in KleverKey based on the email address. That identity mapping that can be retrieved later to send data back to the source service, if it requires the original user ID. And that identity mapping is also used to keep users connected across services even when their email address changes.

The access plan reference ID needs to be a unique ID in the source service.

Access plan lock IDs point to the locks that correspond to the resource that should be accessed (e.g. main door, cafeteria, office, etc.). Usually these IDs are mapped from the access plan reference ID in a previous Zapier action (e.g. Basic access → KleverKey Lock 1-5, Full access → KleverKey Lock 1-10, etc.)

Access plan are defined as daily time slots that repeat every week. The example below allows access on Mondays, Tuesday and Wednesdays between 8:00 AM and 6:00 PM.

Below you see an access plan definition JSON for the above example. Day of week begins on Sunday (with 0) and start/end time begin on midnight (with 0) and are defined in minutes (the max endTime is 1440).

[{
        "dayOfWeek": 1,
        "startTime": 480,
        "endTime": 1080
    }, {
        "dayOfWeek": 2,
        "startTime": 480,
        "endTime": 1080
    }, {
        "dayOfWeek": 3,
        "startTime": 480,
        "endTime": 1080
    }
]

Access plans are usually mapped from the access plan reference ID in a previous step or they can be built from access plan data of the source service in a Zapier Code action.

Find Identity Mapping

This action retrieves identity mappings that have been created manually or by the actions "Create, Update or Cancel Booking" or "Create, Update or Cancel Access Plan".

This action is useful when a Zap was triggered by a KleverKey event that contains a user ID and the destination service requires the original user ID (e.g. check-ins in coworking management services).