Integrating a Project with Webhooks

The Bright webhooks allow you to integrate with any third-party system you need and automatically send a .JSON file containing the scan information triggered by specific scan events. Using the webhooks will notify you about critical changes during the scanning process, with no need to manually check the results of multiple scans daily. You will also be able to detect a failed scan and fix it quickly.

Prerequisites

  • You will need a running Repeater for webhooks to work properly. To learn more about how to start a Repeater, see this article.

Creating a webhook

To create a webhook, follow these steps:

  1. In the left pane, select Projects.
  1. In the MY PROJECTS table, select the project for which you want to configure the webhook integration.
  2. In the upper-right corner of the project page, click to open the project settings, and then scroll down to the WEBHOOKS section.
  1. Click +Add webhook

  2. In the Details tab, fill in the Webhook name and specify a description, if needed.

    Currently, the Bright app provides the following webhook trigger actions:

    • Scan status changed - a scan status changed from any to any
    • Scan started
    • Scan completed - both successful and failed statuses are covered
  3. Open the Configuration tab and do the following:

    1. From the Repeater dropdown list, select a Repeater you want to use when sending a .JSON file to a preferred API endpoint.

    2. Select an HTTP method and enter the endpoint URL to which a .JSON file should be sent.

    3. Select a Header name from a drop-down list or type your own, and then provide a value in the Value field below.

  4. Click Create. The webhook is automatically activated and displayed in the Webhooks table on the Project settings page.

Deactivating a webhook

All created webhooks are available in the Webhooks table on the Project Settings page. Once a webhook is created, it is activated by default. You can temporarily disable notifications on a scan status change by deactivating the webhook.
To deactivate a webhook, follow these steps:

  1. On the Project settings page, scroll down to the Webhooks table.

  2. Click next to the webhook you want to deactivate, and then select Deactivate.

The webhook status will become “deactivated,” and the Deactivate option in the menu will change to Activate, so you can activate the webhook whenever required.

Editing a webhook

You can edit webhook details and configuration whenever you want. To edit a webhook, follow these steps:

  1. On the Project settings page, scroll down to the Webhooks table.

  2. Click next to the webhook you want to edit, and then select Edit.

  3. Make the required changes in the Edit webhook dialog box, and click Save.

Deleting a webhook

To delete a webhook, follow these steps:

  1. On the Project settings page, scroll down to the Webhooks table.

  2. Click next to the webhook you want to edit, and then select Delete.

  3. In the confirmation dialog box, click Yes to confirm the action.