Skip to main content

Create Webhook Entity​

Creates Webhook Entity. The item_uid value returned in the response can be used as the webhook-uid parameter in next requests:

  • GET/PUT/DELETE /webhooks/{webhook-uid} to get detailed webhook information, edit or remove it
  • POST /webhooks/{webhook-uid}/test to run test webhook request. Additional headers that can be included to request in JSON format.
Request Body required
  • url string required

    Possible values: >= 4 characters and <= 2000 characters

    Webhook server address

  • secret string

    Possible values: >= 16 characters and <= 128 characters

    Secret key used to sign payload using HMAC (Hash-based Message Authentication Code, SHA256).

  • status string required

    Possible values: [active, disabled]

    Webhook actiovation status

  • timeout int32

    Possible values: >= 1000 and <= 30000

    Request connection, read and write timeount in milliseconds used in HTTP client

  • headers string

    Additional headers that can be included to request in JSON format. According to RFC 7230, header names are tokens consisting of ASCII letters, digits, and specific symbols (Regex ^[a-zA-Z0-9!#$%&'+-.^_`|~]+$). Header value regex excludes extended ASCII (Regex ^[\x09\x20-\x7E]$). Also system headers cannot be overridden ("host", "connection", "keep-alive", "transfer-encoding", "upgrade", "via", "te", "trailer", "content-length", "content-type", "authorization", "origin", "permissions-policy", "user-agent", "accept", "accept-encoding", "accept-language", "x-forwarded-for", "x-forwarded-host", "x-forwarded-proto", "x-real-ip", "forwarded", "date", "expires", "last-modified", "cache-control", "etag", "if-match", "if-none-match", "access-control-allow-origin", "access-control-allow-methods", "access-control-allow-headers", "access-control-expose-headers")

  • description string

    Possible values: <= 1000 characters

    Webhook additional information

  • event_types string[] required

    Possible values: [log.access_denied_by_not_valid_identifier, log.access_denied_by_not_valid_face_identifier, log.access_denied_by_not_valid_input_code, log.access_denied_by_remote_server_api_call, log.access_denied_by_unknown_card, log.access_granted_by_api_call, log.access_granted_by_call_host, log.access_granted_by_master_code, log.access_granted_by_remote_server_api_call, log.access_granted_by_valid_identifier, log.door_was_closed, log.door_sensor_was_closed, log.door_was_opened, log.door_sensor_was_opened, log.emergency_lock_is_opened, log.lock_is_opened_to_long, log.lock_was_opened_by_exit_btn, log.lock_was_opened_by_free_access_button, log.incoming_call, log.outgoing_call, log.outgoing_call_missed, log.device_booted, log.sip_registration_lost, log.outgoing_call_web, log.incorrect_login_api_call, log.incorrect_login_gui_settings, log.successful_login_api_call, log.successful_login_gui_settings, log.door_was_not_closed_too_long, log.tamper_event, log.multi_access_granted, log.identifiers_without_linkage_to_user_access_denied, log.multi_access_denied, log.access_denied_by_unknown_qr, log.access_denied_unknown_identifier, log.lift_call_success, log.lift_call_error, log.lift_module_access_error, log.access_granted_by_shared_identifier, log.access_denied_by_not_valid_shared_identifier, log.bond_lift_request]

    Describes trigger events this webhook subscribes to

  • max_retries int32 required

    Possible values: <= 5

    Maximum number of retries after first Webhook delivery error

Responses

OK

Schema
  • item_uid integer

    Possible values: >= -1

    UID for entities references. If value is -1, then it means that is no entity reference for this structure

Loading...