Skip to content
API Documentation

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.

Certain Advanced API endpoints deliver a synchronous request ID in the response. These API endpoints are:

Here is an example of such a response body:

{
    "requestId": "68c4242a..........fede8a"
}

When the action behind your request to one of the aforementioned endpoints has been executed, a webhook will be sent to your webhook server. As the trigger for this webhook is the API call you previously sent, we term these “API Triggered Webhooks”.

This webhook will contain data regarding your request, as well as whether the operation was successful. Here is an example using the advanced unlock endpoint:

{
    "type": "UnlockAction",
    "requestId": "68c4242a..........fede8a",
    "smartlockId": 123456789,
    "success": true
}

If the operation was not successful, an accompanying error code will be returned.

{
    "detail": [
        {
            "smartlockId": 123456789,
            "success": false,
            "errorCode": "ff",
            "id": "68b142..........a584f104"
        }
    ],
    "type": "AuthCreation",
    "requestId": "68b142..........a584f103",
    "success": false
}