Setting up Jira webhook

Step 1: Create a new webhook in Jira

  1. Log in to your Jira instance.
  2. Navigate to the space you want to integrate with AppSec Portal.
  3. Click on the โ€œSettingsโ€ icon on the right side of the header.
  4. Select โ€œSystemโ€ from the dropdown menu.
  5. Select the โ€œWebHooksโ€ from the menu on the left side of the screen.
  6. Click on the โ€œCreate a WebHookโ€ button.

For cloud Jira instance: https://<instance>.atlassian.net/plugins/servlet/webhooks

"Create a WebHook" page

Step 2: Configure the webhook in Jira

  1. Enter a name for the webhook in the โ€œNameโ€ field.
  2. Enter the webhook URL provided by AppSec Portal in the โ€œURLโ€ field.

The webhook URL provided is an endpoint within the AppSec Portalโ€™s API that Jira can use to send events or data.

In the example below, the URL has several components separated by forward slashes:

  • https://<appsec-portal-host>/api/v1/jira-helper/jira-event: This is the route for the webhook that receives the Jira event.
  • e2b7e8be-1c77-4969-9105-58e91bd311cc: This is a unique identifier (token) that is associated with the specific webhook event. This identifier is used to ensure that the event is coming from a trusted source and to match the incoming event with the corresponding webhook configuration. {% endhint %}
  1. Select the โ€œIssue related eventsโ€ that will trigger the webhook:
  • check the โ€œupdatedโ€ and โ€œdeletedโ€ boxes in the โ€œIssueโ€ and โ€œCommentโ€ columns.
  1. Select the scope: all issues.
  2. Leave the โ€œExclude bodyโ€ option unchecked.
  3. Save your changes.
Example configuration
Successfully created webhook

Step 3: Test the webhook

Now you can test the webhook by adding a label or changing the status of a task in Jira and see if the corresponding updates are reflected in the AppSec Portal.