Skip to main content

Integrating Invicti Standard with Webhooks

This document is for:
Invicti Standard

Invicti Standard allows you to integrate with many issue tracking systems using its Send To Actions feature. However, there are some applications for which Invicti Standard does not currently offer integration. Instead, Invicti Standard offers webhook integration for applications that support incoming webhooks.

Webhooks are not applications, but they provide a way for an application to get data from other applications with real-time information. This integration enables you to automatically export reported vulnerabilities to external systems for streamlined issue tracking and remediation workflows.

This document provides comprehensive guidance on configuring webhook integrations in Invicti Standard, including field explanations, setup procedures, and vulnerability export processes.

Webhook Fields

The following table lists and explains the webhook fields available in the Send To Actions configuration:

Button/Section/FieldDescription
AddClick to add an integration.
DeleteClick to delete the integration and clear all fields.
Create Sample IssueOnce all relevant fields have been configured, click to create a sample issue.
ActionThis section contains general fields about the Send to Action.
Display NameThis is the name of the configuration that will be shown in menus.
MandatoryThis section contains fields that must be completed.
HTTP MethodThis is the HTTP method. The method can be:
  • GET
  • POST
  • PUT
Parameter TypeThis is the data format to be sent. The parameter type can be:
  • Form
  • Json
  • Xml
  • QueryString
If the HTTP Method is POST or PUT, then this field must be completed.
URLThis is the webhook URL to which issues are sent.
VulnerabilityThis section contains fields with vulnerability details.
Body TemplateThis is the template file to be used while rendering issue contents.
Title FormatThis is the string to be used while formatting the vulnerability title.
OptionalThis section contains optional fields.
Issue ParameterThis is the parameter name of the issue.
Title ParameterThis is the parameter name of the issue title.
Body ParameterThis is the parameter name of the issue body.
Custom FieldsClick the ellipsis to open the Custom Fields Editor dialog.
UsernameThis is the username for the HTTP authentication. The Username and Password fields are used for Basic Authorization. If the application doesn't require authorization, leave them empty.
PasswordThis is the password for the HTTP authentication.
HTTP HeadersThis is the HTTP Headers to be added to the HTTP request.

How to Integrate Invicti Standard with Webhooks

Follow these steps to configure webhook integration for automated vulnerability export:

  1. Open Invicti Standard
  2. From the Home tab, click Options. The Options dialog is displayed
  3. Click Send To Actions
Invicti Standard Options dialog showing Send To Actions menu selection
  1. From the Add dropdown, select Webhook. The Webhook fields are displayed
Add dropdown menu showing Webhook option selection for integration configuration
  1. In the Mandatory section, complete the connection details:

    • HTTP Method
    • Payload Type
    • URL
  2. In the Vulnerability section you can change the Body Template and Title Format

Template Location

Body templates are stored in %userprofile%\Documents\Invicti\Resources\Send To Templates. If you use your own custom templates, store them in this location.

  1. In the Optional settings you can specify:

    Issue Parameter

    This parameter is required when XML body is used. If this field is set a name IssueParameterName, the XML body will be as shown:

    <IssueParameterName>
    <Title></Title>
    <Body></Body>
    </IssueParameterName>

    If the JSON body is used, it will be as shown:

    {
    "IssueParameterName": {
    "title": "",
    "body": ""
    }
    }

    Title Parameter

    Some applications may use subject or summary for titles. This value is used to change the parameter name when sending data.

    Body Parameter

    Some applications may use description or detail for the body. This value is used to change the parameter name when sending data.

    Custom Fields

    These fields are used to add additional data to the request. For example, the issue should be assigned to a user, and the webhook API has an assignee field. When adding Assignee, user1 values, the request body will be created like this:

    <IssueParameterName>
    <Title></Title>
    <Body></Body>
    <Assignee>user1</Assignee>
    </IssueParameterName>
Webhook optional settings showing issue parameter, title parameter, and body parameter configuration
  • To set custom field values, in the Custom Fields field, click the ellipsis button
  • In the Edit Custom Field Value field, enter the relevant value
  • Click OK

Authentication and Headers

  • Username
  • Password
  • HTTP Headers

If additional headers (such as Content-Type, Accept or x-auth-token) are needed for requests, this field can be used.

  • Create a webhook on the application. (For this procedure, we use Slack as an example of how to create Incoming Webhooks.)
  • Click the ellipsis button, and create the required HTTP headers. Invicti automatically adds a content-type header according to the selected payload type
HTTP Headers configuration dialog showing custom header setup for webhook requests
  • Click OK
  1. Click Create Sample Issue to confirm that Invicti Standard can connect to the configured system. The Send To Action Test confirmation dialog is displayed
Create Sample Issue button and test confirmation dialog for webhook connection verification
  1. You can view the test issue in your application
Successfully created test issue displayed in the integrated application interface

How to Export Reported Vulnerabilities to Projects using a Webhook

After configuring the webhook integration, follow these steps to export specific vulnerabilities:

  1. Open Invicti Standard
  2. From the ribbon, select the File tab. Local Scans are displayed. Double-click the relevant scan to display its results.
File Tab
  1. In the Issues panel, right click the vulnerability you want to export and select Send to Slack. (Alternatively, from the ribbon, click the Vulnerability tab, then Send to Slack.) A confirmation message and link is displayed at the bottom of the screen.
Webhook Send to
  1. Click the Webhook Send to Action is executed for the selected vulnerability link to view the newly-created issue in the application (in this case, Slack)
  2. The vulnerability is automatically exported to the application. You can view it in the application (in this case, a Slack channel)
Webhook Incoming

Need help?

Invicti Support team is ready to provide you with technical help. Go to Help Center

Was this page useful?