Skip to main content

Webhook Events and Payload

When you set up a webhook, you'll specify which events you want to be notified about. Whenever one of these events occurs, we will send an HTTP POST request to your webhook URL with a JSON payload containing details about the event.

Supported Webhook Events​

  • Scan Started: Triggered when a scan begins.
  • Scan Completed: Triggered when a scan finishes.
  • Scan Stopped: Triggered when a scan stopped.
  • Scan Failed: Triggered when a scan failed for some reason.
  • Report Generated: Triggered when a report file generated.

For a full list of events, refer to our webhook event documentation in the API reference.

Delivery Headers​

Each webhook delivery includes the following headers:

  • X-CG-Hook-Signature: A HMAC signature sha256 of the payload, using your webhook secret.
  • X-CG-Hook-Event: The name of the event that triggered the webhook (e.g., scan_started).
  • X-CG-Hook-Delivery: The ID (UUID) of the event.
  • Content-Type: application/json, indicating that the payload is JSON-formatted.
  • User-Agent: Should be CloneGuard-Hook/{a-random-hash}