Skip to main content

About Webhooks

A webhook is an automated message sent from our application to a URL of your choosing when specific events occur, such as when a scan completes or started. These messages contain detailed information about the event in the form of a JSON payload.

Webhooks provide an efficient way to receive updates without the need for constant polling of our API.

Choosing Webhooks or the REST API​

  • Webhooks: Best for receiving real-time notifications when events happen, allowing your system to react instantly.
  • REST API: Ideal for retrieving data on demand. You can use the API to query or manipulate data at your convenience.

When to use Webhooks​

If your system needs to respond immediately to events, such as triggering workflows or notifying users.

When to use the REST API​

If you need to periodically pull data or make requests for specific information on-demand.