The Bright webhooks allow you to integrate with any third-party system you need and automatically send a JSON payload containing the discovery/scan information triggered by specific events. Webhooks eliminate your need to manually check the results of multiple discoveries/scans daily.

Creating a webhook

To create a webhook, follow these steps:

1. Open the Projects page and choose the project which you want to manage. Click on Settings.

   

2. Navigate to the Webhooks tab and click on + Add Webhook.

   

3. Select the trigger you are interested at. Bright supports the following actions:

   1. Scan status changed - A scan status changed from any to any.

   2. Scan started - A scan has started.

   3. Scan completed - A scan was completed (successfully or unsuccessfully).

   4. Discovery status changed - A discovery status changed from any to any.

   5. Discovery started - A discovery has started.

   6. Discovery completed - A discovery was completed (successfully or unsuccessfully).

      

4. Open the Configuration tab and set the following:

   1. (Optional): From the Repeater dropdown list, select a Repeater you want to use when sending the JSON payload to the API endpoint.

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

   3. (Optional): Add headers if needed. Headers can be used for authorization as example.
      When adding a header, you need to provide a header Name (by selecting one from the dropdown or typing your own) and a Value.

      

5. Click Create.

Deactivating a webhook

Deactivating a webhook will suspend it from triggering and reacting to its action.
To deactivate a webhook, follow these steps:

1. Open the Projects page and choose the project which you want to manage. Click on Settings.
   

2. Navigate to the Webhooks tab.

   

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

4. The webhook status will become Deactivated.

   

Activating a webhook

Activating a webhook will resume it so it will react to its action.
To activate a webhook, follow these steps:

1. Open the Projects page and choose the project which you want to manage. Click on Settings.
   

2. Navigate to the Webhooks tab.
   

3. Click next to the webhook you want to deactivate, and then select Activate.

   

4. The webhook status will become Active.

   

Editing a webhook

You can edit webhook details and configuration without having to recreate it. To edit a webhook, follow these steps:

1. Open the Projects page and choose the project which you want to manage. Click on Settings.

   

2. Navigate to the Webhooks tab.

   

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

   

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

Deleting a webhook

To delete a webhook, follow these steps:

1. Open the Projects page and choose the project which you want to manage. Click on Settings.

   

2. Navigate to the Webhooks tab.

   

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

   

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