Skip to content

Webhooks

Webhooks

Use the Webhooks page to configure outbound HTTP callbacks that notify external systems when selected Lockfy events occur. This page is useful for integrations with automation platforms, monitoring systems, ticketing workflows, or custom APIs.

If your integration expects syslog rather than HTTP callbacks, see Syslog.

The main list shows the configured webhooks and includes the following columns:

  • Name: The display name of the webhook.
  • Description: A short explanation of what the webhook is used for.

Each row can be expanded to show detailed logs for that webhook. The page header also includes the following quick actions:

  • add Open the form to create a new webhook.
  • download Export the current data set.
  • sync Refresh the list.

Each webhook row also includes a toggle next to it so that specific webhook can be enabled or disabled without changing the others.

Expanding a webhook shows two tabs:

  • Execution Logs
  • Authentication Logs

Both tabs use the same table structure.

The log table includes:

  • Start: When the request or authentication operation started.
  • End: When it completed.
  • Duration: The total processing time.
  • Response Code: The HTTP status or returned result code.
  • Response Content: The returned body or response details.

Each log tab also includes the following status filters:

  • All
  • Failed
  • Successful

Use Execution Logs to review actual webhook delivery attempts, and use Authentication Logs to review the authentication requests made on behalf of the webhook when an authenticated mode is configured.

New Webhook

Selecting the add action opens the New Webhook sidebar.

The form shown includes the following base fields:

  • Name
  • Description
  • HTTP Method
  • Webhook Url
  • Webhook Trigger
  • Authentication Mode

Select Create after completing the form.

The supported HTTP methods are:

  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

Choose the method expected by the receiving system.

The Webhook Trigger field can be set to any of the following event types:

  • Session Locked
  • Session Unlocked
  • Session Idled
  • Sessions Activated
  • Session Started
  • Session Ended
  • Workstation Connected
  • Workstation Disconnected
  • Notifiable Device Updated
  • Notifiable Device Removed
  • Workstation Compliance Status Changed

Choose the trigger that matches the event your external system needs to receive.

The Authentication Mode field supports the following options:

  • None
  • Basic
  • OAuth Resource Owner Password
  • OAuth Client Credentials
  • API Key

Each mode requires a different set of fields.

Use None when the destination endpoint does not require authentication.

Basic authentication requires:

  • Username
  • Password

OAuth Resource Owner Password requires:

  • Token Url
  • Username
  • Password
  • Client Id
  • Client Secret
  • Scope

OAuth Client Credentials requires:

  • Token Url
  • Client Id
  • Client Secret
  • Scope

API Key authentication requires:

  • API Key Header Name
  • API Key

Use webhooks when Lockfy events need to trigger downstream actions in another system. After configuring a webhook, expand its row and review the log tabs to confirm that both authentication and event delivery are succeeding.