Skip to main content

GitHub Connector

GitHub Manage users, repositories, licenses, and more on GitHub

Connections

OAuth 2.0

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

InputCommentsDefault
ScopesSpace-delimited scopes; refer to GitHub's documentation for details
Client IDClient identifier
Client SecretClient secret

Triggers

Webhook

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

InputCommentsDefault
Webhook SecretAn optional secret to use to verify webhook authenticity. See https://docs.github.com/en/developers/webhooks-and-events/webhooks/securing-your-webhooks

Actions

Actions Create Workflow Dispatch

Create a workflow dispatch event

InputCommentsDefault
Connection
OwnerThe account OWNER of the repository (https://github.com/OWNER/REPO)
Repository NameThe name of the REPO (https://github.com/OWNER/REPO)
Workflow IdThe ID of the workflow
RefThe git reference for the workflow
InputsInput 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

InputCommentsDefault
Connection
OwnerThe account OWNER of the repository (https://github.com/OWNER/REPO)
Repository NameThe name of the REPO (https://github.com/OWNER/REPO)
ContentThe new blob"s content
EncodingThe encoding used for "content"utf-8

Git Create Ref

Create a reference

InputCommentsDefault
Connection
OwnerThe account OWNER of the repository (https://github.com/OWNER/REPO)
Repository NameThe name of the REPO (https://github.com/OWNER/REPO)
RefThe name of the fully qualified reference (ie: "refs/heads/master")
ShaThe SHA1 value for this reference
Key

Git Create Tree

Create a tree

InputCommentsDefault
Connection
OwnerThe account OWNER of the repository (https://github.com/OWNER/REPO)
Repository NameThe name of the REPO (https://github.com/OWNER/REPO)
TreeObjects (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 TreeThe SHA1 of an existing Git tree object which will be used as the base for the new tree

Git Get Ref

Get a reference

InputCommentsDefault
Connection
OwnerThe account OWNER of the repository (https://github.com/OWNER/REPO)
Repository NameThe name of the REPO (https://github.com/OWNER/REPO)
Refref parameter

Issues Create Comment

Create an issue comment

InputCommentsDefault
Connection
OwnerThe account OWNER of the repository (https://github.com/OWNER/REPO)
Repository NameThe name of the REPO (https://github.com/OWNER/REPO)
Issue NumberThe number that identifies the issue
BodyThe contents of the comment

Issues List Comments

List issue comments

InputCommentsDefault
Connection
OwnerThe account OWNER of the repository (https://github.com/OWNER/REPO)
Repository NameThe name of the REPO (https://github.com/OWNER/REPO)
Issue NumberThe number that identifies the issue
SinceOnly show notifications updated after the given time
Per PageThe number of results per page (max 100)30
PagePage number of the results to fetch1

Pulls Create

Create a pull request

InputCommentsDefault
Connection
OwnerThe account OWNER of the repository (https://github.com/OWNER/REPO)
Repository NameThe name of the REPO (https://github.com/OWNER/REPO)
TitleThe title of the new pull request
HeadThe name of the branch where your changes are implemented
BaseThe name of the branch you want the changes pulled into
BodyThe contents of the pull request
Maintainer Can ModifyIndicates whether [maintainers can modify](https://docsfalse
DraftIndicates whether the pull request is a draftfalse
Issue

Raw Request

Send raw HTTP request to Github

InputCommentsDefault
Connection
URLInput 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.
MethodThe HTTP method to use.
DataThe HTTP body payload to send to the URL.
Form DataThe Form Data to be sent as a multipart form upload.
File DataFile Data to be sent as a multipart form upload.
Query ParameterA 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.
HeaderA list of headers to send with the request.
Response TypeThe type of data you expect in the response. You can request json, text, or binary data.json
TimeoutThe maximum time that a client will await a response to its request
Debug RequestEnabling this flag will log out the current request.false
Retry Delay (ms)The delay in milliseconds between retries.0
Retry On All ErrorsIf true, retries on all erroneous responses regardless of type.false
Max Retry CountThe maximum number of retries to attempt.0
Use Exponential BackoffSpecifies whether to use a pre-defined exponential backoff strategy for retries.false

Repos Create Webhook

Create a repository webhook

InputCommentsDefault
Connection
OwnerThe account OWNER of the repository (https://github.com/OWNER/REPO)
Repository NameThe name of the REPO (https://github.com/OWNER/REPO)
Callback URLThe URL to send data to
EventsDetermines what events trigger a webhook to fire
Webhook SecretAn optional secret to use to verify webhook authenticity. See https://docs.github.com/en/developers/webhooks-and-events/webhooks/securing-your-webhooks

Repos Delete Instance Webhooks

Delete all webhooks pointed at this instance

InputCommentsDefault
Connection
OwnerThe account OWNER of the repository (https://github.com/OWNER/REPO)
Repository NameThe name of the REPO (https://github.com/OWNER/REPO)

Repos Delete Webhook

Delete a repository webhook by ID

InputCommentsDefault
Connection
OwnerThe account OWNER of the repository (https://github.com/OWNER/REPO)
Repository NameThe name of the REPO (https://github.com/OWNER/REPO)
Hook IDThe unique identifier of the hook

Repos List For Org

List organization repositories

InputCommentsDefault
Connection
OrgThe organization name
TypeSpecifies the types of repositories you want returned
SortThe property to sort the results bycreated
DirectionThe order to sort by
Per PageThe number of results per page (max 100)30
PagePage number of the results to fetch1

Repos List Webhooks

List webhooks of a repository

InputCommentsDefault
Connection
OwnerThe account OWNER of the repository (https://github.com/OWNER/REPO)
Repository NameThe name of the REPO (https://github.com/OWNER/REPO)
Show only instance webhooksShow only webhooks that point to this instancetrue

Users Get By Username

Get a user

InputCommentsDefault
Connection
UsernameThe handle for the GitHub user account