GitHub

API configuration: github, github-app, github-app-oauth

Features

Features	Status
Auth (OAuth + App)	✅
Sync data	✅
Perform workflows	✅
Proxy requests	✅
Receive webhooks	✅

We can implement missing features in <48h, just ask for it in the community.

Getting started

• Difference between OAuth Apps and GitHub Apps

• How to register a GitHub App

• How to register an OAuth App

• List of GitHub App permissions

• List of OAuth scopes

• OAuth-related docs

Need help getting started? Get help in the community.

API gotchas

• When setting up a GitHub App:

  • The App ID is made of numbers (e.g. 401953)

  • The App Public Link is the URL to your Github App public page (e.g. https://github.com/apps/terapi-github-app)

  • The App Private Key needs to be generated in your GitHub App settings and starts with -----BEGIN RSA PRIVATE KEY----- (not to be confused with the Client Secrets)

  • The Setup URL (displayed on your integration page) needs to be added to your GitHub App configuration (not to be confused with the Callback URL that can stay empty)

• When setting up a GitHub App OAuth:

  • The App ID is made of numbers (e.g. 401953)

  • The App Public Link is the URL to your Github App public page (e.g. https://github.com/apps/terapi-github-app)

  • The App Private Key needs to be generated in your GitHub App settings and starts with -----BEGIN RSA PRIVATE KEY----- (not to be confused with the Client Secrets)

  • The "Callback URL" needs to be filled in with the callback URL which unless customized will be https://api.terapi.dev/oauth/callback and the checkbox "Request user authorization (OAuth) during installation" should be checked

  • The checkbox "Redirect on update" under "Post installation" should NOT be checked and the "Setup URL (optional)" should not be accessible

• There are certain API methods that only work with an OAuth App that will not work with an App. Please check the Github documentation and look for a "Works with Github Apps" header under the endpoint.

• The github-app-oauth is a combination of a Github App and OAuth and should be used when a Github App would need approval to be installed into an organization.

• Terapi supports initiating a connection with a GitHub App using the frontend SDK, but not directly from the GitHub Marketplace. Therefore, you should encourage users to install your GitHub App from your product, rather than from the GitHub Marketplace directly. This is a limitation we plan to fix in the future.

Add Getting Started links and Gotchas by editing this page.