Jira Setup Guide
1. Configure NodeZero Vulnerability Management APIs
Configure a ticketing platform integration for Vulnerability Management Hub
1.1. Navigate to the Settings page
Click the user profile button in the top right of Portal. Then in the dropdown, click Settings
1.2. Navigate to the Integrations page
From the subnav, click Integrations
.
1.3. Start Configuration
In the NodeZero APIs
section, choose Jira from the list. Then press the +
button.
1.4. Save and Test Configuration
Enter the info required for the configuration:
Field | Description |
---|---|
Jira Domain URL | URL to your Jira instance (e.g. https://[project name].atlassian.net ) |
Jira Project Key | Enter the project key to the board where tickets will be dispatched. Project keys are used to prefix tickets (e.g. NZDEMO-1 is a ticket in the project NZDEMO ) |
Work Type | Tickets are dispatched as Tasks. Make sure the Task issue type is enabled for the project. |
Jira API Token | Token generated in Jira. For more instructions on how to create an API key for the integration, see Set Up API Key in Jira |
Email associated with the API key from above. Doesn’t need to be the email address associated with the NodeZero account. | |
Only org admins can create and manage remediation tickets | Select whether only org admins can dispatch tickets or if all users within the org can. |
2. Configure Webhooks
Configure a webhook for Vulnerability Management. You must set up Jira ticketing integration before setting up a webhook (see Configure Vulnerability Management APIs for instructions)
Note
This section is for setting up Vulnerability Management Webhooks only. For Tripwires Webhooks, see Splunk or Sentinel.
2.1. Start Webhook Configuration
In the Integrations
page in Settings
, open up the details for the existing Jira integration. Click Set Up Webhook
.
2.2. Save and Test Webhooks
A URL is provided to use when setting up a Webhook. For more instructions on how to create a Webhook for the Jira integration, see the section 4. Setup Webhook in Jira.
Once the Webhook is created in the ticketing platform, copy the token and paste in the form's required field.
3. Setup API Key in Jira
- Go to the API Tokens page in the Atlassian account settings.
- Click
Create API Token
. Fill out the form and clickCreate
. - Once created, copy the API token to paste in the Save and Test Configuration.
4. Setup Webhook in Jira
- In Jira, go to
System Settings
. UnderAdvanced
, clickWebHooks
. - You can also go directly to
{url}/plugins/servlet/webhooks
where{url}
is the domain URL from the API integration config. - Click
Create Webhook
and fill out the form. - URL: URL provided from the Webhook form (see Save and Test Webhooks)
- Secret: Generate a secret. Then copy this field to paste in the Save and Test Webhooks
- Issue Related Events:
- In JQL, specify
project = {project}
where{project}
is the full name of the project (not the key) - Check
updated
underIssue
- Click
Create