Web events

KleverKey supports sending events to webhooks. Configure webhooks.

  • Lock

    • Property Data Type Description
      User User
      Device Device
      LockActivationLink LockActivationLink
      PermissionLockName String [optional]
      ActivityTime DateTime Activity time in lock timezone in ISO 8601 format
      ActivityTimeUtc DateTime Activity time in UTC in ISO 8601 format
      ActivityStatus LockActivityStatus [Enum] Successful = 1, Unsuccessful = 2
      ActivityType LockActivityType [Enum] OpenClose = 1, Open = 3, Close = 4
      Lock Lock

      Example JSON
      {
        "apiVersion": 1,
        "id": 1,
        "eventType": 3,
        "data": {
          "user": {
            "id": 1,
            "organizationId": 1,
            "organizationIds": [
              1
            ],
            "email": "john.doe@kleverkey.com",
            "firstName": "John",
            "lastName": "Doe",
            "displayName": "John Doe <john.doe@kleverkey.com>",
            "type": 0
          },
          "device": {
            "id": 1,
            "deviceHexId": "0102030405060708",
            "type": 2,
            "status": 3,
            "name": "John Doe's Smartphone",
            "manufacturer": "LG",
            "model": "G6",
            "operatingSystem": 0,
            "displayName": "LG G6 (John Doe's Smartphone)",
            "isSynced": false
          },
          "lockActivationLink": {
            "id": 1,
            "receiverName": "John Doe",
            "receiverEmailOrPhoneNumber": "john.doe@kleverkey.com",
            "permissionType": 0,
            "dateCreated": "0001-01-01T00:00:00"
          },
          "activityTime": "2024-07-21T18:58:01",
          "activityTimeUtc": "2024-07-21T18:58:01Z",
          "activityStatus": 1,
          "activityType": 1,
          "lock": {
            "id": 1,
            "lockHexId": "0102030405060708",
            "organizationId": 1,
            "name": "KleverKey Lock",
            "imageId": 0,
            "type": 0,
            "properties": 0,
            "wirelessModes": 0,
            "bleInterfaceVersion": 0,
            "openCloseWaitTime": 0,
            "state": 0,
            "keyVersion": 0,
            "firmwareVersion": 0,
            "firmwareUpdateState": 0,
            "displayName": "KleverKey Lock (0102030405060708)",
            "hasLocationData": false,
            "smartCardAuthentication": 0,
            "hardwareConfigurationOutside": 0,
            "hardwareConfigurationSelfLockingPanicLock": false
          }
        },
        "dateCreated": "2024-07-21T18:58:01.6240721Z",
        "dateRaised": "2024-07-21T18:58:01.6240723Z"
      }