The FOSSA Developer Hub

Welcome to the FOSSA developer hub. You'll find comprehensive guides and documentation to help you start working with FOSSA as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Atlassian Jira

Integrating Atlassian's Issue Tracker Jira with FOSSA

This guide was written to integrate Atlassian Jira v7.1.4 into FOSSA.

This integration adds the ability to closely link Jira ticketing workflows and statuses to issues found in FOSSA. By linking Jira to your FOSSA projects, issues can be exported to new tickets in Jira and then assigned/resolved automatically when tickets on Jira are closed.

Jira Cloud: Create an API token

Jira Cloud allows users to create API tokens that integrations such as FOSSA can use to communicate with Jira on the user's behalf. FOSSA requires that a Jira user with permission to create, resolve, and modify users create the API token.

Please see the Jira documentation for help creating an API token.

When configuring your Jira site in FOSSA, use the username of the Jira user that created the API token, and use the API token as the user's password.

Jira On-Prem: Create a user for FOSSA on Jira

FOSSA requires an admin account on Jira to manage the creation and modification of new tickets from issues.

  1. Create a new user

Specify whatever username/password you'd like in the screen above. By default, we keep the combination fossabot/fossa123.

  1. Add user as admin

Configure FOSSA with Jira

In FOSSA, click your username in the top-right corner and select Settings > Integrations > Jira. If this is your first time configuring Jira, click the "Click to Configure Jira" button, otherwise click "Add Jira" to add an additional Jira site.

The Name field is used by FOSSA to identify this Jira site in issue export dialogues.
The Jira site URL field should be the address we can use to reach your Jira site. It's usually the same address you use to access Jira.
The Resolved Workflow Statuses are statuses in your Jira site that indicate than an issue has been resolved. If an issue on Jira is in one of these states, then the issue on FOSSA will be closed. If an issue on Jira transitions out of one of these states, the FOSSA issue will be reopened.

Add in the username and password or API token created above, and click save in the top right corner.

Important: Take note of the generated Webhook URL. You'll need to use this value when configuring the webhook in Jira in the next section.

Linking FOSSA projects to Jira projects

Now that both services are configured, you may associate projects in FOSSA with projects in Jira.

Inside of FOSSA under a project's settings, set:

  • Issue Tracker Type to Jira
  • Jira Project Key

You can find the project key by looking:

  • At Jira project URLs: http://jira-url.com/projects/PROJECT_KEY/summary
  • Issue keys: PROJECTKEY-173, PROJECTKEY-244
  • The right-hand details panel of each project summary page under Key

Add Webhooks to Jira

FOSSA requires webhooks to sync issue status with Jira. This means that when a user closes an issue in Jira, the corresponding issue will be resolved in FOSSA.

  1. Navigate to Admin > System > Advanced > WebHooks
  1. Create a new webhook

Enter in your FOSSA IP/Port with the path specified below. Note that the webhook URL is different for each Jira site that you configure in FOSSA.

Define events for updating/deleting issues:

Then click the Create on the bottom of the form. The created webhook should look something like:

Troubleshooting

If issues aren't getting exported, please check your logs for common errors:

  • "The issue type selected is invalid."

When FOSSA generates a ticket, by default it sets the Jira issueType to be Task. This is one of the default issue types for new Jira installations, but your admin may have deleted/configured out this issue type or your installation could just be missing it. Check on the existing issue types in Jira and create the Task type if it is missing.

See the Jira help doc for more instructions.

Atlassian Jira


Integrating Atlassian's Issue Tracker Jira with FOSSA

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.