Installing the Staykey Home Assistant Plugin

Installing the Staykey Home Assistant Plugin

The Staykey plugin for Home Assistant captures lock activity events (like keypad code entries) and sends them to your Staykey account. This gives you visibility into which access codes were used and when.

What the plugin does

• Listens for Z-Wave lock events (keypad unlocks, manual lock/unlock operations)
• Forwards event data to Staykey via a secure webhook
• Enables activity logging in your Staykey dashboard

Requirements

• Home Assistant 2024.6 or newer
• Z-Wave JS integration configured with your lock(s)
• Your Staykey Webhook URL (found in Staykey under your property's integration settings)

Part 1: Install HACS

HACS (Home Assistant Community Store) is required to install the Staykey plugin. If you already have HACS installed, skip to Part 2.

Step 1: Download HACS

1. In Home Assistant, go to Settings → Add-ons → Add-on Store
2. Search for Terminal & SSH and install it
3. Start the add-on and open the terminal
4. Run this command to download HACS:

wget -O - https://get.hacs.xyz | bash -

5. Wait for the script to complete

Step 2: Add the HACS integration

1. Restart Home Assistant (Settings → System → Restart)
2. After restart, go to Settings → Devices & Services
3. Click Add Integration and search for HACS
4. Follow the setup wizard:
   • You'll need to authorize HACS with your GitHub account
   • Accept the terms and conditions
5. Once complete, HACS appears in your sidebar

Part 2: Install the Staykey plugin

Step 1: Add the Staykey repository

1. Open HACS from your Home Assistant sidebar
2. Click Integrations
3. Click the menu icon (⋮) in the top right
4. Select Custom repositories
5. Enter the repository URL:

   https://github.com/staykey/staykey-ha-plugin
   

6. Select Integration as the category
7. Click Add

Step 2: Install the integration

1. In HACS Integrations, search for StayKey
2. Click on it and then click Download
3. Confirm the download
4. Restart Home Assistant (Settings → System → Restart)

Step 3: Configure the integration

1. After restart, go to Settings → Devices & Services
2. Click Add Integration and search for StayKey
3. Enter your Staykey Webhook URL:
   • Find this in Staykey under Properties → [Your Property] → Integrations → Home Assistant
   • Copy the webhook URL provided
4. Click Submit

What data is sent?

When a supported lock event occurs, the plugin sends:

• Event type: Keypad unlock, manual lock/unlock
• Device info: Lock name, manufacturer, model
• Access details: Which code slot was used (for keypad events)
• Timestamp: When the event occurred

No personal data or full access codes are transmitted—just the code slot number.

Supported events

The plugin forwards these Z-Wave lock events:

• Manual lock operation
• Manual unlock operation
• Keypad unlock operation

Updating your Webhook URL

If you need to change the webhook URL after setup:

1. Go to Settings → Devices & Services
2. Find StayKey and click Configure
3. Enter the new webhook URL
4. Click Submit

Troubleshooting

Plugin not appearing after install:

• Ensure you restarted Home Assistant after installing via HACS
• Check that the integration was downloaded successfully in HACS

Events not showing in Staykey:

• Verify the webhook URL is correct (copy it fresh from Staykey)
• Check that your lock is using Z-Wave JS integration (not the older Z-Wave integration)
• Look at Home Assistant logs: Settings → System → Logs and search for "StayKey"

"Invalid webhook URL" error:

• Make sure you're using the webhook URL from your property's integration settings, not a generic URL

Checking logs

To see plugin activity and troubleshoot issues:

1. Go to Settings → System → Logs
2. Search for "StayKey"
3. Look for entries showing events being sent or any errors

Source code

The Staykey plugin is open source and available on GitHub: github.com/staykey/staykey-ha-plugin