Configure GitHub Integration with HappyFox

GitHub brings together the world's largest community of developers to discover, share, and build better software. It provides access control and several collaboration features such as bug tracking, feature requests, task management, and wikis for every project.

 

GitHub integration with HappyFox allows your agents to

  1. Create a new issue in GitHub from within a ticket and link it

  2. Link an existing issue with a ticket

  3. Edit an issue linked with a ticket

  4. Enable two-way real-time synchronization between GitHub issue-comments and HappyFox ticket updates/private-notes

  5. Auto-closing of HappyFox ticket, when linked GitHub issue, is closed 

Integrating GitHub with HappyFox requires the following

  1. Authorizing HappyFox to connect to GitHub

  2. Configuring & Enabling GitHub app inside HappyFox

  3. Subscribing to WebHooks for real-time sync

Authorizing HappyFox to connect to GitHub

1. Login to HappyFox and navigate to “Apps” module.

2. Either search for “GitHub” or navigate to “Project Management” category to find GitHub app.

3. Click on the GitHub tile and choose “Install”.

4. From the manage screen, click on “Link GitHub” button.

5. You will now be redirected to authorize yourself in GitHub.

6. Once the authorization is successful, you will be prompted to authorize HappyFox app to connect to GitHub. To do this, click on “Authorize happyfoxinc”.

7. You will then be redirected to HappyFox with the GitHub app successfully configured.

8. Proceed to the next section: Configuring & Enabling GitHub app inside HappyFox.

Configuring & Enabling GitHub app inside HappyFox

Once GitHub is installed, you have to select the GitHub repositories in which issues can be created from HappyFox. 

1. Navigate to GitHub app inside HappyFox and click on “Manage”.

2. Under “Repositories”, select the GitHub public/private repositories in which you can create/link issues from HappyFox.

 

3. You can synchronize HappyFox ticket responses and GitHub issue comments across the two platforms.
    3.1 Sync HappyFox replies to Github: Enabling this toggle will let you push HappyFox ticket replies as "Issue Comments" inside GitHub.
    3.2 Sync GitHub issue comments to HappyFox: Enabling this toggle will let you synchronize GitHub's "Issue Comments" as Ticket Updates inside HappyFox.

The option to configure this two-way synchronization is available when you link or create an issue from a HappyFox ticket

4. Additionally, you can enable and customize email notifications that will be sent from HappyFox for sync-notes. The notification template here will be used when an issue-comment is added to GitHub.
5. Enable the app by clicking on the “Enable app” toggle.

6. Click on “Save”.

 

Subscribing to WebHooks for Real-Time Sync

To allow issue comments from GitHub to appear as HappyFox ticket updates, we need to add a WebHook in GitHub to publish to HappyFox.

1. Login to HappyFox and go to the “Apps” module.
2. Search for GitHub and click on “Manage”.
3. From the “URL for GitHub Webhook” section, copy the WebHook URL.
4. Login to GitHub and navigate to the repositories you own/manage.

5. Click on “Settings” tab and choose “WebHooks” subtab.


6. Click on “Add WebHook” and paste the URL copied above in the “Payload URL” field.
Select “application/json” in the “Content type” field.
7. Under “Which events would you like to trigger this webhook?” field, choose “Let me select individual events”. Select the following events

  • Issues
  • Issue Comments

8. Make sure that the “Active” checkbox is ticked before saving.

 

Linking and Creating Issues in GitHub from HappyFox

 

Creating an issue in GitHub from HappyFox
 

 

Linking an existing issue in GitHub with a HappyFox ticket

 

 

Ticket updates synced as issue-comments in GitHub

 

 

Comments in GitHub appearing as ticket updates in HappyFox

Feedback
0 out of 0 found this helpful

scroll to top icon