Documentation

Welcome to Retool! We're a fast way to build custom internal software.

You'll find the 5 minute demo, quickstart guide, and documentation for each of our connectors and components here. If you've got any questions -- chat with us on the bottom right!

Get Started    Guides

GitHub Integration

Connecting GitHub to Retool

1. Create GitHub App

Your Retool app will first need to be registered on GitHub. Create a new OAuth app via the "Developer Settings" section of your account's "Settings" page.

Set the "Authorization callback URL" to be https://oauth.tryretool.com/oauth/user/oauthcallback. You can also find and copy this URL when you create a new GitHub resource within Retool.

Settings > Developer Settings > OAuth Apps > New OAuth App

2. Get GitHub App Credentials

Enter the "Settings" section for your GitHub app, where you can find the Client ID and Client Secret keys.

Settings > Developer Settings > OAuth Apps > [your GitHub app]

3. Add to Retool

Create a new resource in Retool, and select "GitHub" as the type. Enter your client ID and secret key, and select the permissions you'd like to authorise from the "Scopes" multi-select dropdown. Click the "Test OAuth integration with your own account" button and authorise the application. Press "Save" when you're done.

Resources > Add > Stripe

4. Create queries

You can now select your newly-created GitHub resource from the Resource dropdown when creating queries in your Retool apps. The operations that will work for you will depend on the permissions that you approved when you set up the resource.

You can display the results of GitHub queries as with any other query in Retool. You will have to examine the response to see which part of it you actually want to display. In this case, the data we care about is in githubQuery.data.response.body rather than just githubQuery.data.


-->