Keypad & Keypad Touch new webhook messages

AdyRock commented 2 years ago

Current Situation

Currently there are no notifications about the keypad usage so we can't log who is using it and if there are hacking attempts.

Proposed Change

Create a webhook for keypad usage that includes the name of the password / fingerprint / card that was used (the name recorded when adding the code, etc), and the method such as password, fingerprint or card. If the method was not recognised then send something like Unknown for the name.

{
    "eventType": "usageReport",
    "eventVersion": "1",
    "context": {
        "deviceType": "WoKeypad",
        "deviceMac": DEVICE_MAC_ADDR,
        "eventName": "usedKey",
        "commandId": "CMD-1663558451952-01",
        "name": "pascodeName",
        "type": "password",
        "result": "success",
        "timeOfSample": 123456789
    }
}

Additional Context

Providing this information would allow further automations based on who has unlocked the door or for notifications to be sent out if the operator is unknown which could be an opportunist trying their luck.

AdyRock commented 2 years ago

Any idea if this would be possible?

asknoone commented 1 year ago

I too am looking for this functionality because you can then:

Log who actually unlocked the door for security purposes (it's available in the app)
Use the information to trigger automations specific to the person opening the front door. e.g. different actions for house owners versus a cleaner entering your property

jeremyarnoux commented 1 year ago

Je valide.... ainsi que le remote, rien dans les webhooks, donc inutilisable :-/

franden commented 1 year ago

@Minsheng is it planned to enhance Keypad & Keypad Touch requested webhooks like suggested by @AdyRock?? If yes, when we can expect the GA of this APIs?

koshisan commented 1 year ago

Wow, nearly a year with no feedback at all - this would be so useful since you could trigger automations based on who unlocked the door...

Marosso commented 1 year ago

I also find this very helpful. Please consider this feature.

PrzemekLipka commented 11 months ago

For me it is a critical feature. It is complete non-sense when this keypad device is "talking" only with a lock.

lukes-ha commented 11 months ago

it would be a huge advantages, and wouldn't be a security impact I think

frean087 commented 10 months ago

Please add this feature. And please also include it into scenarios, then you could for instance open the garage door when the lock is opened (my case).

frean087 commented 7 months ago

One quarter later, Please consider this since sales for these keypads and locks would increase significantly if this request was implemented. There is a lot of scenarios where it can be used and the hardware is great!

vishwajit76 commented 6 months ago

Hi,

Keypad Touch Lock.

I need following feature in API

List of Passcode, Fingerprint, NFC Cards
Enable/Disable Lock Button
Enable/Disable Keypad

I need following event in webhooks.

Unlock (Passcode + Fingerprint + NFC) - with type and its id
Locked (Auto + Manually)
Keypad Removal Alerts

We need API and Webhook for security purpose and making attendance system using this device.

We are making fully automated office using SwitchBot Devices, only above mentioned API + Webhook are missing.

Please update your API and Webhook.

Thanks.

ThatProgrammerr commented 2 months ago

I am also quite interested in the functionality of knowing what method was used to unlock the lock. I made a similar issue (https://github.com/OpenWonderLabs/SwitchBotAPI/issues/338) regarding adding an 'unlockMethod' value to the webhook of locks, but I do agree adding this to keypads would also be a valid way of doing it.

glenmich commented 1 month ago

still no news? @SwitchBot-Wonderlabs @Minsheng @donavanbecker :´(

I (and many other) would really like to use the unlock finger ID, Code-ID or key card to trigger automations in Home Assistant... :(

OpenWonderLabs / SwitchBotAPI