Configure JIRA app in HappyFox

HappyFox- JIRA integration helps you in creating tasks in JIRA from within HappyFox, having 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.

Applicable Plans: ✔️ Mighty ✔️ Fantastic ✔️ Enterprise ✔️ Enterprise Plus

Supported versions:

Watch a feature walkthrough 📽:


CONTENTS

  1. Configuring JIRA app
  2. Integration with HappyFox Tickets

CONFIGURING JIRA APP

To enable JIRA integration, login to the HappyFox staff panel and install the JIRA app from Apps > Project Management > JIRA.

 

While setting up JIRA app in HappyFox, you have two options.

  1. Using a traditional user-name & password combination to authenticate HappyFox

  2. Creating an application link in JIRA and using OAuth for authentication

Setting up JIRA using Username and Password

Alert🚨:  Jira has deprecated username/password based authentications methods for third-party integrations. This would mean HappyFox will no longer support username/password method for JIRA integration. As an alternative, please use OAuth to integrate HappyFox with JIRA. 

Please ensure that pop-ups are enabled in your browser for your HappyFox domain before proceeding.

First, 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. 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. Alternatively, you can choose to authorize the integration using an OAuth.

 

Authorizing JIRA using OAuth

Watch a setup walkthrough 📽:

Please ensure that pop-ups are enabled in your browser for your HappyFox domain before proceeding.

  1. Enter your JIRA account URL(Base URL) in the first text box.

  2. Click on “Enable OAuth Login” toggle.

 

3. Copy “Consumer Key” and “Public Key” values from JIRA setup in HappyFox.

4. Open your JIRA instance and navigate to Settings >> Products >> Integrations >> Application Links. 

 

5. Click on “Application Links”. Under Configure Application Links, enter your HappyFox domain URL. Click on “Create New Link”.

For example https://acmedo.happyfox.com

6. Click “Continue” in the dialog that appears.

7. In the next modal, enter an application name (Ex: HappyFox) and save. Leave the “Application Type” as “Generic”.

8. Now, click “Configure” for the application link that you created and click on “Incoming Authentication” tab.

9. Enter the “Consumer URL” and “Public Key” copied from HappyFox. Also, enter a “Consumer Name” (For Ex: HappyFox) and Save.

10. Return to HappyFox JIRA app. Now, click on “Save Settings”. A new browser tab should open, asking you to login to JIRA. Once logged in, you will be prompted to grant permissions to HappyFox. Click “Allow”.

 

 

11. Your JIRA integration will be automatically enabled.

Email Notifications for JIRA Sync Notes

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 will be sent to all the subscribers of the ticket.

Post-Installation Configuration

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

 

1. Copy the Webhook URL from HappyFox JIRA app.

2. Switch to JIRA. Navigate to Settings >> System >> Advanced >> WebHooks.

 

3. Click on "Create a WebHook" and paste the WebHook URL that you had copied from HappyFox. Ensure that all issue related events are selected as shown below.

 

INTEGRATION WITH HAPPYFOX TICKETS

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

Creating/Linking 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 sidebar 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.

Where can I find the JIRA Issue key/ Issue ID?

Syncing JIRA comments as Ticket Updates

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.

Viewing Information from JIRA on Tickets

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 sidebar 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" icon to view the task fully in JIRA.

Viewing Information from HappyFox on JIRA

Private notes and replies from HappyFox reflect as comments against the corresponding issues in JIRA.

Details about the agent (Name, Email) responsible for the note/reply are included within the JIRA comment.

For example, Let's add a private note on HappyFox:

On JIRA, the private note will reflect as a comment:

 

 

Feedback
0 out of 0 found this helpful

scroll to top icon