The xkit Developer Hub

Welcome to the xkit developer hub. You'll find comprehensive guides and documentation to help you start working with xkit as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    


Steps to set up GitHub with Xkit

GitHub's Guide: https://docs.github.com/en/developers/apps/getting-started-with-apps
Authorization protocol: OAuth 2.0

1. Add the GitHub connector in the Xkit platform.

  • In the Xkit platform, click "New connector" in the sidebar or at the bottom of the "Connectors" screen.
  • Click "GitHub". At this point you'll see a callback url, which you'll provide to GitHub in the next step, and places to input the Client ID and Client Secret that you'll get from GitHub after registering your app with them.

2. Register your application with GitHub.

  • Next, in a separate window, sign in to your GitHub account or create an account if you don't have one.
  • Visit this link: https://github.com/settings/applications/new (or you can click your icon in the top right and go to Settings > Developer settings in the sidebar > OAuth Apps in the sidebar > Register a new application).
  • Enter the name of your application and homepage URL.
  • Copy/paste the callback URL from the Xkit platform into the "Authorization callback URL" field on the GitHub page.
  • Click "Register application".

3. Provide Xkit with the credentials.

  • After completing the last step, you should have been taken to a screen that shows your Client ID and Client Secret.
  • Copy/paste your Client ID and Client Secret onto the Xkit page.

4. Complete the Xkit connection setup.

  • Now that you've provided the callback URL to GitHub and entered the Client ID and Client Secret into the Xkit platform, click "Save" on the Xkit page.
  • Fill out the Catalog Settings page and again click "Save".
  • On the next page, select the permissions/scopes your application requires and click "Save" (additional details about the scopes are available here).

You've now successfully connected GitHub with Xkit!

Updated 7 months ago


Steps to set up GitHub with Xkit

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.