Integrating with GitHub

Pathfix allows you to easily add end-user OAuth based integration, handling authorization and enable communication between your app and GitHub in just a few minutes.



Before proceeding, you will first need to register your application with GitHub. Please refer the developer documentation provided by GitHub.



Add your App in GitHub

• Access your GitHub developer settings page
• Select OAuth Apps and locate the app you want to connect with
• If you do not have an app setup, click on New OAuth App and setup your new app





Image: GitHub OAuth Apps





• In the General tab, you will find your app Client ID and Client Secret
• Copy and save them for use later



Image: Github Client ID and Client Secret





• Locate the Authorization callback URL and add the Pathfix redirect URL: https://labs.pathfix.com/integrate/command
• Note: The Application name and all other details associated with the App should be your own except for the Redirect URL





Image: GitHub Redirect URL Setup







Setup in Pathfix



• Login to your Pathfix account and click on Add Application
• Add the name of your SaaS and hit Save
• In the OAuth tab, select GitHub from the list of providers to integrate with. (Note: You can change the Display Name and Description in the General tab.)
• Enter the Client ID and Client Secret received from GitHub
• You can edit the Scopes to add/remove scopes that you want to access
• Hit Save





Image: Setup GitHub Integration in Pathfix





Add Integration To Your SaaS



There are 2 steps to adding the integration to your SaaS

1. End-user authorization
   
2. Enable pass-through API