# GitHub
GitHub (opens new window) is a popular version control application used by millions of developers and companies.
The GitHub connector enables you to build powerful automation around GitHub to help manage these software development processes and manage your agile sprints.
# Use cases
Integrate the GitHub connector with your collaboration and project management tools to automate development workflows. You can streamline release management, inform teams, and document critical updates across platforms. Explore our use cases to discover how you can enhance your GitHub processes:
- Generate Confluence release notes from merged GitHub PRs.
- Create summarized Confluence notes and Jira comments from closed GitHub PRs.
- Post GitHub milestones with Workbot for Slack.
# API version
This connector uses the GitHub REST API v3 (opens new window).
# How to connect to GitHub on Workato
Connect to GitHub on Workato using one of the following methods:
- OAuth authentication. Workato recipes act on your behalf. Refer to OAuth authentication for more information.
- GitHub Apps. Workato recipes act as the app. Refer to GitHub App authentication .
- A personal access token
Refer to the GitHub documentation (opens new window) for more information.
We recommend that you create GitHub Apps for access control. GitHub Apps don't assume any user's identity, which provides clear insight into your recipes' activity.
GITHUB APPS CONNECTION
Each GitHub App connection links to a specific installation in an organization or user account.
# OAuth authentication
Complete the following steps to connect to GitHub using OAuth:
Sign in to your Workato account and go to the project where you plan to add your GitHub connection.
Click Create > Connection, then select GitHub as your connection.
Provide a Connection name that identifies which GitHub instance Workato is connected to.
Use the Location drop-down menu to select the project where you plan to store the connection.
Use the Authentication type drop-down menu and select OAuth App.
Optional. Click Advanced configuration to display the Host name field.
Optional. Enter a Host name. This is applicable when using Github Enterprise Server. Enter your Github subdomain. For example, if your host URL is https://github.example-organisation.com, the subdomain is github.example-organisation.com.
Click Connect. Workato redirects you to GitHub. The OAuth App requests authorization to act on your behalf. Workato performs actions such as creating comments, issues, and pull requests under your GitHub user.
# GitHub App authentication
You must first register the app in your GitHub account and retrieve its credentials to connect to GitHub using a GitHub App. Use this information to configure the connection in Workato.
Select Authentication type as GitHub app and collect details from your GitHub App!
# Register your GitHub App
Complete the following steps to register your GitHub App and retrieve the credentials required to connect it to Workato:
Complete the steps (opens new window) in the GitHub documentation to register your GitHub App.
Retrieve your GitHub App ID in the General settings page of your GitHub app.
Save this App ID and place it into your connection
Generate a Private key on the same page. GitHub automatically downloads this .pem file to your machine.
Generate the private key
Open the .pem file in a text editor. The file should look similar to the following:
-----BEGIN RSA PRIVATE KEY-----
MIIEpAIBAAKCAQEAyL/wuiSaWoH0pyf366G5E7dbzzmON1qMMrWvls8RtZtgOLjb
FBxj6gO2aUfoGbMCMqOYRV6xCn6tK118sGYMd5U/kCFu3IRPr/2GoEtcrf0TecQG
ON+27ijH0Vpn62o8NzGejdy0AWujrtAl6F8xGZeze0PzrGvW6h/GnAdZO1gJnp8t
wmEqEMXqAsPOQ0hkY+r+pE8RKQVsJCe+PIanBKp7RKWDi9usPFZQdQ==
-----END RSA PRIVATE KEY-----
Copy the entire private key including the -----BEGIN RSA PRIVATE KEY----- and -----END RSA PRIVATE KEY-----. Use this private key when you set up the connection in Workato.
Retrieve your Installation ID from the organization or user where you installed your GitHub App:
Users accounts: Go to Settings > Applications > Your GitHub App > Configure.
Organizations: Go to your organization's GitHub homepage. Click Settings > Installed GitHub Apps > Configure.
The installation ID appears in the URL. For example, if the URL is https://github.com/settings/installations/13876669, the installation ID is 13876669.
Save the installation ID. Enter this ID when creating the GitHub App connection in Workato.
Next, complete the setup in Workato.
# Complete setup in Workato
Complete the following steps to finish setting up the GitHub App connection:
Sign in to your Workato account and go to the project where you plan to add your GitHub connection.
Click Create > Connection, then select GitHub as your connection.
Provide a Connection name that identifies which GitHub instance Workato is connected to.
Use the Location drop-down menu to select the project where you plan to store the connection.
Use the Authentication type drop-down menu and select GitHub App.
Enter your GitHub App ID.
Enter your Github App Private key.
Enter your Installation ID.
Optional. Click Advanced configuration to display the Host name field.
Optional. Enter a Host name if using GitHub Enterprise Server. Use your GitHub subdomain. For example, if your host URL is https://github.example-organisation.com, the subdomain is github.example-organisation.com.
Optional. Enter a Custom OAuth profile. This selection ensures that all requests to the app use the specified profile.
Click Connect.
# Personal access token authentication
To connect to GitHub using a personal access token, retrieve the token from GitHub and use it to configure the connection in Workato.
# Retrieve personal access token
Complete the following steps to retrieve your GitHub personal access token:
Go to Github account > Settings > Developer settings > Personal access tokens > Generate new token.
Click Generate new token.
Copy the token. Enter this token in Workato to authenticate the connection.
# Complete setup in Workato
Sign in to your Workato account and go to the project where you plan to add your GitHub connection.
Click Create > Connection, then select GitHub as your connection.
Provide a Connection name that identifies which GitHub instance Workato is connected to.
Use the Location drop-down menu to select the project where you plan to store the connection.
Use the Authentication type drop-down menu and select Personal Access Token.
Optional. Click Advanced configuration to display the Host name field.
Optional. Enter a Host name. This is applicable when using Github Enterprise Server. Enter your Github subdomain. For example, if your host URL is https://github.example-organisation.com, your subdomain is github.example-organisation.com.
Enter your Personal Access Token.
Optional. Enter a Custom OAuth profile. This ensures all requests to the app use the specified profile.
Click Connect.
Last updated: 8/19/2025, 6:21:58 PM