Skip to content

Zapier Integration

Automating key management is available via the Unloc app on Zapier.

What is Zapier

Zapier is an automation platform that allows you to connect apps to automate tasks. You build automated tasks (Zaps) by connecting triggers with actions.

Unloc is available as an action on Zapier. This means that you can connect 3rd party apps with Unloc in order to create or revoke digital keys as a result of specific trigger events.

Use Cases

Some examples of Zaps that you can build with the Unloc action:

  • Co-working: Connect co-working management software (such as Optix or OfficeRnD) with Unloc to issue digital keys whenever a new booking is made.
  • Calendars: Issue digital keys to a meeting room whenever someone creates a calender event in Google Calendar.
  • SMS: by using Twilio as a trigger app, you can process SMS messages sent to a specific phone number, and automatically issue digital keys based on specific keywords in the SMS message.

Get Started

Please accept the public invite to get access to the Unloc Zapier app.

In order to configure your Zap with Unloc as an Action you also need an Unloc authentication credentials (a partner API key and a partner ID). See Getting started for details on how to request credentials.

Enter your API key and partner ID in the auth form in the Zapier editor.

Actions

The Unloc app on Zapier has two actions. One for creating keys and one for revoking keys. You may set start and end times for a key just as you would do in the Unloc mobile app.

Info

In order to create a key for a lock you must hold key creation privilege on the lock. If you onboarded the lock into Unloc (ie. you are the owner of the lock) then you will automatically have the correct privilege. If you are unsure or need help, please ask us.

Info

The Lock Group ID (lockGroupId) parameter will help you map identifiers from the trigger app to the Unloc lock ID system. One or more locks may have the same Lock Group ID. Ask us to set up this mapping for you (we will have a self service set up for this later).

Creating keys

In order to create keys the Unloc app requires the following fields as input to the action.

Field   Name Meaning
lockGroupId Lock group ID The identifier mapping to one or more actual lock IDs
msn Phone number Phone number in E.164 format
start Start time When the key should valid from (ISO-8601 datetime)
end (optional) End time When the key should expire (ISO-8601 datetime). If neither the end nor the duration parameters are provided then the key will never expire.
duration (optional) Duration The duration in whole hours from the start date. Ignored if the end parameter is provided.

Revoking keys

Revoking keys requires the following fields.

Field   Name Meaning
lockGroupId Lock group ID The identifier mapping to one or more actual lock IDs
msn Phone number Phone number in E.164 format

Changing a Key

Keys are immutable. This means that if you need to change a key, then you first need to revoke it and then create a new key.