Skip to main content

GitHub

To set up the connection to your GitHub account use the command /channel general edit with the field API (Premium).

API Provider​

First choose the API Provider from the dropdown and select GitHub.

Important

When you edit the API Provider all other settings will be reset!

API Token​

You can follow the official GitHub documentation to create your personal access token (API token). I would suggest to use a fine-grained token, since you can restrict the access better this way.

To create a personal access token, you basically need to:

  • Go to Settings
  • Developer settings => https://github.com/settings/apps
  • Personal access Tokens
  • Fine-grained tokens
  • Generate new token
    • Fill in the required fields
    • Select Only select repositories
      • Choose your repository
    • Select Repository permissions and add Access: Read and write to Issues
  • Generate token

Project ID​

The project id is basically your {username}/{repository name}. For example Snawe as username and Submitty as repository name would be Snawe/Submitty.

info

Once you have completed all steps above, it is recommended to test the API connection before proceeding.