With the Shortcut GitHub integration, specially formatted commit messages can be used to link stories to commits, branches and pull requests, as well as move stories across your workflow. Following these instructions, you can configure the Shortcut GitHub integration to work with one or more GitHub repositories.
This guide is strictly for users using GitHub Enterprise. If you are using the Free or Teams version of GitHub, please click here for a different guide.
Contact our support team to have the GitHub Enterprise integration enabled in your account, before continuing this guide.
Setting up the integration in Shortcut
- In the Shortcut app, click the User icon in the lower-left corner, click Integrations, and then click GitHub.
- Copy the GitHub Enterprise Payload URL. Now head over to your GitHub repo page.
Setting up the integration in GitHub
From your repository page in GitHub, select the Settings tab.
If you wish to add this to the entire GitHub Org, navigate to the Organization Settings page instead, and continue the steps below.
- On the settings page, click Webhooks.
- Click Add webhook in the top right.
- In the Payload URL box, enter the Payload URL you copied from our GitHub Integration dialog.
- Under "Which events would you like to trigger this webhook", select Send me everything*.
- Content-type should be set to application/JSON
- Click Add webhook.
Our GitHub integration is now enabled for this repository!
*If you want to use the "Let me select individual events" option, you will need to have at least Create, Delete, Comment, Pull Request and Push selected to capture all events. See image below:
Connecting Individual Accounts
Individuals will need to ensure that their primary email address in GitHub is the same as one of their email addresses in Shortcut. In Github, check your personal account settings, under the email tab.
If this is not the same email address used to create your Shortcut account, you'll need to add that email address to Shortcut.
GitHub Event Handlers
To set up your integration to use our GitHub Event Handlers, follow these instructions. When you're done, make sure to check out our the guide to using our GitHub integration.