Connecting Your Nexkey Account with Zapier

Connecting Your Nexkey Account with Zapier

Getting started

Automate your Nexkey workflows by connecting your account with Zapier! With Zapier, you can create automated workflows (“Zaps”) that trigger actions in Nexkey whenever something happens in another app — or vice versa.

Here's what you’ll need:
  1. An active Nexkey account
  2. Access to Zapier (free or paid account)
  3. Your Nexkey API Key

Selecting your trigger 

Start by logging into your Zapier account and creating a new zap. 

 


Select your trigger and action on the next page. 

 


Sign into the account for your trigger app. In our example, we’ll need to sign into Google Sheets. Click the Sign In button, then follow the prompts. 

 

Once you’re signed in, click Continue at the bottom of the window to move onto the Configure step. 


On the Configure step, you will need to point your zap to the trigger that you will use for the automation step. In our example, we’re pointing to our Nexkey Onboarding sheet and selecting the specific worksheet and column to point our zap to. Click Continue to move onto the Test step. 

 


The Test step is fairly simple – click Test trigger at the bottom and allow Zapier to work its magic. It will look for live data based on the location that you pointed the zap to. 

 


In our example, Zapier was able to find some records on our Google Sheet. You can click each of them to review the data it found for accuracy. Choose the best example for the zap, then click Continue with selected record to move onto the next step. 

 

 

Selecting your action step 

Under the Action step, start by clicking the dropdown menu under Action event and select the action you’re looking for. In our example, we will be sending a key. 

 


Next, click Select under the account field to select your Nexkey account. You will need to retrieve an API key from Nexkey support in order to authenticate past this step. Please refer to the section below called How to retrieve your Nexkey API key, then return here to continue. 


Click the Select button, then click Connect a new account to add your API info. 

 


A new window will appear asking you to fill in your API key and secret. Fill in the required fields, and keep the API version as is. Click “Yes, Continue to Nexkey (2.x.x) to return to your zap. 

 


Click Continue at the bottom of the configuration window to move onto the next step. 


You will need to fill in each field on the following screen in order to test the zap.
 
  1. Lock IDs: Add your Nexkey lock IDs here. They can be found in the app by going to KEYS > [Select your Nexkey device] > Settings > Lock ID.
    1. If you have multiple Nexkey devices, add them separately by pressing the ENTER key after typing them out one by one.
  2. Phone #’s: Click the (+) button to link the field to data from your trigger app.
    1. PLEASE NOTE: Phone number OR Email required. Entering both will result in an error.
  3. Emails: Click the (+) button to link the field to data from your trigger app.
    1. PLEASE NOTE: Phone number OR Email required. Entering both will result in an error.
  4. Start and End Date & Time: Click the (+) button to link the field to data from your trigger app.
  5. Target Role: Use 0 for the USER role and 1 for ADMINS.
  6. Key Type: The type of key to send.
    1. 0 = App Key (Default) - Unlock with the Nexkey Apps (iOS/Android)
    2. 1 = App Key + Text Key - Adds access via SMS (ONLY AVAILABLE FOR CONTROLLER)
  7. Disable Nexkey Welcome Messaging: Set to "true" if you would like to manage the invitation email or text message sent to the recipient. Nexkey will not send the default welcome email or text message if this is "true". 
Click Continue to move onto the Test step. 


Testing your zap 

On the next screen, click Test Step. Assuming the test worked successfully, you will see a message letting you know that your action was completed. Click the publish button and your zap will be live!   

       
 


How to retrieve your Nexkey API key 

You must contact Nexkey Support to obtain an API key for Zapier. Email support@nexkey.com or call 888-413-7093 and request “an API key for Zapier.” This is the only way to have an API key generated on your behalf.

Send an email to support@nexkey.com with the following information: 

  1. The name of your business 
  2. The app that you’d like to connect with Nexkey
  3. Your intended use case with connecting your app to Nexkey 

Nexkey Support will get back to you with your API key and secret which you can use to complete the connection.  Refer back to the “Selecting your action step” section once you’re ready.