Skip to main content Link Menu Expand (external link) Document Search Copy Copied
Documentation

Integrations

It is possible to send Cyberwatch data to a third party system using Integrations.

Creation of Integration

  1. Click on Administration
  2. Click on Integrations
  3. Click on Add

  4. Complete the fields of the integration creation form:

    • Integration protocol: Protocol of the integration, available protocols are:
      • HTTP hook to send HTTP rest requests
      • SMTP hook to send emails using SMTP configured in Administration > SMTP
    • Name of the integration: Integration name that will be displayed in the integration choice lists
    • Location of the integration hook: Location where it will be possible to find the integration. The available locations are:
      • Inventory: corresponds to the Inventory.
      • Server details - Detection: corresponds to a server page on the “Vulnerabilities” tab.
      • Server details - Patching: corresponds to a server page on the “Patch management” tab.
      • Vulnerability details: corresponds to a specific vulnerability page in the Vulnerability Encyclopedia.

  5. For HTTP hook integrations:

    • URL of the request: URL to which the data will be sent.

    • Headers of the request: Headers of the request in the form of a dictionary, example:

          {
        "Accept-Charset": "utf-8",
        "Accept-Encoding": "gzip",
        "Authorization": "Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==",
        "Content-Type": "application/json",
        "User-Agent": "Mozilla/5.0 (X11; Linux x86_64; rv:12.0) Gecko/20100101 Firefox/12.0"
    }
    • Body of the request: Body of the request containing the data to send. Keywords are used to add the selected data to Cyberwatch:
      • #SERVER_NAME#: Name of the selected server.
      • #SERVER_NAMES#: Name of selected servers.
      • #CVE_ANNOUNCEMENT#: CVE code of the selected CVE.
      • #CVE_ANNOUNCEMENTS#: CVE codes of selected CVEs.
      • #PRODUCT#: Name of the selected package/application.
      • #PRODUCTS#: Name of selected packages/applications.
    • HTTP method of the request: Choice of the HTTP method with which the request will be sent.
    • Use a self-signed certificate for this request: Used to connect to a self-signed server. Warning: Connecting to a self-signed server poses a risk that a third party can intercept traffic to the server via this certificate.
    • Use the proxy configuration for this request: Allows to use the proxy configured in Cyberwatch.

  6. For SMTP hook integrations:

    • Recipient’s email address.
    • Subject of the email.
    • Content of the email: The message containing the data to send. Available keywords are the same as the one described in Body of the request for HTTP hook integrations.
  7. Save

If the fields have been correctly filled in, the integration will appear in the list of integrations.

Edit an Integration

  1. Click on Administration
  2. Click on Integrations
  3. Click on the edit button (pencil icon) corresponding to the integration to edit
  4. Modify the desired fields in the form. The fields are completed with the values of the edited integration
  5. Save

Delete an Integration

  1. Click on Administration
  2. Click on Integrations
  3. Click on the delete button (trash icon) corresponding to the integration to delete
  4. Confirm

Test an Integration

  1. Click on Administration
  2. Click on Integrations
  3. Click on the test button (arrow icon) corresponding to the integration to test
  4. Check that a modal containing the state of the response appears, attesting to the connection with the server.

Use an Integration

The integrations can be used at different locations depending on the choice made in the creation/edition form:

Inventory

  1. Click on Inventory
  2. Select the assets to send
  3. Click on the button Bulk actions
  4. Click on the name of the integration in the drop-down menu
  5. Check the status of the response in the modal at the top right

Server details - Detection

  1. Click on Inventory
  2. Click on the name of the asset from which send the data
  3. Click on the Vulnerabilities tab
  4. Select the vulnerabilities to send
  5. Click on the arrow to the right of the Ignore and comment button
  6. Click on the name of the integration in the drop-down menu
  7. Check the status of the response in the modal at the top right

Server details - Patching

  1. Click on Inventory
  2. Click on the name of the asset from which send the data
  3. Click on the Patch management tab
  4. Select the packages/applications/vulnerabilities to send
  5. Click on the arrow to the right of the Schedule selected fixes button (or the Send the selection button in case of an asset on “scan only” mode)
  6. Click on the name of the integration in the drop-down menu
  7. Check the status of the response in the modal at the top right

Vulnerability details

  1. Click on Vulnerability Encyclopedia
  2. Click on a CVE reference to access the details of this CVE
  3. Select the assets to send
  4. Click on the arrow to the right of the Ignore and comment button
  5. Click on the name of the integration in the drop-down menu
  6. Check the status of the response in the modal at the top right