To create a Jira integration, you need to add a Webhook on your Jira instance to send data to Enzyme.
The Enzyme-Jira integration uses separate Webhook and API integrations to achieve two functionalities:
- Webhook - push updates from Jira to Enzyme, where they get recorded
- API - Enzyme will push updates back to Jira as comments issues pushed in via Webhook
Note: If your Atlassian API key gets reset, simple unlink in Enzyme and relink with the new key. Existing linkages from Webhooks will remain, but commenting back to Jira will be broken until the API key is updated.
- Enzyme > Admin Menu > Integrations and you’ll see the screen below. The Enzyme generated Webhook is PRODUCT specific, to ensure you are targeting the correct product, make sure it is selected in the product selector.
- This Enzyme generated URL will allow Jira to push messages to Enzyme. Navigate to this admin panel in Jira: https://[yourcompany].atlassian.net/plugins/servlet/webhooks
- Click Create a WebHook. Enter in a descriptive name, and paste in the URL from Enzyme.
- Ensure that under Issue section you have checked: Created, Updated, and Deleted.
- Then click Create and confirm the Webhook looks similar to this one:
- To make the connection secure, retrieve your personal API key from Jira from Atlassian's account management panel on the API Tokens tab: https://id.atlassian.com/manage/api-tokens
- Return to the integrations section Enzyme.
- Paste in the API key, your email and your Jira instance URL.
- Then click "Link Jira" and observe the following screen appears.
If these instructions are unclear or you would like some help, feel free to contact Enzyme support.
Next, checkout the Jira workflow guide to learn how to integrate epics and issue from Jira into your Enzyme instance.
If your your project is complex you may find that you do not have a 1:1 mapping between products in Enzyme and projects in Jira.
Jira provides a solution for this that may require some customization in the form of Jira Query Language (JQL) parameter.
By providing the Webhook with parameters ("Component" is most often used for this case) you can limit which updates get pushed to a given Webhook URI (thus limiting which Enzyme product is gets pushed to).
Let's assume the Enzyme generated URI is for the hardware product in the development phase. The following JQL code will filter out updates that are not from the component Hardware System and in category Dev.