Webhooks

Usage

Generic webhooks allow you to trigger a scan when something happens on third-party service or as part of your deployment process.

For example, you might configure your deployment script to call the webhook URL after a new version of your site is deployed so that it can be immediately checked for accessibility issues.

Configuring Generic Webhooks

  1. Either click on the integrations link from your dashboard and choose a site, or click the integrations link from the site’s menu.
  2. Click the “Add Integration” link.
  3. Click the “Add Generic Webhook” link.
  4. If you’d like a delay between the time the webhook is sent and the scan is started, choose from the form.
  5. Copy the webhook URL.
  6. Click Add.

The webhook is now configured to be used, and can be added to your third party service. A scan will be started whenever the service or script sends a POST or GET request to the URL.

If you need to see the webhook URL again, visit the configuration page for the integration. From here, a new URL can be regenerated if needed.

To remove the webhook permanently, click the “Remove” button from the configuration page. Note that a new unique URL will be generated if the webhook is re-added in the future.

To temporarily disable the webhook, toggle “Enable Integration” at the top of the configuration page and click “Update”. When the webhook is re-enabled, the original URL will remain valid.

Important notes:

  1. If a scan is already in progress when an incoming webhook is received, it will be ignored.
  2. Requests to an individual site’s webhook are throttled to one every five minutes. More than one call to the webhook within a five minute period will be ignored.