GitHub

GitHub is a web-based platform for version control and collaboration using Git.

Categories: developer-tools

Type: github/v1

Connections

Version: 1

OAuth2 Authorization Code

Properties

Name	Label	Type	Control Type	Description	Required
clientId	Client id	STRING	TEXT		true
clientSecret	Client secret	STRING	TEXT		true

Actions

Add Assignee to Issue

Name: addAssigneesToIssue

Adds an assignees to the specified issue.

Properties

Name	Label	Type	Control Type	Description	Required
repository	Repository	STRING	SELECT		true
issue	Issue	STRING Depends On repository	SELECT	The issue to add assignee to.	true
assignees	Assignees	ARRAY Items [STRING]	MULTI_SELECT	The list of assignees to add to the issue.	true

Output

Type: OBJECT

Properties

Name	Type	Control Type
url	STRING	TEXT
repository_url	STRING	TEXT
id	NUMBER	NUMBER
number	INTEGER	INTEGER
title	STRING	TEXT
state	STRING	TEXT
assignees	ARRAY Items [{STRING(login), STRING(id), STRING(html_url), STRING(type)}]	ARRAY_BUILDER
labels	ARRAY Items [{STRING(id), STRING(name), STRING(description)}]	ARRAY_BUILDER
body	STRING	TEXT

JSON Example

{
  "label" : "Add Assignee to Issue",
  "name" : "addAssigneesToIssue",
  "parameters" : {
    "repository" : "",
    "issue" : "",
    "assignees" : [ "" ]
  },
  "type" : "github/v1/addAssigneesToIssue"
}

Add Labels to Issue

Name: addLabelsToIssue

Adds labels to the specified issue.

Properties

Name	Label	Type	Control Type	Description	Required
repository	Repository	STRING	SELECT		true
issue	Issue	STRING Depends On repository	SELECT	The issue to add labels to.	true
labels	Labels	ARRAY Items [STRING]	MULTI_SELECT	The list of labels to add to the issue.	true

Output

Type: ARRAY

Properties

Name	Type	Control Type
	OBJECT Properties {STRING(id), STRING(name), STRING(description)}	OBJECT_BUILDER

JSON Example

{
  "label" : "Add Labels to Issue",
  "name" : "addLabelsToIssue",
  "parameters" : {
    "repository" : "",
    "issue" : "",
    "labels" : [ "" ]
  },
  "type" : "github/v1/addLabelsToIssue"
}

Create Comment on Issue

Name: createCommentOnIssue

Adds a comment to the specified issue.

Properties

Name	Label	Type	Control Type	Description	Required
repository	Repository	STRING	SELECT		true
issue	Issue	STRING Depends On repository	SELECT	The issue to comment on.	true
body	Comment	STRING	TEXT	The comment to add to the issue.	true

Output

Type: OBJECT

Properties

Name	Type	Control Type
url	STRING	TEXT
repository_url	STRING	TEXT
id	NUMBER	NUMBER
number	INTEGER	INTEGER
title	STRING	TEXT
state	STRING	TEXT
assignees	ARRAY Items [{STRING(login), STRING(id), STRING(html_url), STRING(type)}]	ARRAY_BUILDER
labels	ARRAY Items [{STRING(id), STRING(name), STRING(description)}]	ARRAY_BUILDER
body	STRING	TEXT

JSON Example

{
  "label" : "Create Comment on Issue",
  "name" : "createCommentOnIssue",
  "parameters" : {
    "repository" : "",
    "issue" : "",
    "body" : ""
  },
  "type" : "github/v1/createCommentOnIssue"
}

Create Issue

Name: createIssue

Create Issue in GitHub Repository

Properties

Name	Label	Type	Control Type	Description	Required
repository	Repository	STRING	SELECT	Repository where new issue will be created.	true
title	Title	STRING	TEXT	Title of the issue.	false
body	Description	STRING	TEXT	The description of the issue.	false

Output

Type: OBJECT

Properties

Name	Type	Control Type
url	STRING	TEXT
repository_url	STRING	TEXT
id	NUMBER	NUMBER
number	INTEGER	INTEGER
title	STRING	TEXT
state	STRING	TEXT
assignees	ARRAY Items [{STRING(login), STRING(id), STRING(html_url), STRING(type)}]	ARRAY_BUILDER
labels	ARRAY Items [{STRING(id), STRING(name), STRING(description)}]	ARRAY_BUILDER
body	STRING	TEXT

JSON Example

{
  "label" : "Create Issue",
  "name" : "createIssue",
  "parameters" : {
    "repository" : "",
    "title" : "",
    "body" : ""
  },
  "type" : "github/v1/createIssue"
}

Get Issue

Name: getIssue

Get information from a specific issue

Properties

Name	Label	Type	Control Type	Description	Required
repository	Repository	STRING	SELECT		true
issue	Issue	STRING Depends On repository	SELECT	The issue you want to get details from.	true

Output

Type: OBJECT

Properties

Name	Type	Control Type
url	STRING	TEXT
repository_url	STRING	TEXT
id	NUMBER	NUMBER
number	INTEGER	INTEGER
title	STRING	TEXT
state	STRING	TEXT
assignees	ARRAY Items [{STRING(login), STRING(id), STRING(html_url), STRING(type)}]	ARRAY_BUILDER
labels	ARRAY Items [{STRING(id), STRING(name), STRING(description)}]	ARRAY_BUILDER
body	STRING	TEXT

JSON Example

{
  "label" : "Get Issue",
  "name" : "getIssue",
  "parameters" : {
    "repository" : "",
    "issue" : ""
  },
  "type" : "github/v1/getIssue"
}

List Issues

Name: listIssues

Retrieve issues assigned to the authenticated user across all accessible repositories.

Properties

Name	Label	Type	Control Type	Description	Required
filter	Filter	STRING Options assigned, created, mentioned, subscribed, repos, all	SELECT	Specifies the types of issues to return.	true
state	State	STRING Options open, closed, all	SELECT	Indicates the state of the issues to return.	true

Output

Type: ARRAY

Properties

Name	Type	Control Type
	OBJECT Properties {STRING(url), STRING(repository_url), NUMBER(id), INTEGER(number), STRING(title), STRING(state), [{STRING(login), STRING(id), STRING(html_url), STRING(type)}](assignees), [{STRING(id), STRING(name), STRING(description)}](labels), STRING(body)}	OBJECT_BUILDER

JSON Example

{
  "label" : "List Issues",
  "name" : "listIssues",
  "parameters" : {
    "filter" : "",
    "state" : ""
  },
  "type" : "github/v1/listIssues"
}

List Repository Issues

Name: listRepositoryIssues

Lists issues in a repository. Only open issues will be listed.

Properties

Name	Label	Type	Control Type	Description	Required
repository	Repository	STRING	SELECT	The name of the repository	true

Output

Type: ARRAY

Properties

Name	Type	Control Type
	OBJECT Properties {STRING(url), STRING(repository_url), NUMBER(id), INTEGER(number), STRING(title), STRING(state), [{STRING(login), STRING(id), STRING(html_url), STRING(type)}](assignees), [{STRING(id), STRING(name), STRING(description)}](labels), STRING(body)}	OBJECT_BUILDER

JSON Example

{
  "label" : "List Repository Issues",
  "name" : "listRepositoryIssues",
  "parameters" : {
    "repository" : ""
  },
  "type" : "github/v1/listRepositoryIssues"
}

Star Repository

Name: starRepository

Stars a repository for the authenticated user.

Properties

Name	Label	Type	Control Type	Description	Required
owner	Owner	STRING	TEXT	The account owner of the repository. The name is not case sensitive.	true
repository	Repository	STRING	TEXT	The name of the repository including owner without the .git extension. The name is not case sensitive.	true

JSON Example

{
  "label" : "Star Repository",
  "name" : "starRepository",
  "parameters" : {
    "owner" : "",
    "repository" : ""
  },
  "type" : "github/v1/starRepository"
}

Triggers

New Issue

Name: newIssue

Triggers when a new issue is created.

Type: DYNAMIC_WEBHOOK

Properties

Name	Label	Type	Control Type	Description	Required
repository	Repository	STRING	SELECT		true

Output

Type: OBJECT

Properties

Name	Type	Control Type
issue	OBJECT Properties {STRING(url), STRING(repository_url), NUMBER(id), INTEGER(number), STRING(title), STRING(state), STRING(body)}	OBJECT_BUILDER
sender	OBJECT Properties {STRING(login), INTEGER(id)}	OBJECT_BUILDER
action	STRING	TEXT
starred_at	STRING	TEXT
repository	OBJECT Properties {INTEGER(id), STRING(name), STRING(full_name), {STRING(login), INTEGER(id)}(owner), STRING(visibility), INTEGER(forks), INTEGER(open_issues), STRING(default_branch)}	OBJECT_BUILDER

JSON Example

{
  "label" : "New Issue",
  "name" : "newIssue",
  "parameters" : {
    "repository" : ""
  },
  "type" : "github/v1/newIssue"
}

New Pull Request

Name: newPullRequest

Triggers when a new pull request is created.

Type: DYNAMIC_WEBHOOK

Properties

Name	Label	Type	Control Type	Description	Required
repository	Repository	STRING	SELECT		true

Output

Type: OBJECT

Properties

Name	Type	Control Type
number	INTEGER	INTEGER
pull_request	OBJECT Properties {INTEGER(id), STRING(state), STRING(title), STRING(body), INTEGER(commits)}	OBJECT_BUILDER
sender	OBJECT Properties {STRING(login), INTEGER(id)}	OBJECT_BUILDER
action	STRING	TEXT
repository	OBJECT Properties {INTEGER(id), STRING(name), STRING(full_name), {STRING(login), INTEGER(id)}(owner), STRING(visibility), INTEGER(forks), INTEGER(open_issues), STRING(default_branch)}	OBJECT_BUILDER

JSON Example

{
  "label" : "New Pull Request",
  "name" : "newPullRequest",
  "parameters" : {
    "repository" : ""
  },
  "type" : "github/v1/newPullRequest"
}

Additional instructions

Connection Setup

Login to your GitHub account.
Click on your profile icon in the top right corner.
Select Settings from the dropdown menu.
In the left sidebar, click on Developer settings.
In the left sidebar, click on OAuth Apps.
Click on New OAuth App.
Fill in the required fields:
- Application name: Enter a name for your application (e.g., Test App).
- Homepage URL: Provide the homepage URL for your application (e.g., https://www.bytechef.io/).
- Authorization callback URL: Specify the URL where users will be redirected after authorization (e.g., http://127.0.0.1:5173/callback).
Click Register application.
Click on Generate a new client secret.
Copy the Client ID and Client Secret for later use.