Skip to main content

Setting up an integration with Webhook

Adding a new integration

To integrate Webhook with GravityZone Cloud Security, follow these steps:

  1. Click the Settings icon in the upper-right side of the console.

  2. Select Integrations

  3. Under the Notification Destinations section, click the Configuration button for the Webhook integration:

    The Webhook configuration panel is displayed.

    CSPM_Webhook_cp_545578_en_.PNG
  4. Click Configuration.

    The Webhook Integration page is displayed.

  5. Click Add a new integration.

  6. Fill in the required Webhook information:

    CSPM_Webhook_integration_details_cp_545578_en_.PNG
    • Webhook name - Type in a descriptive name for the integration.

    • Webhook URL - Enter the URL of the Webhook connection.

    • Description - Type in a description of the integration.

    • Payload - Enter the required payload for setting up the connection.

  7. Click the Test integration button to make sure all the information entered is valid.

  8. Click Save changes.

Prerequisites for integration with MS Teams

To obtain the URL, follow these steps:

  1. Log in to Microsoft Teams.

  2. Click the Teams icon on the right side of the window.

  3. (Optional) If you do not already have one, set up a communication channel for your team:

    1. Click the More options button for the target team.

    2. Select Add channel.

    3. Fill in the required details and click Create.

  4. Click the More options button for the channel you want to set up notifications for and select Manage channel.

  5. Click the Edit button under the Connectors section.

  6. Click the Configure button for the Incoming Webhook connector.

  7. Type in a descriptive name and click the Create button.

    A URL is provided. Copy it and store it somewhere safe. You will paste it in the Webhook URL field under the Webhook integration window.

To build the payload required for a Webhook integration, follow the steps below:

  1. Read the guide for creating a Webhook:

  2. Create the payload using one or more of these predefined variables:

    Variable

    Description

    Example

    cloud_provider

    The name of the cloud provider.

    AWS

    scan_group

    The name of the scan group in GravityZone.

    Production Group

    scan_account

    The name of the scan account in GravityZone.

    Mobile App Account

    cloud_account_id

    The id of the cloud account.

    308692709302

    company_name

    The name of your company in GravityZone.

    My Company

    url

    The URL of GravityZone Cloud Security overview page.

    https://app.cs.gravityzone.bitdefender.com/org/f9xaebf1-8cx4-418b-bx02-8x2dx48e1dbx

    scan_completed_at

    The timestamp of when the findings were discovered.

    2024-06-06T09:23:40.566528

    findings_overview.crit

    The total number of findings in the company with a Critical severity.

    Any integer value.

    findings_overview.high

    The total number of findings in the company with a High severity.

    Any integer value.

    findings_overview.med

    The total number of findings in the company with a Medium severity.

    Any integer value.

    findings_overview.low

    The total number of findings in the company with a Critical severity.

    Any integer value.

    findings_overview.info

    The total number of findings in the company with a Informational severity.

    Any integer value.

    findings_new.crit

    The total number of newly discovered Critical severity findings from the latest scan.

    Any integer value.

    findings_new.high

    The total number of newly discovered High severity findings from the latest scan.

    Any integer value.

    findings_new.med

    The total number of newly discovered Medium severity findings from the latest scan.

    Any integer value.

    findings_new.low

    Count of newly discovered Low severity findings from the latest scan

    Any integer value.

    findings_new.info

    The total number of newly discovered Informational severity findings from the latest scan.

    Any integer value.

  3. Copy it and store it somewhere safe. You will paste it under the Payload section under the Webhook integration window.

Editing a Webhook integration

  1. Click the Settings icon in the upper-right side of the console.

  2. Select Integrations

  3. Under the Notification Destinations section, click the Configuration button for the Webhook integration:

    The Webhook configuration panel is displayed.

    CSPM_Webhook_integration_edit_cp_545578_en_.PNG
  4. Click the Edit button.

    Note

    You can not edit an active integration. Remove them from all linked schedules first.

  5. Make the required notification.

  6. Click Save.

Deleting a Webhook integration

  1. Click the Settings icon in the upper-right side of the console.

  2. Select Integrations

  3. Under the Notification Destinations section, click the Configuration button for the Webhook integration:

    The Webhook configuration panel is displayed.

    CSPM_Webhook_integration_delete_cp_545578_en_.PNG
  4. Click the Delete button.

    Note

    You can not delete active integration. Remove them from all linked schedules first.