Overview

Note

To use webhooks, you must have access to the Advanced API.

The Nuki REST API is asynchronous, therefore webhooks offer a method to be informed when requests have been executed. We term these “API Triggered Webhooks”.

In addition to those webhooks, it may be beneficial to be informed when certain events occur, such as when a person unlocked a door. We term these “Device Triggered Webhooks”.

Caution

Your webhook server must return a 200, 202 or 204 response to the webhooks we send. We consider a webhook to have failed if one of the aforementioned status codes is not received. See Webhook Limits for more information.

API Triggered Webhooks

API triggered webhooks are asynchronous reponses to your API calls. As our REST API is asynchronous, this provides us with a way of informing you whether your actions were successfully executed or not.

Device Triggered Webhooks

Device triggered webhooks allow us to inform you of any changes to your device. That means when a particular action is performed, such as the authorisations on your smart lock were changed, or somebody unlocked the door, we can send you an update.