This website uses cookies. By clicking Accept, you consent to the use of cookies. Click Here to learn more about how we use cookies.
Accept
Reject
Community FAQ
cancel
Turn on suggestions
Auto-suggest helps you quickly narrow down your search results by suggesting possible matches as you type.
Showing results for 
Show  only  | Search instead for 
Did you mean: 
Glossary

This documentation is for the new preview UI. It’s still being refined and is subject to change. For documentation for the old UI, see Knowledge Base.

GitHub Connector

Article link copied to clipboard
Updated

on ‎10-31-2025 12:22 PM - edited yesterday by Lansweeper Employee

Published
‎10-31-2025 12:22 PM
8 min read
Note on third‑party tools

We aim to provide accurate and helpful details about third‑party tools, but we can’t guarantee that this information is always complete or up to date. If you notice any discrepancies, feel free to share them in the feedback section below. For the most reliable information, please always refer to the third‑party tool’s official documentation.

Manage users, repositories, licenses, and more on GitHub

Connections

OAuth 2.0

Authenticates with your Github account using OAuth 2.0

To connect to GitHub, create a new OAuth 2.0 application.

Setup Steps

  1. Navigate to GitHub Developer Settings to create a new OAuth App.
  2. Fill in the required fields:
  3. Click Register application.
  4. Click Generate a new client secret to create a client secret.
  5. Copy the Client ID and Client Secret values.

Configure the Connection

  • Enter the Client ID and Client Secret from the OAuth App.
  • Determine what scopes the use case requires and add those to Scopes, separating each with a space.
    • Common scopes include: repo, user, admin:org, workflow
    • For full repository access and workflow permissions, use: repo user admin:org workflow

The connection is now ready to authenticate with GitHub.

This connection uses OAuth 2.0, a common authentication mechanism for integrations.
Read about how OAuth 2.0 works here.

Input Comments Default
Scopes Space-separated list of OAuth scopes. See GitHub's documentation for available scopes.
Client ID The Client ID from your GitHub OAuth App. Find this in GitHub Settings > Developer settings > OAuth Apps.
Client Secret The Client Secret from your GitHub OAuth App. Keep this value secure.

Triggers

Webhook

Receive and validate webhook requests from Github for webhooks you configure.

Input Comments Default
Webhook Secret An optional secret used to verify webhook authenticity. See GitHub's documentation for details.

Actions

Actions Create Workflow Dispatch

Create a workflow dispatch event

Input Comments Default
Connection
Owner The account owner of the repository. For example, in https://github.com/octocat/Hello-World, the owner is 'octocat'.
Repository Name The name of the repository. For example, in https://github.com/octocat/Hello-World, the repository name is 'Hello-World'.
Workflow Id The ID of the workflow
Ref The git reference for the workflow
Inputs Input keys and values configured in the workflow file. This can be a JSON input mapping, or a reference to a previous step that returned an object. {"input1":"My Value","input2":"My Other Value"}

Git Create Blob

Create a blob

Input Comments Default
Connection
Owner The account owner of the repository. For example, in https://github.com/octocat/Hello-World, the owner is 'octocat'.
Repository Name The name of the repository. For example, in https://github.com/octocat/Hello-World, the repository name is 'Hello-World'.
Content The new blob"s content
Encoding The encoding used for "content" utf-8

Git Create Ref

Create a reference

Input Comments Default
Connection
Owner The account owner of the repository. For example, in https://github.com/octocat/Hello-World, the owner is 'octocat'.
Repository Name The name of the repository. For example, in https://github.com/octocat/Hello-World, the repository name is 'Hello-World'.
Ref The name of the fully qualified reference (ie: "refs/heads/master")
Sha The SHA1 value for this reference
Key

Git Create Tree

Create a tree

Input Comments Default
Connection
Owner The account owner of the repository. For example, in https://github.com/octocat/Hello-World, the owner is 'octocat'.
Repository Name The name of the repository. For example, in https://github.com/octocat/Hello-World, the repository name is 'Hello-World'.
Tree Objects (of "path", "mode", "type", and "content" or "sha") specifying a tree structure. See https://docs.github.com/en/rest/git/trees#create-a-tree [
{
"path": "test.txt",
"mode": "100644",
"content": "This is a test"
}
]
Base Tree The SHA1 of an existing Git tree object which will be used as the base for the new tree

Git Get Ref

Get a reference

Input Comments Default
Connection
Owner The account owner of the repository. For example, in https://github.com/octocat/Hello-World, the owner is 'octocat'.
Repository Name The name of the repository. For example, in https://github.com/octocat/Hello-World, the repository name is 'Hello-World'.
Ref ref parameter

Issues Create Comment

Create an issue comment

Input Comments Default
Connection
Owner The account owner of the repository. For example, in https://github.com/octocat/Hello-World, the owner is 'octocat'.
Repository Name The name of the repository. For example, in https://github.com/octocat/Hello-World, the repository name is 'Hello-World'.
Issue Number The number that identifies the issue
Body The contents of the comment

Issues List Comments

List issue comments

Input Comments Default
Connection
Owner The account owner of the repository. For example, in https://github.com/octocat/Hello-World, the owner is 'octocat'.
Repository Name The name of the repository. For example, in https://github.com/octocat/Hello-World, the repository name is 'Hello-World'.
Issue Number The number that identifies the issue
Since Only show notifications updated after the given time
Per Page The number of results per page (max 100) 30
Page Page number of the results to fetch 1

Issues List For Repo

List repository issues

Input Comments Default
Connection
Owner The account owner of the repository. For example, in https://github.com/octocat/Hello-World, the owner is 'octocat'.
Repository Name The name of the repository. For example, in https://github.com/octocat/Hello-World, the repository name is 'Hello-World'.
Fetch All Whether to fetch all results false
Milestone If an "integer" is passed, it should refer to a milestone by its "number" field
State Indicates the state of the issues to return open
Assignee The user that is assigned to the issue, use 'none' for issues with no assignee, or '*' for issues assigned to any user
Creator The user that created the issue
Mentioned A user that"s mentioned in the issue
Labels A list of comma separated label names
Sort What to sort results by created
Direction The direction to sort the results by asc
Since Only show notifications updated after the given time
Per Page The number of results per page (max 100) 30
Page Page number of the results to fetch 1

Orgs List For Authenticated User

List organizations for the authenticated user

Input Comments Default
Connection
Per Page The number of results per page (max 100) 30
Page Page number of the results to fetch 1

Pulls Create

Create a pull request

Input Comments Default
Connection
Owner The account owner of the repository. For example, in https://github.com/octocat/Hello-World, the owner is 'octocat'.
Repository Name The name of the repository. For example, in https://github.com/octocat/Hello-World, the repository name is 'Hello-World'.
Title The title of the pull request. Required unless using the issue parameter.
Head The name of the branch where your changes are implemented. For cross-repository pull requests, use the format 'username:branch'.
Base The name of the branch you want the changes pulled into. This should be an existing branch in the repository.
Body The contents/description of the pull request. Supports markdown formatting.
Maintainer Can Modify When true, maintainers can modify the pull request. See GitHub's documentation for details. false
Draft When true, creates the pull request as a draft. Draft pull requests cannot be merged until marked as ready for review. false
Issue Number The number that identifies the issue

Pulls List

List pull requests

Input Comments Default
Connection
Owner The account owner of the repository. For example, in https://github.com/octocat/Hello-World, the owner is 'octocat'.
Repository Name The name of the repository. For example, in https://github.com/octocat/Hello-World, the repository name is 'Hello-World'.
State Filters pull requests by their state (open, closed, or all). open
Head Filter pull requests by head user or organization and branch name in the format "user:ref-name" or "organization:ref-name".
Base Filter pull requests by base branch name.
Sort The field to sort results by. created
Direction The direction to sort results (ascending or descending).
Per Page The number of results per page (max 100). 30
Page The page number of the results to fetch. 1

Raw Request

Send raw HTTP request to Github

Input Comments Default
Connection
URL Input the path only (/octocat), The base URL is already included (https://api.github.com). For example, to connect to https://api.github.com/octocat, only /octocat is entered in this field.
Method The HTTP method to use.
Data The HTTP body payload to send to the URL.
Form Data The Form Data to be sent as a multipart form upload.
File Data File Data to be sent as a multipart form upload.
File Data File Names File names to apply to the file data inputs. Keys must match the file data keys above.
Query Parameter A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Header A list of headers to send with the request.
Response Type The type of data you expect in the response. You can request json, text, or binary data. json
Timeout The maximum time that a client will await a response to its request
Debug Request Enabling this flag will log out the current request. false
Retry Delay (ms) The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled. 0
Retry On All Errors If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors. false
Max Retry Count The maximum number of retries to attempt. Specify 0 for no retries. 0
Use Exponential Backoff Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored. false

Repos Create Webhook

Create a repository webhook

Input Comments Default
Connection
Owner The account owner of the repository. For example, in https://github.com/octocat/Hello-World, the owner is 'octocat'.
Repository Name The name of the repository. For example, in https://github.com/octocat/Hello-World, the repository name is 'Hello-World'.
Callback URL The URL where webhook events will be sent.
Events The list of event types that will trigger the webhook.
Webhook Secret An optional secret used to verify webhook authenticity. See GitHub's documentation for details.

Repos Delete Instance Webhooks

Delete all webhooks pointed at this instance

Input Comments Default
Connection
Owner The account owner of the repository. For example, in https://github.com/octocat/Hello-World, the owner is 'octocat'.
Repository Name The name of the repository. For example, in https://github.com/octocat/Hello-World, the repository name is 'Hello-World'.

Repos Delete Webhook

Delete a repository webhook by ID

Input Comments Default
Connection
Owner The account owner of the repository. For example, in https://github.com/octocat/Hello-World, the owner is 'octocat'.
Repository Name The name of the repository. For example, in https://github.com/octocat/Hello-World, the repository name is 'Hello-World'.
Hook ID The unique identifier of the webhook.

Repos List For Org

List organization repositories

Input Comments Default
Connection
Org The organization name
Type Specifies the types of repositories you want returned
Sort The property to sort the results by created
Direction The order to sort by
Per Page The number of results per page (max 100) 30
Page Page number of the results to fetch 1

Repos List Webhooks

List webhooks of a repository

Input Comments Default
Connection
Owner The account owner of the repository. For example, in https://github.com/octocat/Hello-World, the owner is 'octocat'.
Repository Name The name of the repository. For example, in https://github.com/octocat/Hello-World, the repository name is 'Hello-World'.
Show only instance webhooks When true, shows only webhooks that point to this instance. true

Users Get Authenticated

Get the authenticated user

Input Comments Default
Connection

Users Get By Username

Get a user

Input Comments Default
Connection
Username The GitHub username.