Get a list of Webhooks

Returns a list of Webhooks with options could be used to sort and filter them.

Query Parameters

locale string
Possible values: [en, es, ru, uk, pl, nl, tr, fr, da]
Default value: en
Language for localizing logs. Value by default is 'en'
- English (en)
- Spanish (es)
- French (fr)
- Danish (da)
- Dutch (nl)
- Ukrainian (uk)
- Turkish (tr)
- Polish (pl)
- Russian (ru)
limit integer
Possible values: [10, 20, 30, 50]
Number of items. Value by default is 10
page_number integer
Possible values: >= 1
Page number
sort_field string
Field name (JSON Key in item entity)
sort_type string
Possible values: [asc, desc]
Default value: asc
Sort type (asc/desc)
filter object
Filtering options for Apartment

Responses

application/json

Schema
Example (from schema)
Example

Schema

list_items object[]
List of Webhooks
list_options object
Available options for sorting, filtering and pagination of lists
pagination object
Available pagination options for tables
total_items integer
The total number of items found and reflected across all pages
items_limit integer
Possible values: [10, 20, 30, 50]
Limiting the display of the amount of data for one page
total_pages integer
The number of pages that hold the requested data
current_page integer
Possible values: >= 1
Current page number
filter object
Available filter sets for Webhhoks
anyOf
MOD1
MOD2
filter_field string
Field available for filtering
filter_type string
Possible values: [equal]
Available filtering type, only equal here
filter_format string
Data format, only string here
filter_value string
Filter value
sort object
Available sorting options for the selected table
field string
Sorting field name
asc boolean
Sort direction
available_fields undefined[]
Possible values: [url, created_at, updated_at]
Available for sorting fields names
locale object
This model describes available languages can be used to display logs
locale string
Possible values: [en, es, ru, uk, pl, nl, tr, fr, da]
This model describes available languages can be used to display logs in human readable format
available_locales string[]
Possible values: [en, es, ru, uk, pl, nl, tr, fr, da]
List of available locales

{
  "list_items": [
    {
      "url": "https://api.yourcompany.com/webhooks/1",
      "secret": "1234567890abcdef",
      "status": "active",
      "timeout": 10000,
      "headers": "{}",
      "description": "Webhook info",
      "event_types": [
        "log.access_granted_by_valid_identifier",
        "log.sip_registration_lost"
      ],
      "max_retries": 1,
      "created_at": 1540819272,
      "updated_at": 1540819272,
      "item_uid": 3
    }
  ],
  "list_options": {
    "pagination": {
      "total_items": 18,
      "items_limit": 10,
      "total_pages": 2,
      "current_page": 1
    },
    "filter": {
      "filter_field": "event_type",
      "filter_type": "equal",
      "filter_format": "string",
      "filter_value": "log.access_granted_by_api_call"
    },
    "sort": {
      "field": "updated_at",
      "asc": true,
      "available_fields": [
        "updated_at"
      ]
    },
    "locale": {
      "locale": "en",
      "available_locales": [
        "en"
      ]
    }
  }
}

{
  "list_option": {
    "locale": {
      "available_locales": [
        "pl",
        "uk",
        "en",
        "ru",
        "es",
        "nl",
        "tr",
        "fr",
        "da"
      ],
      "locale": "en"
    },
    "pagination": {
      "total_pages": 1,
      "items_limit": 10,
      "total_items": 2,
      "current_page": 1
    },
    "filter": {
      "filter_field": "event_type",
      "filter_type": "equal",
      "filter_format": "string",
      "filter_value": "access_granted_by_api_call",
      "available_filtering": true,
      "available_fields": [
        "url",
        "event_type"
      ],
      "is_filtered": true,
      "available_values": {
        "event_type": [
          {
            "text": "SIP registration lost",
            "key": "log.sip_registration_lost"
          },
          {
            "text": "Unknown identifier",
            "key": "log.access_denied_by_unknown_card"
          },
          {
            "text": "Wrong input code",
            "key": "log.access_denied_by_not_valid_input_code"
          },
          {
            "text": "Access granted by remote server",
            "key": "log.access_granted_by_remote_server_api_call"
          },
          {
            "text": "Missed outgoing call",
            "key": "log.outgoing_call_missed"
          },
          {
            "text": "Door is not closed too long",
            "key": "log.door_was_not_closed_too_long"
          },
          {
            "text": "Unknown QR code",
            "key": "log.access_denied_by_unknown_qr"
          },
          {
            "text": "Lock opened by response device",
            "key": "log.access_granted_by_call_host"
          },
          {
            "text": "Door was closed",
            "key": "log.door_was_closed"
          },
          {
            "text": "Lock opened by free access button",
            "key": "log.lock_was_opened_by_free_access_button"
          },
          {
            "text": "Outgoing call",
            "key": "log.outgoing_call"
          },
          {
            "text": "Device booted",
            "key": "log.device_booted"
          },
          {
            "text": "Failed login attempt to the GUI settings",
            "key": "log.incorrect_login_gui_settings"
          },
          {
            "text": "Entered to GUI settings",
            "key": "log.successful_login_gui_settings"
          },
          {
            "text": "Tamper triggered",
            "key": "log.tamper_event"
          },
          {
            "text": "Incoming call",
            "key": "log.incoming_call"
          },
          {
            "text": "Door was opened",
            "key": "log.door_was_opened"
          },
          {
            "text": "Access denied by remote server",
            "key": "log.access_denied_by_remote_server_api_call"
          },
          {
            "text": "Door sensor opened",
            "key": "log.door_sensor_was_opened"
          },
          {
            "text": "Not valid face identifier",
            "key": "log.access_denied_by_not_valid_face_identifier"
          },
          {
            "text": "Failed login attempt to the web interface",
            "key": "log.incorrect_login_api_call"
          },
          {
            "text": "Not valid identifier",
            "key": "log.access_denied_by_not_valid_identifier"
          },
          {
            "text": "Access granted",
            "key": "log.access_granted_by_api_call"
          },
          {
            "text": "Lock opened by identifier",
            "key": "log.access_granted_by_valid_identifier"
          },
          {
            "text": "The lock is open on alarm",
            "key": "log.emergency_lock_is_opened"
          },
          {
            "text": "Lock opened by exit button",
            "key": "log.lock_was_opened_by_exit_btn"
          },
          {
            "text": "General access code entered",
            "key": "log.access_granted_by_master_code"
          },
          {
            "text": "Door sensor closed",
            "key": "log.door_sensor_was_closed"
          },
          {
            "text": "Login to the web interface",
            "key": "log.successful_login_api_call"
          },
          {
            "text": "Outgoing call from web",
            "key": "log.outgoing_call_web"
          },
          {
            "text": "Access denied by unknown identifier",
            "key": "log.access_denied_unknown_identifier"
          },
          {
            "text": "Successful lift call",
            "key": "log.lift_call_success"
          },
          {
            "text": "Failed to call the lift",
            "key": "log.lift_call_error"
          },
          {
            "text": "Cannot access lift module",
            "key": "log.lift_module_access_error"
          },
          {
            "text": "Lift request",
            "key": "log.bond_lift_request"
          }
        ]
      }
    },
    "sort": {
      "asc": true,
      "field": "name",
      "available_fields": [
        "url",
        "created_at",
        "updated_at"
      ]
    }
  },
  "list_items": [
    {
      "item_uid": 1,
      "url": "https://api.yourcompany.com/webhooks/1",
      "secret": "1234567890abcdef",
      "status": "active",
      "timeout": 10000,
      "headers": "{}",
      "description": "Webhook info",
      "event_types": [
        "log.access_granted_by_api_call"
      ],
      "max_retries": 5,
      "created_at": 1745947873611,
      "updated_at": 1745947873611
    }
  ]
}

Base errors for all entities

Wrong pagination limit
Wrong page number
Wrong filter type
Wrong filter field
Wrong filter format
Wrong filter value
Wrong sort type
Errors appeared only in log entities:
Wrong time format
Wrong time range: 'to' must be greater then 'from'
Errors appeared in other entities:
Wrong sort field

application/json

Schema

error string
Error message

{
  "error": "Administrator rights required"
}

{
  "error": "Wrong pagination limit"
}

{
  "error": "Wrong page number"
}

{
  "error": "Wrong sort type"
}

{
  "error": "Wrong sort field"
}

{
  "error": "Wrong filter type"
}

{
  "error": "Wrong filter field"
}

{
  "error": "Wrong filter value"
}

{
  "error": "Wrong filter format"
}

{
  "error": "Wrong time format"
}

{
  "error": "Wrong time range: 'to' must be greater then 'from'"
}

Unauthorized request. Log In

application/json

Schema
Example (from schema)
Log In

Schema

error string
Error message

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Administrator rights required. You are currently logged in with different user account. Log In with administrator rights

application/json

Schema
Example (from schema)
Admin Rights Required

Schema

error string
Error message

{
  "error": "Administrator rights required"
}

{
  "error": "Administrator rights required"
}

Get a list of Webhooks​

Get a list of Webhooks