Skip to content

Feature Request: Include access identity in webhook payload for Keypad Touch unlock events #477

@yoootam-arch

Description

@yoootam-arch

Feature Request: Include Access Identity in Keypad Touch Webhook

Hi SwitchBot team,

I use the Keypad Touch together with the Lock Pro, integrated via the SwitchBot webhook API.

Current behavior

The Lock Pro sends a changeReport webhook on every unlock/lock event, but the payload only contains lockState and doorState — no information about how or by whom the lock was triggered:

```json
{
"eventType": "changeReport",
"context": {
"deviceType": "WoLockPro",
"lockState": "UNLOCKED",
"doorState": "CLOSED",
"timeOfSample": 1234567890
}
}
```

The Keypad Touch webhook section in this API documentation only covers createKey / deleteKey management events — there is no webhook triggered when a user actually uses the keypad to unlock the door.

What's missing

There is no way to know who triggered the unlock — fingerprint ID, passcode ID, NFC card ID, or access method. This information is clearly available in the SwitchBot app's access log, so it exists on your backend.

Feature request

Please add an unlock event webhook for the Keypad Touch, including the identity of who triggered it:

```json
{
"eventType": "changeReport",
"context": {
"deviceType": "WoKeypadTouch",
"deviceMac": "DEVICE_MAC",
"eventName": "unlockByKey",
"keyId": 10,
"keyName": "Family Member",
"triggerMethod": "fingerprint",
"timeOfSample": 1234567890
}
}
```

Use case

Developers integrating with Home Assistant, Node-RED, or other automation platforms need to distinguish who opened the door — not just that it was opened. Without identity information, meaningful automations (presence detection per person, guest mode, personalized scenes) are impossible via the API.

This would be a significant improvement for the developer community.

Thank you for considering this!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions