Skip to content

Webhooks ​

Webhooks let your virtual site call an HTTPS receiver of yours whenever a log event you selected happens: a sign in refused, a file uploaded, a user created, a certificate about to expire. Each delivery is signed JSON with retries; the contract, the envelope and the receiver rules are described in Webhooks in the Automation and AI agents chapter.

The page needs the Webhooks permission, which is separate from Events on purpose: an event handler editor cannot export log records. Creating and changing webhooks needs a Professional or Ultimate license; listing, testing and deleting stay available when the license is downgraded, so you can clean up.

Webhook list ​

The list shows the site's webhooks with their name, receiver URL, an enabled switch, what they subscribe to, and when a delivery last succeeded on this node. The actions are Edit, Deliveries, Test and Delete.

Test sends a WebhookTest event (9072) to that webhook once, exactly as a real delivery, and shows the receiver's answer and the latency. Use it right after creating a webhook and after every change of the receiver.

Deliveries opens the node's account of the webhook: counters per process (delivered, failed, dropped, last delivered, last failure) and the most recent failures with their status, error and number of attempts. Every node keeps its own account, so in a cluster look at each node's console.

Create or edit a webhook ​

The drawer asks for:

  • Name (required) and an optional description.
  • Enabled. A disabled webhook keeps its settings and delivers nothing.
  • Receiver URL (required), an absolute HTTPS URL. Plain HTTP and private addresses depend on the policy the SuperAdmin set; loopback is never allowed.
  • Secret (required on creation). It signs every delivery and is never shown again; leave the field as it is when editing to keep the stored secret, or type a new one to replace it.
  • Authorization header, optional: sent verbatim with every delivery, for a receiver that wants a bearer token or a basic credential of its own.
  • Events: pick single events, or whole blocks. A block covers every event in it, including the ones a later release adds. At least one event or block is required. The picker searches by name, number and description.
  • Minimum level: records below it are not delivered even when their event is selected.
  • Advanced: the per attempt timeout in seconds, the retries after a retryable failure, the queue size (records waiting for delivery on each node; the newest are dropped when it is full), and whether this webhook may target a private address (the policy must allow it too).

Validation issues are shown next to the field they concern. The change is effective on every node within seconds.