Enable integration with JIRA

INTRODUCTION

HappyFox- JIRA integration helps you in creating tasks in JIRA from within HappyFox, having a two-way sync of tickets updates and JIRA comments and also to view the issue specific fields and other custom fields from JIRA within HappyFox.

Supported versions:

  • JIRA Software Ondemand.
  • JIRA Self Hosted - version 5.2 or higher.

Note: If you are using the "New HappyFox" experience, please refer to this article to setup your JIRA app.

CONFIGURATION SETUP

To enable JIRA integration, login to the HappyFox staff panel and go to Manage >> Integrations. Click on the configure link against JIRA listed under External Integrations.

JIRA account set up

Now, enter your JIRA account URL(Base URL) in the first text box.

Example JIRA Account URL: 

https://johnhappyfox.atlassian.net

We recommend adding a new user in your JIRA set up, for this integration purposes. You can do this under Settings->User Management. This user should have the following permissions in JIRA - create, edit issues and to add comments. This can be accessed at Projects-> Select Project-> Project Settings->Permissions.

This user should not have Admin permission (the admin user has certain special permissions. Since username and password is required for authentication, we enforce that the user integrating with HappyFox does not have ADMIN permissions for security purposes).

Enter this user's credentials in the username and password field. Enable the integration by checking the Active box and save the settings. While saving the settings the account details will be verified. If there are any errors, the errors will be reported and you are requested to check the details.

JIRA Notifications

To receive email notifications when a new JIRA sync note is added, click on 'Enable email notifications for JIRA Sync notes' and customize Email Subject and Email Content, based on your requirement and click 'Save Settings'. This email wil be sent to all the subscribers of the ticket.

Post setup configuration

Once the settings have been saved successfully, you will be presented with the instructions to add a WebHook in JIRA, as shown in the screenshot below. This is required for syncing the comments from JIRA to your HappyFox account. 

The admin should ensure the following while setting up the WebHook.

Navigate to System settings as shown below

Navigate to WebHooks under Advanced Section as shown below.

Click on "Create a WebHook".

Paste the WebHook URL that you had copied from HappyFox.

Ensure that all issue related events are selected as shown below.

Integration with tickets in HappyFox

Once the JIRA integration has been set up, there will be a new section shown in the Ticket detail page in HappyFox. Example of section, when no JIRA task is associated with the ticket is shown in the screenshot below.

Creating a new JIRA task from HappyFox

To create a new task in JIRA from a ticket in HappyFox, the permission Create & Edit JIRA issues should be enabled in the Staff >> Roles section for the logged in staff.

To add an issue, click on the "add new" link and this will open a facebox with details like Project name, issue type, custom fields etc from your JIRA account. HappyFox also provides the following options, which you can optionally check.

  • Sync comments from JIRA
  • Close the ticket when the JIRA task is closed

Also, you can link the ticket to an existing task in JIRA by entering the JIRA Issue Key.

Task created in JIRA 

Once the task is created in JIRA, it will appear under the Issues section.

Comments sync with JIRA

Comments which are synced from the JIRA task will be shown in HappyFox as shown below. the update is shown as a "JIRA Update" with the blue band (JIRA sync) indicating that this update in the ticket was from JIRA.

Comments sync from JIRA will be pushed to the HappyFox account only if SSL is enabled on your HappyFox account.

More Information from JIRA

Other information from JIRA, about the specific issue like the other custom fields data is shown in the Information from JIRA section. You can click on More info to view this data. The edit functionality will open a facebox in HappyFox to edit the basic information for the JIRA task (not all fields are supported). The options to sync updates and close the ticket, will be present, in case this setting has to be changed from before, while the task was initially created.

You can also click on "view in JIRA" to view the task fully in JIRA.

  • 119
  • 03-Oct-2018
  • 8414 Views