GitHub

GitHub hosts repositories and their pull requests, issues, and commit history. Use this integration to read repository content, automate code-review and issue workflows, and respond to GitHub events. Select an action below for its required repository identifiers, permissions, and inputs.

Usage Instructions

Read and update GitHub repositories, pull requests, issues, and related records. Use trigger mode to start workflows from GitHub events.

Actions

GitHub PR Reader

Fetch PR details including diff and files changed

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
pullNumbernumberYesPull request number
apiKeystringYesGitHub API token
includeFilesbooleanNoWhether to fetch changed-file details from the separate files endpoint

Output

ParameterTypeDescription
userobjectGitHub user object
↳ loginstringGitHub username
↳ idnumberUser ID
↳ avatar_urlstringAvatar image URL
↳ html_urlstringProfile URL
↳ typestringAccount type (User or Organization)
headobjectBranch reference info
↳ labelstringBranch label (owner:branch)
↳ refstringBranch name
↳ shastringCommit SHA
↳ repo_full_namestringFull name (owner/repo) of the branch's repository
baseobjectBranch reference info
↳ labelstringBranch label (owner:branch)
↳ refstringBranch name
↳ shastringCommit SHA
↳ repo_full_namestringFull name (owner/repo) of the branch's repository
idnumberPull request ID
numbernumberPull request number
titlestringPR title
statestringPR state (open/closed)
html_urlstringGitHub web URL
diff_urlstringRaw diff URL
bodystringPR description
mergedbooleanWhether PR is merged
mergeablebooleanWhether PR is mergeable
merged_byobjectGitHub user object
↳ loginstringGitHub username
↳ idnumberUser ID
↳ avatar_urlstringAvatar image URL
↳ html_urlstringProfile URL
↳ typestringAccount type (User or Organization)
commentsnumberNumber of comments
review_commentsnumberNumber of review comments
commitsnumberNumber of commits
additionsnumberLines added
deletionsnumberLines deleted
changed_filesnumberNumber of changed files
created_atstringCreation timestamp
updated_atstringLast update timestamp
closed_atstringClose timestamp
merged_atstringMerge timestamp
filesarrayArray of changed file objects
↳ shastringBlob SHA
↳ filenamestringFile path
↳ statusstringChange status (added/removed/modified/renamed/copied/changed/unchanged)
↳ additionsnumberLines added
↳ deletionsnumberLines deleted
↳ changesnumberTotal line changes
↳ blob_urlstringBlob URL
↳ raw_urlstringRaw file URL
↳ contents_urlstringContents API URL
↳ patchstringDiff patch
↳ previous_filenamestringPrevious filename (for renames)

GitHub PR Commenter

Create comments on GitHub PRs

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
bodystringYesComment content
pullNumbernumberYesPull request number
pathstringNoFile path for review comment
commentTypestringNoType of comment (pr_comment or file_comment)
linenumberNoLine number for review comment
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
userobjectGitHub user object
↳ loginstringGitHub username
↳ idnumberUser ID
↳ avatar_urlstringAvatar image URL
↳ html_urlstringProfile URL
↳ typestringAccount type (User or Organization)
idnumberComment ID
bodystringComment body
html_urlstringGitHub web URL
pathstringFile path (for file comments)
linenumberLine number (for file comments)
sidestringSide (LEFT/RIGHT for diff comments)
commit_idstringCommit SHA
created_atstringCreation timestamp
updated_atstringLast update timestamp

GitHub Repository Info

Retrieve comprehensive GitHub repository metadata including stars, forks, issues, and primary language. Supports both public and private repositories with optional authentication.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
idnumberRepository ID
namestringRepository name
full_namestringFull repository name (owner/repo)
descriptionstringRepository description
html_urlstringGitHub web URL
homepagestringHomepage URL
languagestringPrimary programming language
default_branchstringDefault branch name
visibilitystringRepository visibility (public/private)
privatebooleanWhether the repository is private
forkbooleanWhether this is a fork
archivedbooleanWhether the repository is archived
disabledbooleanWhether the repository is disabled
stargazers_countnumberNumber of stars
watchers_countnumberNumber of watchers
forks_countnumberNumber of forks
open_issues_countnumberNumber of open issues
topicsarrayRepository topics
created_atstringCreation timestamp
updated_atstringLast update timestamp
pushed_atstringLast push timestamp
ownerobjectGitHub user object
↳ loginstringGitHub username
↳ idnumberUser ID
↳ node_idstringGraphQL node ID
↳ avatar_urlstringAvatar image URL
↳ urlstringAPI URL
↳ html_urlstringProfile page URL
↳ typestringUser or Organization
↳ site_adminbooleanGitHub staff indicator
licenseobjectLicense information
↳ keystringLicense key (e.g., mit)
↳ namestringLicense name
↳ spdx_idstringSPDX identifier

GitHub Latest Commit

Retrieve the latest commit from a GitHub repository

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
branchstringNoBranch name (defaults to the repository's default branch)
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
commitobjectCore commit data
↳ urlstringCommit API URL
↳ messagestringCommit message
↳ comment_countnumberNumber of comments
↳ authorobjectGit actor (author/committer)
↳ namestringName
↳ emailstringEmail address
↳ datestringTimestamp (ISO 8601)
↳ committerobjectGit actor (author/committer)
↳ namestringName
↳ emailstringEmail address
↳ datestringTimestamp (ISO 8601)
↳ treeobjectTree object
↳ shastringTree SHA
↳ urlstringTree API URL
↳ verificationobjectSignature verification
↳ verifiedbooleanWhether signature is verified
↳ reasonstringVerification reason
↳ signaturestringGPG signature
↳ payloadstringSigned payload
authorobjectGitHub user object
↳ loginstringGitHub username
↳ idnumberUser ID
↳ node_idstringGraphQL node ID
↳ avatar_urlstringAvatar image URL
↳ urlstringAPI URL
↳ html_urlstringProfile page URL
↳ typestringUser or Organization
↳ site_adminbooleanGitHub staff indicator
committerobjectGitHub user object
↳ loginstringGitHub username
↳ idnumberUser ID
↳ node_idstringGraphQL node ID
↳ avatar_urlstringAvatar image URL
↳ urlstringAPI URL
↳ html_urlstringProfile page URL
↳ typestringUser or Organization
↳ site_adminbooleanGitHub staff indicator
shastringCommit SHA
html_urlstringGitHub web URL

GitHub Issue Comment Creator

Create a comment on a GitHub issue

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
issue_numbernumberYesIssue number
bodystringYesComment content
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
userobjectGitHub user object
↳ loginstringGitHub username
↳ idnumberUser ID
↳ avatar_urlstringAvatar image URL
↳ html_urlstringProfile URL
↳ typestringAccount type (User or Organization)
idnumberComment ID
bodystringComment body
html_urlstringGitHub web URL
pathstringFile path (for file comments)
linenumberLine number (for file comments)
sidestringSide (LEFT/RIGHT for diff comments)
commit_idstringCommit SHA
created_atstringCreation timestamp
updated_atstringLast update timestamp

GitHub Issue Comments Lister

List all comments on a GitHub issue

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
issue_numbernumberYesIssue number
sincestringNoOnly show comments updated after this ISO 8601 timestamp
per_pagenumberNoNumber of results per page (max 100)
pagenumberNoPage number
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
itemsarrayArray of comment objects
↳ userobjectGitHub user object
↳ loginstringGitHub username
↳ idnumberUser ID
↳ avatar_urlstringAvatar image URL
↳ html_urlstringProfile URL
↳ typestringAccount type (User or Organization)
↳ idnumberComment ID
↳ bodystringComment body
↳ html_urlstringGitHub web URL
↳ pathstringFile path (for file comments)
↳ linenumberLine number (for file comments)
↳ sidestringSide (LEFT/RIGHT for diff comments)
↳ commit_idstringCommit SHA
↳ created_atstringCreation timestamp
↳ updated_atstringLast update timestamp
countnumberNumber of comments returned

GitHub Comment Updater

Update an existing comment on a GitHub issue or pull request

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
comment_idnumberYesComment ID
bodystringYesUpdated comment content
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
userobjectGitHub user object
↳ loginstringGitHub username
↳ idnumberUser ID
↳ avatar_urlstringAvatar image URL
↳ html_urlstringProfile URL
↳ typestringAccount type (User or Organization)
idnumberComment ID
bodystringComment body
html_urlstringGitHub web URL
pathstringFile path (for file comments)
linenumberLine number (for file comments)
sidestringSide (LEFT/RIGHT for diff comments)
commit_idstringCommit SHA
created_atstringCreation timestamp
updated_atstringLast update timestamp

GitHub Comment Deleter

Delete a comment on a GitHub issue or pull request

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
comment_idnumberYesComment ID
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
deletedbooleanWhether deletion was successful
comment_idnumberDeleted comment ID

GitHub PR Review Comments Lister

List all review comments on a GitHub pull request

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
pullNumbernumberYesPull request number
sortstringNoSort by created or updated
directionstringNoSort direction (asc or desc)
sincestringNoOnly show comments updated after this ISO 8601 timestamp
per_pagenumberNoNumber of results per page (max 100)
pagenumberNoPage number
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
itemsarrayArray of review comment objects
↳ userobjectGitHub user object
↳ loginstringGitHub username
↳ idnumberUser ID
↳ avatar_urlstringAvatar image URL
↳ html_urlstringProfile URL
↳ typestringAccount type (User or Organization)
↳ idnumberComment ID
↳ node_idstringGraphQL node ID
↳ bodystringComment body
↳ html_urlstringGitHub web URL
↳ pathstringFile path
↳ positionnumberPosition in diff
↳ linenumberLine number
↳ sidestringSide (LEFT/RIGHT)
↳ commit_idstringCommit SHA
↳ original_commit_idstringOriginal commit SHA
↳ diff_hunkstringDiff hunk context
↳ created_atstringCreation timestamp
↳ updated_atstringLast update timestamp
countnumberNumber of comments returned

GitHub Create Pull Request

Create a new pull request in a GitHub repository

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
titlestringYesPull request title
headstringYesThe name of the branch where your changes are implemented
basestringYesThe name of the branch you want the changes pulled into
bodystringNoPull request description (Markdown)
draftbooleanNoCreate as draft pull request
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
idnumberPull request ID
numbernumberPull request number
titlestringPR title
statestringPR state
html_urlstringGitHub web URL
bodystringPR description
userjsonUser who created the PR
headjsonHead branch info
basejsonBase branch info
draftbooleanWhether PR is a draft
mergedbooleanWhether PR is merged
mergeablebooleanWhether PR is mergeable
created_atstringCreation timestamp
updated_atstringLast update timestamp

GitHub Update Pull Request

Update an existing pull request in a GitHub repository

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
pullNumbernumberYesPull request number
titlestringNoNew pull request title
bodystringNoNew pull request description (Markdown)
statestringNoNew state (open or closed)
basestringNoNew base branch name
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
idnumberPR ID
numbernumberPR number
titlestringPR title
statestringPR state
html_urlstringGitHub web URL
bodystringPR description
userjsonUser who created the PR
headjsonHead branch info
basejsonBase branch info
draftbooleanWhether PR is a draft
mergedbooleanWhether PR is merged
created_atstringCreation timestamp
updated_atstringLast update timestamp

GitHub Merge Pull Request

Merge a pull request in a GitHub repository

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
pullNumbernumberYesPull request number
commit_titlestringNoTitle for the merge commit
commit_messagestringNoExtra detail to append to merge commit message
merge_methodstringNoMerge method: merge, squash, or rebase
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
shastringMerge commit SHA
mergedbooleanWhether merge was successful
messagestringResponse message

GitHub List Pull Requests

List pull requests in a GitHub repository

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
statestringNoFilter by state: open, closed, or all
headstringNoFilter by head user or branch name (format: user:ref-name or organization:ref-name)
basestringNoFilter by base branch name
sortstringNoSort by: created, updated, popularity, or long-running
directionstringNoSort direction: asc or desc
per_pagenumberNoResults per page (max 100)
pagenumberNoPage number
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
itemsarrayArray of pull request objects
↳ userobjectGitHub user object
↳ loginstringGitHub username
↳ idnumberUser ID
↳ avatar_urlstringAvatar image URL
↳ html_urlstringProfile URL
↳ typestringAccount type (User or Organization)
↳ headobjectBranch reference info
↳ labelstringBranch label (owner:branch)
↳ refstringBranch name
↳ shastringCommit SHA
↳ baseobjectBranch reference info
↳ labelstringBranch label (owner:branch)
↳ refstringBranch name
↳ shastringCommit SHA
↳ idnumberPull request ID
↳ node_idstringGraphQL node ID
↳ numbernumberPull request number
↳ titlestringPR title
↳ statestringPR state (open/closed)
↳ html_urlstringGitHub web URL
↳ diff_urlstringDiff URL
↳ bodystringPR description
↳ lockedbooleanWhether PR is locked
↳ draftbooleanWhether PR is a draft
↳ created_atstringCreation timestamp
↳ updated_atstringLast update timestamp
↳ closed_atstringClose timestamp
↳ merged_atstringMerge timestamp
countnumberNumber of PRs returned

GitHub Get PR Files

Get the list of files changed in a pull request

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
pullNumbernumberYesPull request number
per_pagenumberNoResults per page (max 100)
pagenumberNoPage number
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
itemsarrayArray of changed file objects
↳ shastringBlob SHA
↳ filenamestringFile path
↳ statusstringChange status (added/removed/modified/renamed/copied/changed/unchanged)
↳ additionsnumberLines added
↳ deletionsnumberLines deleted
↳ changesnumberTotal line changes
↳ blob_urlstringBlob URL
↳ raw_urlstringRaw file URL
↳ contents_urlstringContents API URL
↳ patchstringDiff patch
↳ previous_filenamestringPrevious filename (for renames)
countnumberTotal number of files

GitHub Close Pull Request

Close a pull request in a GitHub repository

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
pullNumbernumberYesPull request number
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
idnumberPR ID
numbernumberPR number
titlestringPR title
statestringPR state (closed)
html_urlstringGitHub web URL
bodystringPR description
userjsonUser who created the PR
headjsonHead branch info
basejsonBase branch info
draftbooleanWhether PR is a draft
mergedbooleanWhether PR is merged
closed_atstringClose timestamp
created_atstringCreation timestamp
updated_atstringLast update timestamp

GitHub Request Reviewers

Request reviewers for a pull request

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
pullNumbernumberYesPull request number
reviewersstringNoComma-separated list of user logins to request reviews from (at least one of reviewers or team_reviewers is required)
team_reviewersstringNoComma-separated list of team slugs to request reviews from
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
idnumberPR ID
numbernumberPR number
titlestringPR title
html_urlstringGitHub web URL
requested_reviewersarrayArray of requested reviewer objects
requested_teamsarrayArray of requested team objects

GitHub Create PR Review

Submit a review for a pull request. Use APPROVE, REQUEST_CHANGES, or COMMENT. A body is required for REQUEST_CHANGES and COMMENT reviews.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
pullNumbernumberYesPull request number
eventstringYesThe review action to perform: APPROVE, REQUEST_CHANGES, or COMMENT
bodystringNoThe body text of the review (required for REQUEST_CHANGES and COMMENT)
commit_idstringNoThe SHA of the commit that needs a review (required when posting inline comments; defaults to the most recent commit otherwise)
commentsarrayNoOptional inline comments with required path, body, line, and side fields
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
idnumberReview ID
userobjectGitHub user object
↳ loginstringGitHub username
↳ idnumberUser ID
↳ avatar_urlstringAvatar image URL
↳ html_urlstringProfile URL
↳ typestringAccount type (User or Organization)
bodystringReview body text
statestringReview state (APPROVED/CHANGES_REQUESTED/COMMENTED)
html_urlstringGitHub web URL for the review
pull_request_urlstringAPI URL of the reviewed pull request
commit_idstringSHA of the reviewed commit
submitted_atstringReview submission timestamp

GitHub Get File Content

Get the content of a file from a GitHub repository. Supports files up to 1MB. Content is returned decoded and human-readable.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
pathstringYesPath to the file in the repository (e.g., "src/index.ts")
refstringNoBranch name, tag, or commit SHA (defaults to repository default branch)
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
namestringFile name
pathstringFull path in repository
shastringGit blob SHA
sizenumberFile size in bytes
typestringContent type (file/dir/symlink/submodule)
contentstringDecoded file content
encodingstringContent encoding
html_urlstringGitHub web URL
download_urlstringDirect download URL
git_urlstringGit blob API URL
_linksjsonRelated links
filefileDownloaded file stored in execution files

GitHub Create File

Create a new file in a GitHub repository. The file content will be automatically Base64 encoded. Supports files up to 1MB.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
pathstringYesPath where the file will be created (e.g., "src/newfile.ts")
messagestringYesCommit message for this file creation
contentstringYesFile content (plain text, will be Base64 encoded automatically)
branchstringNoBranch to create the file in (defaults to repository default branch)
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
contentjsonCreated file content info
commitjsonCommit information

GitHub Update File

Update an existing file in a GitHub repository. Requires the file SHA. Content will be automatically Base64 encoded. Supports files up to 1MB.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
pathstringYesPath to the file to update (e.g., "src/index.ts")
messagestringYesCommit message for this file update
contentstringYesNew file content (plain text, will be Base64 encoded automatically)
shastringYesThe blob SHA of the file being replaced (get from github_get_file_content)
branchstringNoBranch to update the file in (defaults to repository default branch)
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
contentjsonUpdated file content info
commitjsonCommit information

GitHub Delete File

Delete a file from a GitHub repository. Requires the file SHA. This operation cannot be undone through the API.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
pathstringYesPath to the file to delete (e.g., "src/oldfile.ts")
messagestringYesCommit message for this file deletion
shastringYesThe blob SHA of the file being deleted (get from github_get_file_content)
branchstringNoBranch to delete the file from (defaults to repository default branch)
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
contentjsonFile content info (null for delete)
commitjsonCommit information

GitHub Get Repository Tree

Get the contents of a directory in a GitHub repository. Returns a list of files and subdirectories. Use empty path or omit to get root directory contents.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
pathstringNoDirectory path (e.g., "src/components"). Leave empty for root directory.
refstringNoBranch name, tag, or commit SHA (defaults to repository default branch)
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
itemsarrayArray of file/directory objects
↳ namestringFile or directory name
↳ pathstringFull path in repository
↳ shastringGit object SHA
↳ sizenumberSize in bytes
↳ typestringType (file/dir/symlink/submodule)
↳ html_urlstringGitHub web URL
↳ download_urlstringDirect download URL
↳ git_urlstringGit blob API URL
↳ urlstringAPI URL for this item
↳ _linksjsonRelated links
countnumberTotal number of items

GitHub Get README

Get the preferred README for a GitHub repository, with its content decoded to plain text.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
refstringNoThe name of the commit/branch/tag to read the README from (defaults to the repository default branch)
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
namestringREADME file name
pathstringREADME file path
shastringBlob SHA of the README
sizenumberFile size in bytes
encodingstringOriginal content encoding from the API
html_urlstringGitHub web URL for the README
download_urlstringRaw download URL for the README
contentstringDecoded README text content

GitHub List Tags

List tags for a GitHub repository. Returns tag names with their commit SHA and download URLs.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
per_pagenumberNoNumber of results per page (max 100)
pagenumberNoPage number of the results to fetch
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
itemsarrayArray of tag objects
↳ namestringTag name
↳ zipball_urlstringZipball download URL
↳ tarball_urlstringTarball download URL
↳ node_idstringNode ID
↳ commitobjectCommit the tag points to
↳ shastringCommit SHA
↳ urlstringCommit API URL
countnumberNumber of tags returned

GitHub List Branches

List all branches in a GitHub repository. Optionally filter by protected status and control pagination.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
protectedbooleanNoFilter branches by protection status
per_pagenumberNoNumber of results per page (max 100, default 30)
pagenumberNoPage number for pagination (default 1)
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
itemsarrayArray of branch objects
↳ namestringBranch name
↳ commitobjectCommit reference info
↳ shastringCommit SHA
↳ urlstringCommit API URL
↳ protectedbooleanWhether branch is protected
countnumberNumber of branches returned

GitHub Get Branch

Get detailed information about a specific branch in a GitHub repository, including commit details and protection status.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
branchstringYesBranch name
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
namestringBranch name
commitobjectCommit reference info
↳ shastringCommit SHA
↳ urlstringCommit API URL
protectedbooleanWhether branch is protected
protectionjsonProtection settings object
protection_urlstringURL to protection settings

GitHub Create Branch

Create a new branch in a GitHub repository by creating a git reference pointing to a specific commit SHA.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
branchstringYesName of the branch to create
shastringYesCommit SHA to point the branch to
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
refstringFull reference name (refs/heads/branch)
node_idstringGit ref node ID
urlstringAPI URL for the reference
objectjsonGit object with type and sha

GitHub Delete Branch

Delete a branch from a GitHub repository by removing its git reference. Protected branches cannot be deleted.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
branchstringYesName of the branch to delete
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
deletedbooleanWhether the branch was deleted
branchstringName of the deleted branch

GitHub Get Branch Protection

Get the branch protection rules for a specific branch, including status checks, review requirements, and restrictions.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
branchstringYesBranch name
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
urlstringProtection settings URL
required_status_checksjsonStatus check requirements
enforce_adminsjsonAdmin enforcement settings
required_pull_request_reviewsjsonPR review requirements
restrictionsjsonPush restrictions
required_linear_historyjsonLinear history requirement
allow_force_pushesjsonForce push settings
allow_deletionsjsonDeletion settings
block_creationsjsonCreation blocking settings
required_conversation_resolutionjsonConversation resolution requirement
required_signaturesjsonSignature requirements

GitHub Update Branch Protection

Update branch protection rules for a specific branch, including status checks, review requirements, admin enforcement, and push restrictions.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
branchstringYesBranch name
required_status_checksobjectNoRequired status check configuration. Object with strict (boolean) and contexts (string array). Omit to disable status checks — GitHub receives an explicit null.
enforce_adminsbooleanNoWhether to enforce restrictions for administrators. Omit to disable admin enforcement — GitHub receives an explicit null.
required_pull_request_reviewsobjectNoPR review requirements. Object with optional required_approving_review_count, dismiss_stale_reviews, require_code_owner_reviews. Omit to disable review requirements — GitHub receives an explicit null.
restrictionsobjectNoPush restrictions, available only for organization-owned repositories. Object with users (string array), teams (string array) and optional apps (string array). Omit to disable push restrictions — GitHub receives an explicit null.
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
urlstringProtection settings URL
required_status_checksjsonStatus check requirements
enforce_adminsjsonAdmin enforcement settings
required_pull_request_reviewsjsonPR review requirements
restrictionsjsonPush restrictions
required_linear_historyjsonLinear history requirement
allow_force_pushesjsonForce push settings
allow_deletionsjsonDeletion settings
block_creationsjsonCreation blocking settings
required_conversation_resolutionjsonConversation resolution requirement
required_signaturesjsonSignature requirements

GitHub Create Issue

Create a new issue in a GitHub repository

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
titlestringYesIssue title
bodystringNoIssue description/body
assigneesstringNoComma-separated list of usernames to assign to this issue
labelsstringNoComma-separated list of label names to add to this issue
milestonenumberNoMilestone number to associate with this issue
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
userobjectGitHub user object
↳ loginstringGitHub username
↳ idnumberUser ID
↳ avatar_urlstringAvatar image URL
↳ html_urlstringProfile URL
↳ typestringAccount type (User or Organization)
idnumberIssue ID
numbernumberIssue number
titlestringIssue title
statestringIssue state (open/closed)
html_urlstringGitHub web URL
bodystringIssue body/description
created_atstringCreation timestamp
updated_atstringLast update timestamp
closed_atstringClose timestamp
state_reasonstringState reason (completed/not_planned)
labelsarrayArray of label objects
↳ idnumberLabel ID
↳ node_idstringGraphQL node ID
↳ urlstringAPI URL
↳ namestringLabel name
↳ descriptionstringLabel description
↳ colorstringHex color code (without #)
↳ defaultbooleanWhether this is a default label
assigneesarrayArray of assignee objects
↳ loginstringGitHub username
↳ idnumberUser ID
↳ avatar_urlstringAvatar image URL
↳ html_urlstringProfile URL
↳ typestringAccount type (User or Organization)
milestoneobjectGitHub milestone object
↳ idnumberMilestone ID
↳ node_idstringGraphQL node ID
↳ numbernumberMilestone number
↳ titlestringMilestone title
↳ descriptionstringMilestone description
↳ statestringState (open or closed)
↳ urlstringAPI URL
↳ html_urlstringGitHub web URL
↳ labels_urlstringLabels API URL
↳ due_onstringDue date (ISO 8601)
↳ open_issuesnumberNumber of open issues
↳ closed_issuesnumberNumber of closed issues
↳ created_atstringCreation timestamp
↳ updated_atstringLast update timestamp
↳ closed_atstringClose timestamp

GitHub Update Issue

Update an existing issue in a GitHub repository

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
issue_numbernumberYesIssue number
titlestringNoNew issue title
bodystringNoNew issue description/body
statestringNoIssue state (open or closed)
labelsarrayNoArray of label names (replaces all existing labels)
assigneesarrayNoArray of usernames (replaces all existing assignees)
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
userobjectGitHub user object
↳ loginstringGitHub username
↳ idnumberUser ID
↳ avatar_urlstringAvatar image URL
↳ html_urlstringProfile URL
↳ typestringAccount type (User or Organization)
idnumberIssue ID
numbernumberIssue number
titlestringIssue title
statestringIssue state (open/closed)
html_urlstringGitHub web URL
bodystringIssue body/description
created_atstringCreation timestamp
updated_atstringLast update timestamp
closed_atstringClose timestamp
state_reasonstringState reason (completed/not_planned)
labelsarrayArray of label objects
↳ idnumberLabel ID
↳ node_idstringGraphQL node ID
↳ urlstringAPI URL
↳ namestringLabel name
↳ descriptionstringLabel description
↳ colorstringHex color code (without #)
↳ defaultbooleanWhether this is a default label
assigneesarrayArray of assignee objects
↳ loginstringGitHub username
↳ idnumberUser ID
↳ avatar_urlstringAvatar image URL
↳ html_urlstringProfile URL
↳ typestringAccount type (User or Organization)
milestoneobjectGitHub milestone object
↳ idnumberMilestone ID
↳ node_idstringGraphQL node ID
↳ numbernumberMilestone number
↳ titlestringMilestone title
↳ descriptionstringMilestone description
↳ statestringState (open or closed)
↳ urlstringAPI URL
↳ html_urlstringGitHub web URL
↳ labels_urlstringLabels API URL
↳ due_onstringDue date (ISO 8601)
↳ open_issuesnumberNumber of open issues
↳ closed_issuesnumberNumber of closed issues
↳ created_atstringCreation timestamp
↳ updated_atstringLast update timestamp
↳ closed_atstringClose timestamp

GitHub List Issues

List issues in a GitHub repository. Note: This includes pull requests as PRs are considered issues in GitHub

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
statestringNoFilter by state: open, closed, or all (default: open)
assigneestringNoFilter by assignee username
creatorstringNoFilter by creator username
labelsstringNoComma-separated list of label names to filter by
sortstringNoSort by: created, updated, or comments (default: created)
directionstringNoSort direction: asc or desc (default: desc)
per_pagenumberNoResults per page (max 100, default: 30)
pagenumberNoPage number (default: 1)
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
itemsarrayArray of issue objects from GitHub API
↳ idnumberLabel ID
↳ node_idstringGraphQL node ID
↳ urlstringAPI URL
↳ namestringLabel name
↳ descriptionstringLabel description
↳ colorstringHex color code (without #)
↳ defaultbooleanWhether this is a default label
countnumberNumber of issues returned

GitHub Get Issue

Get detailed information about a specific issue in a GitHub repository

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
issue_numbernumberYesIssue number
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
userobjectGitHub user object
↳ loginstringGitHub username
↳ idnumberUser ID
↳ avatar_urlstringAvatar image URL
↳ html_urlstringProfile URL
↳ typestringAccount type (User or Organization)
idnumberIssue ID
numbernumberIssue number
titlestringIssue title
statestringIssue state (open/closed)
html_urlstringGitHub web URL
bodystringIssue body/description
created_atstringCreation timestamp
updated_atstringLast update timestamp
closed_atstringClose timestamp
state_reasonstringState reason (completed/not_planned)
labelsarrayArray of label objects
↳ idnumberLabel ID
↳ node_idstringGraphQL node ID
↳ urlstringAPI URL
↳ namestringLabel name
↳ descriptionstringLabel description
↳ colorstringHex color code (without #)
↳ defaultbooleanWhether this is a default label
assigneesarrayArray of assignee objects
↳ loginstringGitHub username
↳ idnumberUser ID
↳ avatar_urlstringAvatar image URL
↳ html_urlstringProfile URL
↳ typestringAccount type (User or Organization)
milestoneobjectGitHub milestone object
↳ idnumberMilestone ID
↳ node_idstringGraphQL node ID
↳ numbernumberMilestone number
↳ titlestringMilestone title
↳ descriptionstringMilestone description
↳ statestringState (open or closed)
↳ urlstringAPI URL
↳ html_urlstringGitHub web URL
↳ labels_urlstringLabels API URL
↳ due_onstringDue date (ISO 8601)
↳ open_issuesnumberNumber of open issues
↳ closed_issuesnumberNumber of closed issues
↳ created_atstringCreation timestamp
↳ updated_atstringLast update timestamp
↳ closed_atstringClose timestamp
closed_byobjectUser who closed the issue
↳ loginstringGitHub username
↳ idnumberUser ID
↳ avatar_urlstringAvatar image URL
↳ html_urlstringProfile URL
↳ typestringAccount type (User or Organization)

GitHub Close Issue

Close an issue in a GitHub repository

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
issue_numbernumberYesIssue number
state_reasonstringNoReason for closing: completed or not_planned
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
userobjectGitHub user object
↳ loginstringGitHub username
↳ idnumberUser ID
↳ avatar_urlstringAvatar image URL
↳ html_urlstringProfile URL
↳ typestringAccount type (User or Organization)
idnumberIssue ID
numbernumberIssue number
titlestringIssue title
statestringIssue state (open/closed)
html_urlstringGitHub web URL
bodystringIssue body/description
created_atstringCreation timestamp
updated_atstringLast update timestamp
closed_atstringClose timestamp
state_reasonstringState reason (completed/not_planned)
labelsarrayArray of label objects
↳ idnumberLabel ID
↳ node_idstringGraphQL node ID
↳ urlstringAPI URL
↳ namestringLabel name
↳ descriptionstringLabel description
↳ colorstringHex color code (without #)
↳ defaultbooleanWhether this is a default label
assigneesarrayArray of assignee objects
↳ loginstringGitHub username
↳ idnumberUser ID
↳ avatar_urlstringAvatar image URL
↳ html_urlstringProfile URL
↳ typestringAccount type (User or Organization)

GitHub Add Labels

Add labels to an issue in a GitHub repository

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
issue_numbernumberYesIssue number
labelsstringYesComma-separated list of label names to add to the issue
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
itemsarrayArray of label objects on the issue
↳ idnumberLabel ID
↳ namestringLabel name
↳ colorstringLabel color
↳ descriptionstringLabel description
countnumberNumber of labels

GitHub Remove Label

Remove a label from an issue in a GitHub repository

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
issue_numbernumberYesIssue number
namestringYesLabel name to remove
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
itemsarrayRemaining labels on the issue
↳ idnumberLabel ID
↳ namestringLabel name
↳ colorstringLabel color
↳ descriptionstringLabel description
countnumberNumber of remaining labels

GitHub Add Assignees

Add assignees to an issue in a GitHub repository

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
issue_numbernumberYesIssue number
assigneesstringYesComma-separated list of usernames to assign to the issue
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
idnumberIssue ID
numbernumberIssue number
titlestringIssue title
statestringIssue state
html_urlstringGitHub web URL
bodystringIssue body
userjsonIssue creator
labelsarrayArray of label objects
assigneesarrayArray of assignee objects
created_atstringCreation timestamp
updated_atstringLast update timestamp

GitHub Create Release

Create a new release for a GitHub repository. Specify tag name, target commit, title, description, and whether it should be a draft or prerelease.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
tag_namestringYesThe name of the tag for this release
target_commitishstringNoSpecifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Defaults to the repository default branch.
namestringNoThe name of the release
bodystringNoText describing the contents of the release (markdown supported)
draftbooleanNotrue to create a draft (unpublished) release, false to create a published one
prereleasebooleanNotrue to identify the release as a prerelease, false to identify as a full release
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
authorobjectGitHub user object
↳ loginstringGitHub username
↳ idnumberUser ID
↳ avatar_urlstringAvatar image URL
↳ html_urlstringProfile URL
↳ typestringAccount type (User or Organization)
idnumberRelease ID
node_idstringGraphQL node ID
tag_namestringGit tag name
namestringRelease name
bodystringRelease notes (markdown)
html_urlstringGitHub web URL
tarball_urlstringSource tarball URL
zipball_urlstringSource zipball URL
draftbooleanWhether this is a draft release
prereleasebooleanWhether this is a prerelease
target_commitishstringTarget branch or commit SHA
created_atstringCreation timestamp
published_atstringPublication timestamp
assetsarrayRelease assets
↳ uploaderobjectGitHub user object
↳ loginstringGitHub username
↳ idnumberUser ID
↳ avatar_urlstringAvatar image URL
↳ html_urlstringProfile URL
↳ typestringAccount type (User or Organization)
↳ idnumberAsset ID
↳ node_idstringGraphQL node ID
↳ namestringAsset filename
↳ labelstringAsset label
↳ statestringAsset state (uploaded/open)
↳ content_typestringMIME type
↳ sizenumberFile size in bytes
↳ download_countnumberNumber of downloads
↳ browser_download_urlstringDirect download URL
↳ created_atstringUpload timestamp
↳ updated_atstringLast update timestamp

GitHub Update Release

Update an existing GitHub release. Modify tag name, target commit, title, description, draft status, or prerelease status.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
release_idnumberYesThe unique identifier of the release
tag_namestringNoThe name of the tag
target_commitishstringNoSpecifies the commitish value for where the tag is created from
namestringNoThe name of the release
bodystringNoText describing the contents of the release (markdown supported)
draftbooleanNotrue to set as draft, false to publish
prereleasebooleanNotrue to identify as a prerelease, false for a full release
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
authorobjectGitHub user object
↳ loginstringGitHub username
↳ idnumberUser ID
↳ avatar_urlstringAvatar image URL
↳ html_urlstringProfile URL
↳ typestringAccount type (User or Organization)
idnumberRelease ID
node_idstringGraphQL node ID
tag_namestringGit tag name
namestringRelease name
bodystringRelease notes (markdown)
html_urlstringGitHub web URL
tarball_urlstringSource tarball URL
zipball_urlstringSource zipball URL
draftbooleanWhether this is a draft release
prereleasebooleanWhether this is a prerelease
target_commitishstringTarget branch or commit SHA
created_atstringCreation timestamp
published_atstringPublication timestamp
assetsarrayRelease assets
↳ uploaderobjectGitHub user object
↳ loginstringGitHub username
↳ idnumberUser ID
↳ avatar_urlstringAvatar image URL
↳ html_urlstringProfile URL
↳ typestringAccount type (User or Organization)
↳ idnumberAsset ID
↳ node_idstringGraphQL node ID
↳ namestringAsset filename
↳ labelstringAsset label
↳ statestringAsset state (uploaded/open)
↳ content_typestringMIME type
↳ sizenumberFile size in bytes
↳ download_countnumberNumber of downloads
↳ browser_download_urlstringDirect download URL
↳ created_atstringUpload timestamp
↳ updated_atstringLast update timestamp

GitHub List Releases

List all releases for a GitHub repository. Returns release information including tags, names, and download URLs.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
per_pagenumberNoNumber of results per page (max 100)
pagenumberNoPage number of the results to fetch
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
itemsarrayArray of release objects
↳ authorobjectGitHub user object
↳ loginstringGitHub username
↳ idnumberUser ID
↳ avatar_urlstringAvatar image URL
↳ html_urlstringProfile URL
↳ typestringAccount type (User or Organization)
↳ idnumberRelease ID
↳ node_idstringGraphQL node ID
↳ tag_namestringGit tag name
↳ namestringRelease name
↳ bodystringRelease notes (markdown)
↳ html_urlstringGitHub web URL
↳ tarball_urlstringSource tarball URL
↳ zipball_urlstringSource zipball URL
↳ draftbooleanWhether this is a draft release
↳ prereleasebooleanWhether this is a prerelease
↳ target_commitishstringTarget branch or commit SHA
↳ created_atstringCreation timestamp
↳ published_atstringPublication timestamp
↳ assetsarrayRelease assets
↳ uploaderobjectGitHub user object
↳ loginstringGitHub username
↳ idnumberUser ID
↳ avatar_urlstringAvatar image URL
↳ html_urlstringProfile URL
↳ typestringAccount type (User or Organization)
↳ idnumberAsset ID
↳ node_idstringGraphQL node ID
↳ namestringAsset filename
↳ labelstringAsset label
↳ statestringAsset state (uploaded/open)
↳ content_typestringMIME type
↳ sizenumberFile size in bytes
↳ download_countnumberNumber of downloads
↳ browser_download_urlstringDirect download URL
↳ created_atstringUpload timestamp
↳ updated_atstringLast update timestamp
countnumberNumber of releases returned

GitHub Get Release

Get detailed information about a specific GitHub release by ID. Returns release metadata including assets and download URLs.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
release_idnumberYesThe unique identifier of the release
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
authorobjectGitHub user object
↳ loginstringGitHub username
↳ idnumberUser ID
↳ avatar_urlstringAvatar image URL
↳ html_urlstringProfile URL
↳ typestringAccount type (User or Organization)
idnumberRelease ID
node_idstringGraphQL node ID
tag_namestringGit tag name
namestringRelease name
bodystringRelease notes (markdown)
html_urlstringGitHub web URL
tarball_urlstringSource tarball URL
zipball_urlstringSource zipball URL
draftbooleanWhether this is a draft release
prereleasebooleanWhether this is a prerelease
target_commitishstringTarget branch or commit SHA
created_atstringCreation timestamp
published_atstringPublication timestamp
assetsarrayRelease assets
↳ uploaderobjectGitHub user object
↳ loginstringGitHub username
↳ idnumberUser ID
↳ avatar_urlstringAvatar image URL
↳ html_urlstringProfile URL
↳ typestringAccount type (User or Organization)
↳ idnumberAsset ID
↳ node_idstringGraphQL node ID
↳ namestringAsset filename
↳ labelstringAsset label
↳ statestringAsset state (uploaded/open)
↳ content_typestringMIME type
↳ sizenumberFile size in bytes
↳ download_countnumberNumber of downloads
↳ browser_download_urlstringDirect download URL
↳ created_atstringUpload timestamp
↳ updated_atstringLast update timestamp

GitHub Get Latest Release

Get the latest published, non-draft, non-prerelease release for a GitHub repository. Returns release metadata including assets and download URLs.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
authorobjectGitHub user object
↳ loginstringGitHub username
↳ idnumberUser ID
↳ avatar_urlstringAvatar image URL
↳ html_urlstringProfile URL
↳ typestringAccount type (User or Organization)
idnumberRelease ID
node_idstringGraphQL node ID
tag_namestringGit tag name
namestringRelease name
bodystringRelease notes (markdown)
html_urlstringGitHub web URL
tarball_urlstringSource tarball URL
zipball_urlstringSource zipball URL
draftbooleanWhether this is a draft release
prereleasebooleanWhether this is a prerelease
target_commitishstringTarget branch or commit SHA
created_atstringCreation timestamp
published_atstringPublication timestamp
assetsarrayRelease assets
↳ uploaderobjectGitHub user object
↳ loginstringGitHub username
↳ idnumberUser ID
↳ avatar_urlstringAvatar image URL
↳ html_urlstringProfile URL
↳ typestringAccount type (User or Organization)
↳ idnumberAsset ID
↳ node_idstringGraphQL node ID
↳ namestringAsset filename
↳ labelstringAsset label
↳ statestringAsset state (uploaded/open)
↳ content_typestringMIME type
↳ sizenumberFile size in bytes
↳ download_countnumberNumber of downloads
↳ browser_download_urlstringDirect download URL
↳ created_atstringUpload timestamp
↳ updated_atstringLast update timestamp

GitHub Delete Release

Delete a GitHub release by ID. This permanently removes the release but does not delete the associated Git tag.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
release_idnumberYesThe unique identifier of the release to delete
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
deletedbooleanWhether the release was deleted
release_idnumberID of the deleted release

GitHub List Workflows

List all workflows in a GitHub repository. Returns workflow details including ID, name, path, state, and badge URL.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
per_pagenumberNoNumber of results per page (default: 30, max: 100)
pagenumberNoPage number of results to fetch (default: 1)
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
total_countnumberTotal number of workflows
itemsarrayArray of workflow objects
↳ idnumberWorkflow ID
↳ node_idstringGraphQL node ID
↳ namestringWorkflow name
↳ pathstringPath to workflow file
↳ statestringWorkflow state (active/disabled_manually/disabled_inactivity)
↳ html_urlstringGitHub web URL
↳ badge_urlstringStatus badge URL
↳ urlstringAPI URL
↳ created_atstringCreation timestamp
↳ updated_atstringLast update timestamp
↳ deleted_atstringDeletion timestamp

GitHub Get Workflow

Get details of a specific GitHub Actions workflow by ID or filename. Returns workflow information including name, path, state, and badge URL.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
workflow_idstringYesWorkflow ID (number) or workflow filename (e.g., "main.yaml")
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
idnumberWorkflow ID
node_idstringGraphQL node ID
namestringWorkflow name
pathstringPath to workflow file
statestringWorkflow state (active/disabled_manually/disabled_inactivity)
html_urlstringGitHub web URL
badge_urlstringStatus badge URL
urlstringAPI URL
created_atstringCreation timestamp
updated_atstringLast update timestamp
deleted_atstringDeletion timestamp

GitHub Trigger Workflow

Trigger a workflow dispatch event for a GitHub Actions workflow. The workflow must have a workflow_dispatch trigger configured. Returns 204 No Content on success.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
workflow_idstringYesWorkflow ID (number) or workflow filename (e.g., "main.yaml")
refstringYesGit reference (branch or tag name) to run the workflow on
inputsobjectNoInput keys and values configured in the workflow file
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
triggeredbooleanWhether workflow was triggered
workflow_idstringWorkflow ID or filename
refstringGit reference used

GitHub List Workflow Runs

List workflow runs for a repository, or for a single workflow when a workflow ID or filename is given. Supports filtering by actor, branch, event, and status. Returns run details including status, conclusion, and links.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
workflow_idstringNoThe ID of the workflow. You can also pass the workflow file name as a string (e.g., ci.yml). Omit to list runs across the whole repository.
actorstringNoFilter by user who triggered the workflow
branchstringNoFilter by branch name
eventstringNoFilter by event type (e.g., push, pull_request, workflow_dispatch)
statusstringNoFilter by status (queued, in_progress, completed, waiting, requested, pending)
per_pagenumberNoNumber of results per page (default: 30, max: 100)
pagenumberNoPage number of results to fetch (default: 1)
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
total_countnumberTotal number of workflow runs
itemsarrayArray of workflow run objects
↳ idnumberPull request ID
↳ numbernumberPull request number
↳ urlstringAPI URL

GitHub Get Workflow Run

Get detailed information about a specific workflow run by ID. Returns status, conclusion, timing, and links to the run.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
run_idnumberYesWorkflow run ID
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
triggering_actorobjectGitHub user object
↳ loginstringGitHub username
↳ idnumberUser ID
↳ avatar_urlstringAvatar image URL
↳ html_urlstringProfile URL
↳ typestringAccount type (User or Organization)
head_commitobjectHead commit information
↳ idstringCommit SHA
↳ tree_idstringTree SHA
↳ messagestringCommit message
↳ timestampstringCommit timestamp
idnumberWorkflow run ID
namestringWorkflow name
head_branchstringHead branch name
head_shastringHead commit SHA
run_numbernumberRun number
run_attemptnumberRun attempt number
eventstringEvent that triggered the run
statusstringRun status (queued/in_progress/completed)
conclusionstringRun conclusion (success/failure/cancelled/etc)
workflow_idnumberAssociated workflow ID
html_urlstringGitHub web URL
logs_urlstringLogs download URL
jobs_urlstringJobs API URL
artifacts_urlstringArtifacts API URL
run_started_atstringRun start timestamp
created_atstringCreation timestamp
updated_atstringLast update timestamp
pull_requestsarrayAssociated pull requests
↳ idnumberPull request ID
↳ numbernumberPull request number
↳ urlstringAPI URL
referenced_workflowsarrayReferenced workflows
↳ pathstringPath to referenced workflow
↳ shastringCommit SHA of referenced workflow
↳ refstringGit ref of referenced workflow

GitHub Cancel Workflow Run

Cancel a workflow run. Returns 202 Accepted if cancellation is initiated, or 409 Conflict if the run cannot be cancelled (already completed).

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
run_idnumberYesWorkflow run ID to cancel
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
cancelledbooleanWhether cancellation was initiated
run_idnumberWorkflow run ID

GitHub Rerun Workflow

Rerun a workflow run. Optionally enable debug logging for the rerun. Returns 201 Created on success.

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner (user or organization)
repostringYesRepository name
run_idnumberYesWorkflow run ID to rerun
enable_debug_loggingbooleanNoEnable debug logging for the rerun (default: false)
apiKeystringYesGitHub Personal Access Token

Output

ParameterTypeDescription
rerun_requestedbooleanWhether rerun was requested
run_idnumberWorkflow run ID

GitHub List Projects

List GitHub Projects V2 for an organization or user. Returns up to 20 projects with their details including ID, title, number, URL, and status.

Input

ParameterTypeRequiredDescription
owner_typestringYesOwner type: "org" for organization or "user" for user
owner_loginstringYesOrganization or user login name
apiKeystringYesGitHub Personal Access Token with project read permissions

Output

ParameterTypeDescription
itemsarrayArray of project objects
↳ idstringProject node ID
↳ titlestringProject title
↳ numbernumberProject number
↳ urlstringProject URL
↳ closedbooleanWhether project is closed
↳ publicbooleanWhether project is public
↳ shortDescriptionstringShort description
totalCountnumberTotal number of projects

GitHub Get Project

Get detailed information about a specific GitHub Project V2 by its number. Returns project details including ID, title, description, URL, and status.

Input

ParameterTypeRequiredDescription
owner_typestringYesOwner type: "org" for organization or "user" for user
owner_loginstringYesOrganization or user login name
project_numbernumberYesProject number
apiKeystringYesGitHub Personal Access Token with project read permissions

Output

ParameterTypeDescription
idstringProject node ID
titlestringProject title
numbernumberProject number
urlstringProject URL
closedbooleanWhether project is closed
publicbooleanWhether project is public
shortDescriptionstringShort description
readmestringProject readme
createdAtstringCreation timestamp
updatedAtstringLast update timestamp

GitHub Create Project

Create a new GitHub Project V2. Requires the owner Node ID (not login name). Returns the created project with ID, title, and URL.

Input

ParameterTypeRequiredDescription
owner_idstringYesOwner Node ID (format: PVT_... or MDQ6...). Use GitHub GraphQL API to get this ID from organization or user login.
titlestringYesProject title
apiKeystringYesGitHub Personal Access Token with project write permissions

Output

ParameterTypeDescription
idstringProject node ID
titlestringProject title
numbernumberProject number
urlstringProject URL
closedbooleanWhether project is closed
publicbooleanWhether project is public
shortDescriptionstringShort description

GitHub Update Project

Update an existing GitHub Project V2. Can update title, description, visibility (public), or status (closed). Requires the project Node ID.

Input

ParameterTypeRequiredDescription
project_idstringYesProject Node ID (format: PVT_...)
titlestringNoNew project title
shortDescriptionstringNoNew project short description
project_publicbooleanNoSet project visibility (true = public, false = private)
closedbooleanNoSet project status (true = closed, false = open)
apiKeystringYesGitHub Personal Access Token with project write permissions

Output

ParameterTypeDescription
idstringProject node ID
titlestringProject title
numbernumberProject number
urlstringProject URL
closedbooleanWhether project is closed
publicbooleanWhether project is public
shortDescriptionstringShort description

GitHub Delete Project

Delete a GitHub Project V2. This action is permanent and cannot be undone. Requires the project Node ID.

Input

ParameterTypeRequiredDescription
project_idstringYesProject Node ID (format: PVT_...)
apiKeystringYesGitHub Personal Access Token with project admin permissions

Output

ParameterTypeDescription
idstringDeleted project node ID
titlestringDeleted project title
numbernumberDeleted project number
urlstringDeleted project URL

GitHub Search Code

Search for code across GitHub repositories. Use qualifiers like repo:owner/name, language:js, path:src, extension:py

Input

ParameterTypeRequiredDescription
qstringYesSearch query with optional qualifiers (repo:, language:, path:, extension:, user:, org:)
sortstringNoSort by indexed date (default: best match)
orderstringNoSort order: asc or desc (default: desc)
per_pagenumberNoResults per page (max 100, default: 30)
pagenumberNoPage number (default: 1)
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
total_countnumberTotal matching results
incomplete_resultsbooleanWhether results are incomplete
itemsarrayArray of code matches from GitHub API
↳ namestringFile name
↳ pathstringFile path
↳ shastringBlob SHA
↳ urlstringAPI URL
↳ git_urlstringGit blob URL
↳ html_urlstringGitHub web URL
↳ scorenumberSearch relevance score
↳ repositoryobjectRepository containing the code
↳ idnumberRepository ID
↳ node_idstringGraphQL node ID
↳ namestringRepository name
↳ full_namestringFull name (owner/repo)
↳ privatebooleanWhether repository is private
↳ html_urlstringGitHub web URL
↳ descriptionstringRepository description
↳ forkbooleanWhether this is a fork
↳ urlstringAPI URL
↳ ownerobjectRepository owner
↳ loginstringUsername
↳ idnumberUser ID
↳ node_idstringGraphQL node ID
↳ avatar_urlstringAvatar image URL
↳ urlstringAPI URL
↳ html_urlstringProfile page URL
↳ typestringUser or Organization
↳ site_adminbooleanGitHub staff indicator
↳ text_matchesarrayText matches showing context
↳ object_urlstringObject URL
↳ object_typestringObject type
↳ propertystringProperty matched
↳ fragmentstringText fragment with match
↳ matchesarrayMatch indices
↳ textstringMatched text
↳ indicesarrayStart and end indices

GitHub Search Commits

Search for commits across GitHub. Use qualifiers like repo:owner/name, author:user, committer:user, author-date:>2023-01-01

Input

ParameterTypeRequiredDescription
qstringYesSearch query with optional qualifiers (repo:, author:, committer:, author-date:, committer-date:, merge:true/false)
sortstringNoSort by: author-date or committer-date (default: best match)
orderstringNoSort order: asc or desc (default: desc)
per_pagenumberNoResults per page (max 100, default: 30)
pagenumberNoPage number (default: 1)
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
total_countnumberTotal matching results
incomplete_resultsbooleanWhether results are incomplete
itemsarrayArray of commit objects from GitHub API
↳ shastringCommit SHA
↳ node_idstringGraphQL node ID
↳ html_urlstringWeb URL
↳ urlstringAPI URL
↳ comments_urlstringComments API URL
↳ scorenumberSearch relevance score
↳ commitobjectCore commit data
↳ urlstringCommit API URL
↳ messagestringCommit message
↳ comment_countnumberNumber of comments
↳ authorobjectGit author
↳ namestringAuthor name
↳ emailstringAuthor email
↳ datestringAuthor date (ISO 8601)
↳ committerobjectGit committer
↳ namestringCommitter name
↳ emailstringCommitter email
↳ datestringCommit date (ISO 8601)
↳ treeobjectTree object
↳ shastringTree SHA
↳ urlstringTree API URL
↳ authorobjectGitHub user (author)
↳ loginstringUsername
↳ idnumberUser ID
↳ node_idstringGraphQL node ID
↳ avatar_urlstringAvatar URL
↳ urlstringAPI URL
↳ html_urlstringProfile URL
↳ typestringUser or Organization
↳ site_adminbooleanGitHub staff indicator
↳ committerobjectGitHub user (committer)
↳ loginstringUsername
↳ idnumberUser ID
↳ node_idstringGraphQL node ID
↳ avatar_urlstringAvatar URL
↳ urlstringAPI URL
↳ html_urlstringProfile URL
↳ typestringUser or Organization
↳ site_adminbooleanGitHub staff indicator
↳ repositoryobjectRepository containing the commit
↳ idnumberRepository ID
↳ node_idstringGraphQL node ID
↳ namestringRepository name
↳ full_namestringFull name (owner/repo)
↳ privatebooleanWhether repository is private
↳ html_urlstringGitHub web URL
↳ descriptionstringRepository description
↳ ownerobjectRepository owner
↳ loginstringUsername
↳ idnumberUser ID
↳ node_idstringGraphQL node ID
↳ avatar_urlstringAvatar image URL
↳ urlstringAPI URL
↳ html_urlstringProfile page URL
↳ typestringUser or Organization
↳ site_adminbooleanGitHub staff indicator
↳ parentsarrayParent commits
↳ shastringParent SHA
↳ urlstringParent API URL
↳ html_urlstringParent web URL

GitHub Search Issues

Search for issues and pull requests across GitHub. Use qualifiers like repo:owner/name, is:issue, is:pr, state:open, label:bug, author:user

Input

ParameterTypeRequiredDescription
qstringYesSearch query with optional qualifiers (repo:, is:issue, is:pr, state:, label:, author:, assignee:)
sortstringNoSort by: comments, reactions, created, updated, interactions (default: best match)
orderstringNoSort order: asc or desc (default: desc)
per_pagenumberNoResults per page (max 100, default: 30)
pagenumberNoPage number (default: 1)
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
total_countnumberTotal matching results
incomplete_resultsbooleanWhether results are incomplete
itemsarrayArray of issue/PR objects from GitHub API
↳ idnumberIssue ID
↳ node_idstringGraphQL node ID
↳ numbernumberIssue number
↳ titlestringTitle
↳ statestringState (open or closed)
↳ lockedbooleanWhether issue is locked
↳ html_urlstringWeb URL
↳ urlstringAPI URL
↳ repository_urlstringRepository API URL
↳ comments_urlstringComments API URL
↳ bodystringBody text
↳ commentsnumberNumber of comments
↳ scorenumberSearch relevance score
↳ created_atstringCreation timestamp
↳ updated_atstringLast update timestamp
↳ closed_atstringClose timestamp
↳ userobjectIssue author
↳ loginstringUsername
↳ idnumberUser ID
↳ node_idstringGraphQL node ID
↳ avatar_urlstringAvatar image URL
↳ urlstringAPI URL
↳ html_urlstringProfile page URL
↳ typestringUser or Organization
↳ site_adminbooleanGitHub staff indicator
↳ labelsarrayIssue labels
↳ idnumberLabel ID
↳ node_idstringGraphQL node ID
↳ urlstringAPI URL
↳ namestringLabel name
↳ descriptionstringLabel description
↳ colorstringHex color code
↳ defaultbooleanWhether this is a default label
↳ assigneeobjectPrimary assignee
↳ loginstringUsername
↳ idnumberUser ID
↳ node_idstringGraphQL node ID
↳ avatar_urlstringAvatar image URL
↳ urlstringAPI URL
↳ html_urlstringProfile page URL
↳ typestringUser or Organization
↳ site_adminbooleanGitHub staff indicator
↳ assigneesarrayAll assignees
↳ loginstringUsername
↳ idnumberUser ID
↳ node_idstringGraphQL node ID
↳ avatar_urlstringAvatar image URL
↳ urlstringAPI URL
↳ html_urlstringProfile page URL
↳ typestringUser or Organization
↳ site_adminbooleanGitHub staff indicator
↳ milestoneobjectAssociated milestone
↳ idnumberMilestone ID
↳ node_idstringGraphQL node ID
↳ numbernumberMilestone number
↳ titlestringMilestone title
↳ descriptionstringMilestone description
↳ statestringState (open or closed)
↳ html_urlstringWeb URL
↳ due_onstringDue date
↳ pull_requestobjectPull request details (if this is a PR)
↳ urlstringAPI URL
↳ html_urlstringWeb URL
↳ diff_urlstringDiff URL
↳ patch_urlstringPatch URL

GitHub Search Repositories

Search for repositories across GitHub. Use qualifiers like language:python, stars:>1000, topic:react, user:owner, org:name

Input

ParameterTypeRequiredDescription
qstringYesSearch query with optional qualifiers (language:, stars:, forks:, topic:, user:, org:, in:name,description,readme)
sortstringNoSort by: stars, forks, help-wanted-issues, updated (default: best match)
orderstringNoSort order: asc or desc (default: desc)
per_pagenumberNoResults per page (max 100, default: 30)
pagenumberNoPage number (default: 1)
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
total_countnumberTotal matching results
incomplete_resultsbooleanWhether results are incomplete
itemsarrayArray of repository objects from GitHub API
↳ idnumberRepository ID
↳ node_idstringGraphQL node ID
↳ namestringRepository name
↳ full_namestringFull name (owner/repo)
↳ privatebooleanWhether repository is private
↳ descriptionstringRepository description
↳ html_urlstringGitHub web URL
↳ urlstringAPI URL
↳ forkbooleanWhether this is a fork
↳ created_atstringCreation timestamp
↳ updated_atstringLast update timestamp
↳ pushed_atstringLast push timestamp
↳ sizenumberRepository size in KB
↳ stargazers_countnumberNumber of stars
↳ watchers_countnumberNumber of watchers
↳ forks_countnumberNumber of forks
↳ open_issues_countnumberNumber of open issues
↳ languagestringPrimary programming language
↳ default_branchstringDefault branch name
↳ visibilitystringRepository visibility
↳ archivedbooleanWhether repository is archived
↳ disabledbooleanWhether repository is disabled
↳ scorenumberSearch relevance score
↳ topicsarrayRepository topics
↳ licenseobjectLicense information
↳ keystringLicense key (e.g., mit)
↳ namestringLicense name
↳ spdx_idstringSPDX identifier
↳ ownerobjectRepository owner
↳ loginstringGitHub username
↳ idnumberUser ID
↳ node_idstringGraphQL node ID
↳ avatar_urlstringAvatar image URL
↳ urlstringAPI URL
↳ html_urlstringProfile page URL
↳ typestringUser or Organization
↳ site_adminbooleanGitHub staff indicator

GitHub Search Users

Search for users and organizations on GitHub. Use qualifiers like type:user, type:org, followers:>1000, repos:>10, location:city

Input

ParameterTypeRequiredDescription
qstringYesSearch query with optional qualifiers (type:user/org, followers:, repos:, location:, language:, created:)
sortstringNoSort by: followers, repositories, joined (default: best match)
orderstringNoSort order: asc or desc (default: desc)
per_pagenumberNoResults per page (max 100, default: 30)
pagenumberNoPage number (default: 1)
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
total_countnumberTotal matching results
incomplete_resultsbooleanWhether results are incomplete
itemsarrayArray of user objects from GitHub API
↳ idnumberUser ID
↳ node_idstringGraphQL node ID
↳ loginstringUsername
↳ avatar_urlstringAvatar image URL
↳ gravatar_idstringGravatar ID
↳ urlstringAPI URL
↳ html_urlstringProfile page URL
↳ followers_urlstringFollowers API URL
↳ following_urlstringFollowing API URL
↳ gists_urlstringGists API URL
↳ starred_urlstringStarred API URL
↳ repos_urlstringRepos API URL
↳ organizations_urlstringOrganizations API URL
↳ typestringUser or Organization
↳ site_adminbooleanGitHub staff indicator
↳ scorenumberSearch relevance score

GitHub List Commits

List commits in a repository with optional filtering by SHA, path, author, committer, or date range

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
shastringNoSHA or branch to start listing commits from
pathstringNoOnly commits containing this file path
authorstringNoGitHub login or email address to filter by author
committerstringNoGitHub login or email address to filter by committer
sincestringNoOnly commits after this date (ISO 8601 format)
untilstringNoOnly commits before this date (ISO 8601 format)
per_pagenumberNoResults per page (max 100, default: 30)
pagenumberNoPage number (default: 1)
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
itemsarrayArray of commit objects from GitHub API
↳ commitobjectCore commit data
↳ urlstringCommit API URL
↳ messagestringCommit message
↳ comment_countnumberNumber of comments
↳ authorobjectGit actor (author/committer)
↳ namestringName
↳ emailstringEmail address
↳ datestringTimestamp (ISO 8601)
↳ committerobjectGit actor (author/committer)
↳ namestringName
↳ emailstringEmail address
↳ datestringTimestamp (ISO 8601)
↳ treeobjectTree object
↳ shastringTree SHA
↳ urlstringTree API URL
↳ verificationobjectSignature verification
↳ verifiedbooleanWhether signature is verified
↳ reasonstringVerification reason
↳ signaturestringGPG signature
↳ payloadstringSigned payload
↳ authorobjectGitHub user object
↳ loginstringGitHub username
↳ idnumberUser ID
↳ node_idstringGraphQL node ID
↳ avatar_urlstringAvatar image URL
↳ urlstringAPI URL
↳ html_urlstringProfile page URL
↳ typestringUser or Organization
↳ site_adminbooleanGitHub staff indicator
↳ committerobjectGitHub user object
↳ loginstringGitHub username
↳ idnumberUser ID
↳ node_idstringGraphQL node ID
↳ avatar_urlstringAvatar image URL
↳ urlstringAPI URL
↳ html_urlstringProfile page URL
↳ typestringUser or Organization
↳ site_adminbooleanGitHub staff indicator
↳ shastringCommit SHA
↳ node_idstringGraphQL node ID
↳ html_urlstringGitHub web URL
↳ urlstringAPI URL
↳ comments_urlstringComments API URL
↳ parentsarrayParent commits
↳ shastringParent SHA
↳ urlstringParent API URL
↳ html_urlstringParent web URL
countnumberNumber of commits returned

GitHub Get Commit

Get detailed information about a specific commit including files changed and stats

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
refstringYesCommit SHA, branch name, or tag name
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
commitobjectCore commit data
↳ urlstringCommit API URL
↳ messagestringCommit message
↳ comment_countnumberNumber of comments
↳ authorobjectGit actor (author/committer)
↳ namestringName
↳ emailstringEmail address
↳ datestringTimestamp (ISO 8601)
↳ committerobjectGit actor (author/committer)
↳ namestringName
↳ emailstringEmail address
↳ datestringTimestamp (ISO 8601)
↳ treeobjectTree object
↳ shastringTree SHA
↳ urlstringTree API URL
↳ verificationobjectSignature verification
↳ verifiedbooleanWhether signature is verified
↳ reasonstringVerification reason
↳ signaturestringGPG signature
↳ payloadstringSigned payload
authorobjectGitHub user object
↳ loginstringGitHub username
↳ idnumberUser ID
↳ node_idstringGraphQL node ID
↳ avatar_urlstringAvatar image URL
↳ urlstringAPI URL
↳ html_urlstringProfile page URL
↳ typestringUser or Organization
↳ site_adminbooleanGitHub staff indicator
committerobjectGitHub user object
↳ loginstringGitHub username
↳ idnumberUser ID
↳ node_idstringGraphQL node ID
↳ avatar_urlstringAvatar image URL
↳ urlstringAPI URL
↳ html_urlstringProfile page URL
↳ typestringUser or Organization
↳ site_adminbooleanGitHub staff indicator
statsobjectChange statistics
↳ additionsnumberLines added
↳ deletionsnumberLines deleted
↳ totalnumberTotal changes
shastringCommit SHA
node_idstringGraphQL node ID
html_urlstringGitHub web URL
urlstringAPI URL
comments_urlstringComments API URL
filesarrayChanged files (diff entries)
↳ shastringBlob SHA
↳ filenamestringFile path
↳ statusstringChange status (added, removed, modified, renamed, copied, changed, unchanged)
↳ additionsnumberLines added
↳ deletionsnumberLines deleted
↳ changesnumberTotal changes
↳ blob_urlstringBlob URL
↳ raw_urlstringRaw file URL
↳ contents_urlstringContents API URL
↳ patchstringDiff patch
↳ previous_filenamestringPrevious filename (for renames)
parentsarrayParent commits
↳ shastringParent SHA
↳ urlstringParent API URL
↳ html_urlstringParent web URL

GitHub Compare Commits

Compare two commits or branches to see the diff, commits between them, and changed files

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
basestringYesBase branch/tag/SHA for comparison
headstringYesHead branch/tag/SHA for comparison
per_pagenumberNoResults per page for files (max 100, default: 30)
pagenumberNoPage number for files (default: 1)
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
urlstringAPI URL
html_urlstringGitHub web URL
permalink_urlstringPermanent link URL
diff_urlstringDiff download URL
patch_urlstringPatch download URL
statusstringComparison status (ahead, behind, identical, diverged)
ahead_bynumberCommits head is ahead of base
behind_bynumberCommits head is behind base
total_commitsnumberTotal commits in comparison
base_commitobjectBase commit object
↳ commitobjectCore commit data
↳ urlstringCommit API URL
↳ messagestringCommit message
↳ comment_countnumberNumber of comments
↳ authorobjectGit actor (author/committer)
↳ namestringName
↳ emailstringEmail address
↳ datestringTimestamp (ISO 8601)
↳ committerobjectGit actor (author/committer)
↳ namestringName
↳ emailstringEmail address
↳ datestringTimestamp (ISO 8601)
↳ treeobjectTree object
↳ shastringTree SHA
↳ urlstringTree API URL
↳ verificationobjectSignature verification
↳ verifiedbooleanWhether signature is verified
↳ reasonstringVerification reason
↳ signaturestringGPG signature
↳ payloadstringSigned payload
↳ authorobjectGitHub user object
↳ loginstringGitHub username
↳ idnumberUser ID
↳ node_idstringGraphQL node ID
↳ avatar_urlstringAvatar image URL
↳ urlstringAPI URL
↳ html_urlstringProfile page URL
↳ typestringUser or Organization
↳ site_adminbooleanGitHub staff indicator
↳ committerobjectGitHub user object
↳ loginstringGitHub username
↳ idnumberUser ID
↳ node_idstringGraphQL node ID
↳ avatar_urlstringAvatar image URL
↳ urlstringAPI URL
↳ html_urlstringProfile page URL
↳ typestringUser or Organization
↳ site_adminbooleanGitHub staff indicator
↳ shastringCommit SHA
↳ html_urlstringWeb URL
merge_base_commitobjectMerge base commit object
↳ shastringCommit SHA
↳ html_urlstringWeb URL
commitsarrayCommits between base and head
↳ commitobjectCore commit data
↳ urlstringCommit API URL
↳ messagestringCommit message
↳ comment_countnumberNumber of comments
↳ authorobjectGit actor (author/committer)
↳ namestringName
↳ emailstringEmail address
↳ datestringTimestamp (ISO 8601)
↳ committerobjectGit actor (author/committer)
↳ namestringName
↳ emailstringEmail address
↳ datestringTimestamp (ISO 8601)
↳ treeobjectTree object
↳ shastringTree SHA
↳ urlstringTree API URL
↳ verificationobjectSignature verification
↳ verifiedbooleanWhether signature is verified
↳ reasonstringVerification reason
↳ signaturestringGPG signature
↳ payloadstringSigned payload
↳ authorobjectGitHub user object
↳ loginstringGitHub username
↳ idnumberUser ID
↳ node_idstringGraphQL node ID
↳ avatar_urlstringAvatar image URL
↳ urlstringAPI URL
↳ html_urlstringProfile page URL
↳ typestringUser or Organization
↳ site_adminbooleanGitHub staff indicator
↳ committerobjectGitHub user object
↳ loginstringGitHub username
↳ idnumberUser ID
↳ node_idstringGraphQL node ID
↳ avatar_urlstringAvatar image URL
↳ urlstringAPI URL
↳ html_urlstringProfile page URL
↳ typestringUser or Organization
↳ site_adminbooleanGitHub staff indicator
↳ shastringCommit SHA
↳ html_urlstringWeb URL
filesarrayChanged files (diff entries)
↳ shastringBlob SHA
↳ filenamestringFile path
↳ statusstringChange status (added, removed, modified, renamed, copied, changed, unchanged)
↳ additionsnumberLines added
↳ deletionsnumberLines deleted
↳ changesnumberTotal changes
↳ blob_urlstringBlob URL
↳ raw_urlstringRaw file URL
↳ contents_urlstringContents API URL
↳ patchstringDiff patch
↳ previous_filenamestringPrevious filename (for renames)

GitHub Create Gist

Create a new gist with one or more files

Input

ParameterTypeRequiredDescription
descriptionstringNoDescription of the gist
filesjsonYesJSON object with filenames as keys and content as values. Example: {"file.txt": {"content": "Hello"}}
publicbooleanNoWhether the gist is public (default: false)
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
idstringGist ID
node_idstringGraphQL node ID
urlstringAPI URL
html_urlstringWeb URL
forks_urlstringForks API URL
commits_urlstringCommits API URL
git_pull_urlstringGit pull URL
git_push_urlstringGit push URL
descriptionstringGist description
publicbooleanWhether gist is public
truncatedbooleanWhether files are truncated
commentsnumberNumber of comments
comments_urlstringComments API URL
created_atstringCreation timestamp
updated_atstringLast update timestamp
filesobjectFiles in the gist (object with filenames as keys, each containing filename, type, language, raw_url, size, truncated, content)
ownerobjectGist owner
↳ loginstringUsername
↳ idnumberUser ID
↳ node_idstringGraphQL node ID
↳ avatar_urlstringAvatar image URL
↳ urlstringAPI URL
↳ html_urlstringProfile page URL
↳ typestringUser or Organization
↳ site_adminbooleanGitHub staff indicator

GitHub Get Gist

Get a gist by ID including its file contents

Input

ParameterTypeRequiredDescription
gist_idstringYesThe gist ID
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
filesobjectFiles in the gist (keyed by filename)
↳ filenamestringFile name
↳ typestringMIME type
↳ languagestringProgramming language
↳ raw_urlstringRaw file URL
↳ sizenumberFile size in bytes
↳ truncatedbooleanWhether content is truncated
↳ contentstringFile content
ownerobjectGist owner
↳ loginstringUsername
↳ idnumberUser ID
↳ node_idstringGraphQL node ID
↳ avatar_urlstringAvatar image URL
↳ urlstringAPI URL
↳ html_urlstringProfile page URL
↳ typestringUser or Organization
↳ site_adminbooleanGitHub staff indicator
idstringGist ID
node_idstringGraphQL node ID
urlstringAPI URL
html_urlstringGitHub web URL
forks_urlstringForks API URL
commits_urlstringCommits API URL
git_pull_urlstringGit clone URL
git_push_urlstringGit push URL
descriptionstringGist description
publicbooleanWhether gist is public
truncatedbooleanWhether content is truncated
commentsnumberNumber of comments
comments_urlstringComments API URL
created_atstringCreation timestamp
updated_atstringLast update timestamp

GitHub List Gists

List gists for a user or the authenticated user

Input

ParameterTypeRequiredDescription
usernamestringNoGitHub username (omit for authenticated user's gists)
sincestringNoOnly gists updated after this time (ISO 8601)
per_pagenumberNoResults per page (max 100, default: 30)
pagenumberNoPage number (default: 1)
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
itemsarrayArray of gist objects from GitHub API
↳ filesobjectFiles in the gist (keyed by filename)
↳ filenamestringFile name
↳ typestringMIME type
↳ languagestringProgramming language
↳ raw_urlstringRaw file URL
↳ sizenumberFile size in bytes
↳ truncatedbooleanWhether content is truncated
↳ contentstringFile content
↳ ownerobjectGist owner
↳ loginstringUsername
↳ idnumberUser ID
↳ node_idstringGraphQL node ID
↳ avatar_urlstringAvatar image URL
↳ urlstringAPI URL
↳ html_urlstringProfile page URL
↳ typestringUser or Organization
↳ site_adminbooleanGitHub staff indicator
↳ idstringGist ID
↳ node_idstringGraphQL node ID
↳ urlstringAPI URL
↳ html_urlstringGitHub web URL
↳ forks_urlstringForks API URL
↳ commits_urlstringCommits API URL
↳ git_pull_urlstringGit clone URL
↳ git_push_urlstringGit push URL
↳ descriptionstringGist description
↳ publicbooleanWhether gist is public
↳ truncatedbooleanWhether content is truncated
↳ commentsnumberNumber of comments
↳ comments_urlstringComments API URL
↳ created_atstringCreation timestamp
↳ updated_atstringLast update timestamp
countnumberNumber of gists returned

GitHub Update Gist

Update a gist description or files. To delete a file, set its value to null in files object

Input

ParameterTypeRequiredDescription
gist_idstringYesThe gist ID to update
descriptionstringNoNew description for the gist
filesjsonNoJSON object with filenames as keys. Set to null to delete, or provide content to update/add
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
idstringGist ID
node_idstringGraphQL node ID
urlstringAPI URL
html_urlstringWeb URL
forks_urlstringForks API URL
commits_urlstringCommits API URL
git_pull_urlstringGit pull URL
git_push_urlstringGit push URL
descriptionstringGist description
publicbooleanWhether gist is public
truncatedbooleanWhether files are truncated
commentsnumberNumber of comments
comments_urlstringComments API URL
created_atstringCreation timestamp
updated_atstringLast update timestamp
filesobjectFiles in the gist (object with filenames as keys, each containing filename, type, language, raw_url, size, truncated, content)
ownerobjectGist owner
↳ loginstringUsername
↳ idnumberUser ID
↳ node_idstringGraphQL node ID
↳ avatar_urlstringAvatar image URL
↳ urlstringAPI URL
↳ html_urlstringProfile page URL
↳ typestringUser or Organization
↳ site_adminbooleanGitHub staff indicator

GitHub Delete Gist

Delete a gist by ID

Input

ParameterTypeRequiredDescription
gist_idstringYesThe gist ID to delete
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
deletedbooleanWhether deletion succeeded
gist_idstringThe deleted gist ID

GitHub Fork Gist

Fork a gist to create your own copy

Input

ParameterTypeRequiredDescription
gist_idstringYesThe gist ID to fork
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
idstringNew gist ID
html_urlstringWeb URL
descriptionstringDescription
publicbooleanIs public
created_atstringCreation date
ownerobjectOwner info
filesobjectFiles

GitHub Star Gist

Star a gist

Input

ParameterTypeRequiredDescription
gist_idstringYesThe gist ID to star
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
starredbooleanWhether starring succeeded
gist_idstringThe gist ID

GitHub Unstar Gist

Unstar a gist

Input

ParameterTypeRequiredDescription
gist_idstringYesThe gist ID to unstar
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
unstarredbooleanWhether unstarring succeeded
gist_idstringThe gist ID

GitHub Fork Repository

Fork a repository to your account or an organization

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner to fork from
repostringYesRepository name to fork
organizationstringNoOrganization to fork into (omit to fork to your account)
namestringNoCustom name for the forked repository
default_branch_onlybooleanNoOnly fork the default branch (default: false)
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
idnumberRepository ID
node_idstringGraphQL node ID
namestringRepository name
full_namestringFull name (owner/repo)
privatebooleanWhether repository is private
descriptionstringRepository description
html_urlstringGitHub web URL
urlstringAPI URL
clone_urlstringHTTPS clone URL
ssh_urlstringSSH clone URL
git_urlstringGit protocol URL
default_branchstringDefault branch name
forkbooleanWhether this is a fork
created_atstringCreation timestamp
updated_atstringLast update timestamp
pushed_atstringLast push timestamp
ownerobjectFork owner
↳ loginstringGitHub username
↳ idnumberUser ID
↳ node_idstringGraphQL node ID
↳ avatar_urlstringAvatar image URL
↳ urlstringAPI URL
↳ html_urlstringProfile page URL
↳ typestringUser or Organization
↳ site_adminbooleanGitHub staff indicator
parentobjectParent repository (source of the fork)
↳ loginstringUsername
↳ idnumberUser ID
sourceobjectSource repository (ultimate origin)
↳ idnumberRepository ID
↳ full_namestringFull name
↳ html_urlstringWeb URL

GitHub List Forks

List forks of a repository

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
sortstringNoSort by: newest, oldest, stargazers, watchers (default: newest)
per_pagenumberNoResults per page (max 100, default: 30)
pagenumberNoPage number (default: 1)
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
itemsarrayArray of fork repository objects from GitHub API
↳ idnumberRepository ID
↳ node_idstringGraphQL node ID
↳ namestringRepository name
↳ full_namestringFull name (owner/repo)
↳ privatebooleanWhether repository is private
↳ descriptionstringRepository description
↳ html_urlstringGitHub web URL
↳ urlstringAPI URL
↳ forkbooleanWhether this is a fork
↳ created_atstringCreation timestamp
↳ updated_atstringLast update timestamp
↳ pushed_atstringLast push timestamp
↳ sizenumberRepository size in KB
↳ stargazers_countnumberNumber of stars
↳ watchers_countnumberNumber of watchers
↳ forks_countnumberNumber of forks
↳ open_issues_countnumberNumber of open issues
↳ languagestringPrimary programming language
↳ default_branchstringDefault branch name
↳ visibilitystringRepository visibility
↳ archivedbooleanWhether repository is archived
↳ disabledbooleanWhether repository is disabled
↳ ownerobjectFork owner
↳ loginstringGitHub username
↳ idnumberUser ID
↳ node_idstringGraphQL node ID
↳ avatar_urlstringAvatar image URL
↳ urlstringAPI URL
↳ html_urlstringProfile page URL
↳ typestringUser or Organization
↳ site_adminbooleanGitHub staff indicator
countnumberNumber of forks returned

GitHub Create Milestone

Create a milestone in a repository

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
titlestringYesMilestone title
statestringNoState: open or closed (default: open)
descriptionstringNoMilestone description
due_onstringNoDue date (ISO 8601 format, e.g., 2024-12-31T23:59:59Z)
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
creatorobjectMilestone creator
↳ loginstringUsername
↳ idnumberUser ID
↳ node_idstringGraphQL node ID
↳ avatar_urlstringAvatar image URL
↳ urlstringAPI URL
↳ html_urlstringProfile page URL
↳ typestringUser or Organization
↳ site_adminbooleanGitHub staff indicator
idnumberMilestone ID
node_idstringGraphQL node ID
numbernumberMilestone number
titlestringMilestone title
descriptionstringMilestone description
statestringState (open or closed)
urlstringAPI URL
html_urlstringGitHub web URL
labels_urlstringLabels API URL
due_onstringDue date (ISO 8601)
open_issuesnumberNumber of open issues
closed_issuesnumberNumber of closed issues
created_atstringCreation timestamp
updated_atstringLast update timestamp
closed_atstringClose timestamp

GitHub Get Milestone

Get a specific milestone by number

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
milestone_numbernumberYesMilestone number
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
creatorobjectMilestone creator
↳ loginstringUsername
↳ idnumberUser ID
↳ node_idstringGraphQL node ID
↳ avatar_urlstringAvatar image URL
↳ urlstringAPI URL
↳ html_urlstringProfile page URL
↳ typestringUser or Organization
↳ site_adminbooleanGitHub staff indicator
idnumberMilestone ID
node_idstringGraphQL node ID
numbernumberMilestone number
titlestringMilestone title
descriptionstringMilestone description
statestringState (open or closed)
urlstringAPI URL
html_urlstringGitHub web URL
labels_urlstringLabels API URL
due_onstringDue date (ISO 8601)
open_issuesnumberNumber of open issues
closed_issuesnumberNumber of closed issues
created_atstringCreation timestamp
updated_atstringLast update timestamp
closed_atstringClose timestamp

GitHub List Milestones

List milestones in a repository

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
statestringNoFilter by state: open, closed, all (default: open)
sortstringNoSort by: due_on or completeness (default: due_on)
directionstringNoSort direction: asc or desc (default: asc)
per_pagenumberNoResults per page (max 100, default: 30)
pagenumberNoPage number (default: 1)
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
itemsarrayArray of milestone objects from GitHub API
↳ creatorobjectMilestone creator
↳ loginstringUsername
↳ idnumberUser ID
↳ node_idstringGraphQL node ID
↳ avatar_urlstringAvatar image URL
↳ urlstringAPI URL
↳ html_urlstringProfile page URL
↳ typestringUser or Organization
↳ site_adminbooleanGitHub staff indicator
↳ idnumberMilestone ID
↳ node_idstringGraphQL node ID
↳ numbernumberMilestone number
↳ titlestringMilestone title
↳ descriptionstringMilestone description
↳ statestringState (open or closed)
↳ urlstringAPI URL
↳ html_urlstringGitHub web URL
↳ labels_urlstringLabels API URL
↳ due_onstringDue date (ISO 8601)
↳ open_issuesnumberNumber of open issues
↳ closed_issuesnumberNumber of closed issues
↳ created_atstringCreation timestamp
↳ updated_atstringLast update timestamp
↳ closed_atstringClose timestamp
countnumberNumber of milestones returned

GitHub Update Milestone

Update a milestone in a repository

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
milestone_numbernumberYesMilestone number to update
titlestringNoNew milestone title
statestringNoNew state: open or closed
descriptionstringNoNew description
due_onstringNoNew due date (ISO 8601 format)
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
idnumberMilestone ID
node_idstringGraphQL node ID
numbernumberMilestone number
titlestringMilestone title
descriptionstringMilestone description
statestringState (open or closed)
urlstringAPI URL
html_urlstringGitHub web URL
labels_urlstringLabels API URL
due_onstringDue date (ISO 8601)
open_issuesnumberNumber of open issues
closed_issuesnumberNumber of closed issues
created_atstringCreation timestamp
updated_atstringLast update timestamp
closed_atstringClose timestamp
creatorobjectMilestone creator
↳ loginstringUsername
↳ idnumberUser ID
↳ node_idstringGraphQL node ID
↳ avatar_urlstringAvatar image URL
↳ urlstringAPI URL
↳ html_urlstringProfile page URL
↳ typestringUser or Organization
↳ site_adminbooleanGitHub staff indicator

GitHub Delete Milestone

Delete a milestone from a repository

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
milestone_numbernumberYesMilestone number to delete
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
deletedbooleanWhether deletion succeeded
milestone_numbernumberThe deleted milestone number

GitHub Create Issue Reaction

Add a reaction to an issue

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
issue_numbernumberYesIssue number
contentstringYesReaction type: +1 (thumbs up), -1 (thumbs down), laugh, confused, heart, hooray, rocket, eyes
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
idnumberReaction ID
node_idstringGraphQL node ID
contentstringReaction type (+1, -1, laugh, confused, heart, hooray, rocket, eyes)
created_atstringCreation timestamp
userobjectGitHub user object
↳ loginstringGitHub username
↳ idnumberUser ID
↳ avatar_urlstringAvatar image URL
↳ html_urlstringProfile URL
↳ typestringAccount type (User or Organization)

GitHub Delete Issue Reaction

Remove a reaction from an issue

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
issue_numbernumberYesIssue number
reaction_idnumberYesReaction ID to delete
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
deletedbooleanWhether deletion succeeded
reaction_idnumberThe deleted reaction ID

GitHub Create Comment Reaction

Add a reaction to an issue comment

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
comment_idnumberYesComment ID
contentstringYesReaction type: +1 (thumbs up), -1 (thumbs down), laugh, confused, heart, hooray, rocket, eyes
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
idnumberReaction ID
node_idstringGraphQL node ID
contentstringReaction type (+1, -1, laugh, confused, heart, hooray, rocket, eyes)
created_atstringCreation timestamp
userobjectGitHub user object
↳ loginstringGitHub username
↳ idnumberUser ID
↳ avatar_urlstringAvatar image URL
↳ html_urlstringProfile URL
↳ typestringAccount type (User or Organization)

GitHub Delete Comment Reaction

Remove a reaction from an issue comment

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
comment_idnumberYesComment ID
reaction_idnumberYesReaction ID to delete
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
deletedbooleanWhether deletion succeeded
reaction_idnumberThe deleted reaction ID

GitHub Star Repository

Star a repository

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
starredbooleanWhether starring succeeded
ownerstringRepository owner
repostringRepository name

GitHub Unstar Repository

Remove star from a repository

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
unstarredbooleanWhether unstarring succeeded
ownerstringRepository owner
repostringRepository name

GitHub Check Star

Check if you have starred a repository

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
starredbooleanWhether you have starred the repo
ownerstringRepository owner
repostringRepository name

GitHub List Stargazers

List users who have starred a repository

Input

ParameterTypeRequiredDescription
ownerstringYesRepository owner
repostringYesRepository name
per_pagenumberNoResults per page (max 100, default: 30)
pagenumberNoPage number (default: 1)
apiKeystringYesGitHub API token

Output

ParameterTypeDescription
itemsarrayArray of user objects from GitHub API
↳ loginstringGitHub username
↳ idnumberUser ID
↳ node_idstringGraphQL node ID
↳ avatar_urlstringAvatar image URL
↳ urlstringAPI URL
↳ html_urlstringProfile page URL
↳ typestringUser or Organization
↳ site_adminbooleanGitHub staff indicator
↳ gravatar_idstringGravatar ID
↳ followers_urlstringFollowers API URL
↳ following_urlstringFollowing API URL
↳ gists_urlstringGists API URL
↳ starred_urlstringStarred API URL
↳ repos_urlstringRepos API URL
countnumberNumber of stargazers returned

Triggers

A Trigger is a block that starts a workflow when an event happens in this service.

GitHub Actions Workflow Run

Trigger workflow when a GitHub Actions workflow run is requested, in progress, or completed

Configuration

ParameterTypeRequiredDescription
contentTypestringYesFormat GitHub will use when sending the webhook payload.
webhookSecretstringNoValidates that webhook deliveries originate from GitHub.
sslVerificationstringYesGitHub verifies SSL certificates when delivering webhooks.

Output

ParameterTypeDescription
event_typestringGitHub event type from X-GitHub-Event header (e.g., workflow_run)
actionstringAction performed (requested, in_progress, completed)
workflow_runobjectworkflow_run output from the tool
↳ idnumberWorkflow run ID
↳ node_idstringWorkflow run node ID
↳ namestringWorkflow name
↳ workflow_idnumberWorkflow ID
↳ run_numbernumberRun number for this workflow
↳ run_attemptnumberAttempt number for this run
↳ eventstringEvent that triggered the workflow (push, pull_request, etc.)
↳ statusstringCurrent status (queued, in_progress, completed)
↳ conclusionstringConclusion (success, failure, cancelled, skipped, timed_out, action_required)
↳ head_branchstringBranch name
↳ head_shastringCommit SHA that triggered the workflow
↳ pathstringPath to the workflow file
↳ display_titlestringDisplay title for the run
↳ run_started_atstringTimestamp when the run started
↳ created_atstringWorkflow run creation timestamp
↳ updated_atstringWorkflow run last update timestamp
↳ html_urlstringWorkflow run HTML URL
↳ check_suite_idnumberAssociated check suite ID
↳ check_suite_node_idstringAssociated check suite node ID
↳ urlstringWorkflow run API URL
↳ actorobjectactor output from the tool
↳ loginstringUsername
↳ idnumberUser ID
↳ node_idstringUser node ID
↳ avatar_urlstringAvatar URL
↳ html_urlstringProfile URL
↳ user_typestringUser type (User, Bot, Organization)
↳ triggering_actorobjecttriggering_actor output from the tool
↳ loginstringUsername
↳ idnumberUser ID
↳ node_idstringUser node ID
↳ avatar_urlstringAvatar URL
↳ html_urlstringProfile URL
↳ user_typestringUser type (User, Bot, Organization)
↳ repositoryobjectrepository output from the tool
↳ idnumberRepository ID
↳ node_idstringRepository node ID
↳ namestringRepository name
↳ full_namestringRepository full name
↳ privatebooleanWhether repository is private
↳ head_repositoryobjecthead_repository output from the tool
↳ idnumberHead repository ID
↳ node_idstringHead repository node ID
↳ namestringHead repository name
↳ full_namestringHead repository full name
↳ privatebooleanWhether repository is private
↳ head_commitobjecthead_commit output from the tool
↳ idstringCommit SHA
↳ tree_idstringTree ID
↳ messagestringCommit message
↳ timestampstringCommit timestamp
↳ authorobjectauthor output from the tool
↳ namestringAuthor name
↳ emailstringAuthor email
↳ committerobjectcommitter output from the tool
↳ namestringCommitter name
↳ emailstringCommitter email
↳ pull_requestsarrayArray of associated pull requests
↳ referenced_workflowsarrayArray of referenced workflow runs
workflowobjectworkflow output from the tool
↳ idnumberWorkflow ID
↳ node_idstringWorkflow node ID
↳ namestringWorkflow name
↳ pathstringPath to workflow file
↳ statestringWorkflow state (active, deleted, disabled_fork, etc.)
↳ created_atstringWorkflow creation timestamp
↳ updated_atstringWorkflow last update timestamp
↳ urlstringWorkflow API URL
↳ html_urlstringWorkflow HTML URL
↳ badge_urlstringWorkflow badge URL
repositoryobjectrepository output from the tool
↳ idnumberRepository ID
↳ node_idstringRepository node ID
↳ namestringRepository name
↳ full_namestringRepository full name (owner/repo)
↳ privatebooleanWhether the repository is private
↳ html_urlstringRepository HTML URL
↳ repo_descriptionstringRepository description
↳ ownerobjectowner output from the tool
↳ loginstringOwner username
↳ idnumberOwner ID
↳ node_idstringOwner node ID
↳ avatar_urlstringOwner avatar URL
↳ html_urlstringOwner profile URL
↳ owner_typestringOwner type (User, Organization)
senderobjectsender output from the tool
↳ loginstringUsername
↳ idnumberUser ID
↳ node_idstringUser node ID
↳ avatar_urlstringAvatar URL
↳ html_urlstringProfile URL
↳ user_typestringUser type (User, Bot, Organization)

GitHub Issue Closed

Trigger workflow when an issue is closed in a GitHub repository

Configuration

ParameterTypeRequiredDescription
contentTypestringYesFormat GitHub will use when sending the webhook payload.
webhookSecretstringNoValidates that webhook deliveries originate from GitHub.
sslVerificationstringYesGitHub verifies SSL certificates when delivering webhooks.

Output

ParameterTypeDescription
event_typestringGitHub event type from X-GitHub-Event header (e.g., issues, pull_request, push)
actionstringAction performed (opened, closed, reopened, edited, etc.)
issueobjectissue output from the tool
↳ idnumberIssue ID
↳ node_idstringIssue node ID
↳ numbernumberIssue number
↳ titlestringIssue title
↳ bodystringIssue body/description
↳ statestringIssue state (open, closed)
↳ state_reasonstringReason for state (completed, not_planned, reopened)
↳ html_urlstringIssue HTML URL
↳ userobjectuser output from the tool
↳ loginstringUsername
↳ idnumberUser ID
↳ node_idstringUser node ID
↳ avatar_urlstringAvatar URL
↳ html_urlstringProfile URL
↳ user_typestringUser type (User, Bot, Organization)
↳ labelsarrayArray of label objects
↳ assigneesarrayArray of assigned users
↳ milestoneobjectMilestone object if assigned
↳ created_atstringIssue creation timestamp
↳ updated_atstringIssue last update timestamp
↳ closed_atstringIssue closed timestamp
repositoryobjectrepository output from the tool
↳ idnumberRepository ID
↳ node_idstringRepository node ID
↳ namestringRepository name
↳ full_namestringRepository full name (owner/repo)
↳ privatebooleanWhether the repository is private
↳ html_urlstringRepository HTML URL
↳ repo_descriptionstringRepository description
↳ forkbooleanWhether the repository is a fork
↳ urlstringRepository API URL
↳ homepagestringRepository homepage URL
↳ sizenumberRepository size in KB
↳ stargazers_countnumberNumber of stars
↳ watchers_countnumberNumber of watchers
↳ languagestringPrimary programming language
↳ forks_countnumberNumber of forks
↳ open_issues_countnumberNumber of open issues
↳ default_branchstringDefault branch name
↳ ownerobjectowner output from the tool
↳ loginstringOwner username
↳ idnumberOwner ID
↳ avatar_urlstringOwner avatar URL
↳ html_urlstringOwner profile URL
↳ owner_typestringOwner type (User, Organization)
senderobjectsender output from the tool
↳ loginstringUsername
↳ idnumberUser ID
↳ node_idstringUser node ID
↳ avatar_urlstringAvatar URL
↳ html_urlstringProfile URL
↳ user_typestringUser type (User, Bot, Organization)

GitHub Issue Comment

Trigger workflow when a comment is added to an issue (not pull requests)

Configuration

ParameterTypeRequiredDescription
contentTypestringYesFormat GitHub will use when sending the webhook payload.
webhookSecretstringNoValidates that webhook deliveries originate from GitHub.
sslVerificationstringYesGitHub verifies SSL certificates when delivering webhooks.

Output

ParameterTypeDescription
event_typestringGitHub event type from X-GitHub-Event header (e.g., issue_comment)
actionstringAction performed (created, edited, deleted)
issueobjectissue output from the tool
↳ numbernumberIssue number
↳ titlestringIssue title
↳ statestringIssue state (open, closed)
↳ html_urlstringIssue HTML URL
↳ userobjectuser output from the tool
↳ loginstringUsername
↳ idnumberUser ID
↳ node_idstringUser node ID
↳ avatar_urlstringAvatar URL
↳ html_urlstringProfile URL
↳ user_typestringUser type (User, Bot, Organization)
commentobjectcomment output from the tool
↳ idnumberComment ID
↳ node_idstringComment node ID
↳ bodystringComment text
↳ html_urlstringComment HTML URL
↳ userobjectuser output from the tool
↳ loginstringUsername
↳ idnumberUser ID
↳ node_idstringUser node ID
↳ avatar_urlstringAvatar URL
↳ html_urlstringProfile URL
↳ user_typestringUser type (User, Bot, Organization)
↳ created_atstringComment creation timestamp
↳ updated_atstringComment last update timestamp
repositoryobjectrepository output from the tool
↳ idnumberRepository ID
↳ node_idstringRepository node ID
↳ namestringRepository name
↳ full_namestringRepository full name (owner/repo)
↳ privatebooleanWhether the repository is private
↳ html_urlstringRepository HTML URL
↳ repo_descriptionstringRepository description
↳ forkbooleanWhether the repository is a fork
↳ urlstringRepository API URL
↳ homepagestringRepository homepage URL
↳ sizenumberRepository size in KB
↳ stargazers_countnumberNumber of stars
↳ watchers_countnumberNumber of watchers
↳ languagestringPrimary programming language
↳ forks_countnumberNumber of forks
↳ open_issues_countnumberNumber of open issues
↳ default_branchstringDefault branch name
↳ ownerobjectowner output from the tool
↳ loginstringOwner username
↳ idnumberOwner ID
↳ avatar_urlstringOwner avatar URL
↳ html_urlstringOwner profile URL
↳ owner_typestringOwner type (User, Organization)
senderobjectsender output from the tool
↳ loginstringUsername
↳ idnumberUser ID
↳ node_idstringUser node ID
↳ avatar_urlstringAvatar URL
↳ html_urlstringProfile URL
↳ user_typestringUser type (User, Bot, Organization)

GitHub Issue Opened

Trigger workflow when a new issue is opened in a GitHub repository

Configuration

ParameterTypeRequiredDescription
contentTypestringYesFormat GitHub will use when sending the webhook payload.
webhookSecretstringNoValidates that webhook deliveries originate from GitHub.
sslVerificationstringYesGitHub verifies SSL certificates when delivering webhooks.

Output

ParameterTypeDescription
event_typestringGitHub event type from X-GitHub-Event header (e.g., issues, pull_request, push)
actionstringAction performed (opened, closed, reopened, edited, etc.)
issueobjectissue output from the tool
↳ idnumberIssue ID
↳ node_idstringIssue node ID
↳ numbernumberIssue number
↳ titlestringIssue title
↳ bodystringIssue body/description
↳ statestringIssue state (open, closed)
↳ state_reasonstringReason for state (completed, not_planned, reopened)
↳ html_urlstringIssue HTML URL
↳ userobjectuser output from the tool
↳ loginstringUsername
↳ idnumberUser ID
↳ node_idstringUser node ID
↳ avatar_urlstringAvatar URL
↳ html_urlstringProfile URL
↳ user_typestringUser type (User, Bot, Organization)
↳ labelsarrayArray of label objects
↳ assigneesarrayArray of assigned users
↳ milestoneobjectMilestone object if assigned
↳ created_atstringIssue creation timestamp
↳ updated_atstringIssue last update timestamp
↳ closed_atstringIssue closed timestamp
repositoryobjectrepository output from the tool
↳ idnumberRepository ID
↳ node_idstringRepository node ID
↳ namestringRepository name
↳ full_namestringRepository full name (owner/repo)
↳ privatebooleanWhether the repository is private
↳ html_urlstringRepository HTML URL
↳ repo_descriptionstringRepository description
↳ forkbooleanWhether the repository is a fork
↳ urlstringRepository API URL
↳ homepagestringRepository homepage URL
↳ sizenumberRepository size in KB
↳ stargazers_countnumberNumber of stars
↳ watchers_countnumberNumber of watchers
↳ languagestringPrimary programming language
↳ forks_countnumberNumber of forks
↳ open_issues_countnumberNumber of open issues
↳ default_branchstringDefault branch name
↳ ownerobjectowner output from the tool
↳ loginstringOwner username
↳ idnumberOwner ID
↳ avatar_urlstringOwner avatar URL
↳ html_urlstringOwner profile URL
↳ owner_typestringOwner type (User, Organization)
senderobjectsender output from the tool
↳ loginstringUsername
↳ idnumberUser ID
↳ node_idstringUser node ID
↳ avatar_urlstringAvatar URL
↳ html_urlstringProfile URL
↳ user_typestringUser type (User, Bot, Organization)

GitHub PR Closed

Trigger workflow when a pull request is closed without being merged (e.g., abandoned) in a GitHub repository

Configuration

ParameterTypeRequiredDescription
contentTypestringYesFormat GitHub will use when sending the webhook payload.
webhookSecretstringNoValidates that webhook deliveries originate from GitHub.
sslVerificationstringYesGitHub verifies SSL certificates when delivering webhooks.

Output

ParameterTypeDescription
event_typestringGitHub event type from X-GitHub-Event header (e.g., pull_request)
actionstringAction performed (opened, closed, synchronize, reopened, edited, etc.)
numbernumberPull request number
pull_requestobjectpull_request output from the tool
↳ idnumberPull request ID
↳ node_idstringPull request node ID
↳ numbernumberPull request number
↳ titlestringPull request title
↳ bodystringPull request description
↳ statestringPull request state (open, closed)
↳ mergedbooleanWhether the PR was merged
↳ merged_atstringTimestamp when PR was merged
↳ merged_byobjectmerged_by output from the tool
↳ loginstringUsername
↳ idnumberUser ID
↳ node_idstringUser node ID
↳ avatar_urlstringAvatar URL
↳ html_urlstringProfile URL
↳ user_typestringUser type (User, Bot, Organization)
↳ draftbooleanWhether the PR is a draft
↳ html_urlstringPull request HTML URL
↳ diff_urlstringPull request diff URL
↳ patch_urlstringPull request patch URL
↳ userobjectuser output from the tool
↳ loginstringUsername
↳ idnumberUser ID
↳ node_idstringUser node ID
↳ avatar_urlstringAvatar URL
↳ html_urlstringProfile URL
↳ user_typestringUser type (User, Bot, Organization)
↳ headobjecthead output from the tool
↳ refstringSource branch name
↳ shastringSource branch commit SHA
↳ repoobjectrepo output from the tool
↳ namestringSource repository name
↳ full_namestringSource repository full name
↳ baseobjectbase output from the tool
↳ refstringTarget branch name
↳ shastringTarget branch commit SHA
↳ repoobjectrepo output from the tool
↳ namestringTarget repository name
↳ full_namestringTarget repository full name
↳ additionsnumberNumber of lines added
↳ deletionsnumberNumber of lines deleted
↳ changed_filesnumberNumber of files changed
↳ labelsarrayArray of label objects
↳ assigneesarrayArray of assigned users
↳ requested_reviewersarrayArray of requested reviewers
↳ created_atstringPull request creation timestamp
↳ updated_atstringPull request last update timestamp
↳ closed_atstringPull request closed timestamp
repositoryobjectrepository output from the tool
↳ idnumberRepository ID
↳ node_idstringRepository node ID
↳ namestringRepository name
↳ full_namestringRepository full name (owner/repo)
↳ privatebooleanWhether the repository is private
↳ html_urlstringRepository HTML URL
↳ repo_descriptionstringRepository description
↳ forkbooleanWhether the repository is a fork
↳ urlstringRepository API URL
↳ homepagestringRepository homepage URL
↳ sizenumberRepository size in KB
↳ stargazers_countnumberNumber of stars
↳ watchers_countnumberNumber of watchers
↳ languagestringPrimary programming language
↳ forks_countnumberNumber of forks
↳ open_issues_countnumberNumber of open issues
↳ default_branchstringDefault branch name
↳ ownerobjectowner output from the tool
↳ loginstringOwner username
↳ idnumberOwner ID
↳ avatar_urlstringOwner avatar URL
↳ html_urlstringOwner profile URL
senderobjectsender output from the tool
↳ loginstringUsername
↳ idnumberUser ID
↳ node_idstringUser node ID
↳ avatar_urlstringAvatar URL
↳ html_urlstringProfile URL
↳ user_typestringUser type (User, Bot, Organization)

GitHub PR Comment

Trigger workflow when a comment is added to a pull request in a GitHub repository

Configuration

ParameterTypeRequiredDescription
contentTypestringYesFormat GitHub will use when sending the webhook payload.
webhookSecretstringNoValidates that webhook deliveries originate from GitHub.
sslVerificationstringYesGitHub verifies SSL certificates when delivering webhooks.

Output

ParameterTypeDescription
event_typestringGitHub event type from X-GitHub-Event header (e.g., issue_comment)
actionstringAction performed (created, edited, deleted)
issueobjectissue output from the tool
↳ idnumberIssue ID
↳ node_idstringIssue node ID
↳ numbernumberIssue/PR number
↳ titlestringIssue/PR title
↳ bodystringIssue/PR description
↳ statestringIssue/PR state (open, closed)
↳ html_urlstringIssue/PR HTML URL
↳ userobjectuser output from the tool
↳ loginstringUsername
↳ idnumberUser ID
↳ node_idstringUser node ID
↳ avatar_urlstringAvatar URL
↳ html_urlstringProfile URL
↳ user_typestringUser type (User, Bot, Organization)
↳ labelsarrayArray of label objects
↳ assigneesarrayArray of assigned users
↳ pull_requestobjectpull_request output from the tool
↳ urlstringPull request API URL (present only for PR comments)
↳ html_urlstringPull request HTML URL
↳ diff_urlstringPull request diff URL
↳ patch_urlstringPull request patch URL
↳ created_atstringIssue/PR creation timestamp
↳ updated_atstringIssue/PR last update timestamp
commentobjectcomment output from the tool
↳ idnumberComment ID
↳ node_idstringComment node ID
↳ urlstringComment API URL
↳ html_urlstringComment HTML URL
↳ bodystringComment text
↳ userobjectuser output from the tool
↳ loginstringUsername
↳ idnumberUser ID
↳ node_idstringUser node ID
↳ avatar_urlstringAvatar URL
↳ html_urlstringProfile URL
↳ user_typestringUser type (User, Bot, Organization)
↳ created_atstringComment creation timestamp
↳ updated_atstringComment last update timestamp
repositoryobjectrepository output from the tool
↳ idnumberRepository ID
↳ node_idstringRepository node ID
↳ namestringRepository name
↳ full_namestringRepository full name (owner/repo)
↳ privatebooleanWhether the repository is private
↳ html_urlstringRepository HTML URL
↳ repo_descriptionstringRepository description
↳ ownerobjectowner output from the tool
↳ loginstringOwner username
↳ idnumberOwner ID
↳ node_idstringOwner node ID
↳ avatar_urlstringOwner avatar URL
↳ html_urlstringOwner profile URL
↳ owner_typestringOwner type (User, Organization)
senderobjectsender output from the tool
↳ loginstringUsername
↳ idnumberUser ID
↳ node_idstringUser node ID
↳ avatar_urlstringAvatar URL
↳ html_urlstringProfile URL
↳ user_typestringUser type (User, Bot, Organization)

GitHub PR Merged

Trigger workflow when a pull request is successfully merged in a GitHub repository

Configuration

ParameterTypeRequiredDescription
contentTypestringYesFormat GitHub will use when sending the webhook payload.
webhookSecretstringNoValidates that webhook deliveries originate from GitHub.
sslVerificationstringYesGitHub verifies SSL certificates when delivering webhooks.

Output

ParameterTypeDescription
event_typestringGitHub event type from X-GitHub-Event header (e.g., pull_request)
actionstringAction performed (opened, closed, synchronize, reopened, edited, etc.)
numbernumberPull request number
pull_requestobjectpull_request output from the tool
↳ idnumberPull request ID
↳ node_idstringPull request node ID
↳ numbernumberPull request number
↳ titlestringPull request title
↳ bodystringPull request description
↳ statestringPull request state (open, closed)
↳ mergedbooleanWhether the PR was merged
↳ merged_atstringTimestamp when PR was merged
↳ merged_byobjectmerged_by output from the tool
↳ loginstringUsername
↳ idnumberUser ID
↳ node_idstringUser node ID
↳ avatar_urlstringAvatar URL
↳ html_urlstringProfile URL
↳ user_typestringUser type (User, Bot, Organization)
↳ draftbooleanWhether the PR is a draft
↳ html_urlstringPull request HTML URL
↳ diff_urlstringPull request diff URL
↳ patch_urlstringPull request patch URL
↳ userobjectuser output from the tool
↳ loginstringUsername
↳ idnumberUser ID
↳ node_idstringUser node ID
↳ avatar_urlstringAvatar URL
↳ html_urlstringProfile URL
↳ user_typestringUser type (User, Bot, Organization)
↳ headobjecthead output from the tool
↳ refstringSource branch name
↳ shastringSource branch commit SHA
↳ repoobjectrepo output from the tool
↳ namestringSource repository name
↳ full_namestringSource repository full name
↳ baseobjectbase output from the tool
↳ refstringTarget branch name
↳ shastringTarget branch commit SHA
↳ repoobjectrepo output from the tool
↳ namestringTarget repository name
↳ full_namestringTarget repository full name
↳ additionsnumberNumber of lines added
↳ deletionsnumberNumber of lines deleted
↳ changed_filesnumberNumber of files changed
↳ labelsarrayArray of label objects
↳ assigneesarrayArray of assigned users
↳ requested_reviewersarrayArray of requested reviewers
↳ created_atstringPull request creation timestamp
↳ updated_atstringPull request last update timestamp
↳ closed_atstringPull request closed timestamp
repositoryobjectrepository output from the tool
↳ idnumberRepository ID
↳ node_idstringRepository node ID
↳ namestringRepository name
↳ full_namestringRepository full name (owner/repo)
↳ privatebooleanWhether the repository is private
↳ html_urlstringRepository HTML URL
↳ repo_descriptionstringRepository description
↳ forkbooleanWhether the repository is a fork
↳ urlstringRepository API URL
↳ homepagestringRepository homepage URL
↳ sizenumberRepository size in KB
↳ stargazers_countnumberNumber of stars
↳ watchers_countnumberNumber of watchers
↳ languagestringPrimary programming language
↳ forks_countnumberNumber of forks
↳ open_issues_countnumberNumber of open issues
↳ default_branchstringDefault branch name
↳ ownerobjectowner output from the tool
↳ loginstringOwner username
↳ idnumberOwner ID
↳ avatar_urlstringOwner avatar URL
↳ html_urlstringOwner profile URL
senderobjectsender output from the tool
↳ loginstringUsername
↳ idnumberUser ID
↳ node_idstringUser node ID
↳ avatar_urlstringAvatar URL
↳ html_urlstringProfile URL
↳ user_typestringUser type (User, Bot, Organization)

GitHub PR Opened

Trigger workflow when a new pull request is opened in a GitHub repository

Configuration

ParameterTypeRequiredDescription
contentTypestringYesFormat GitHub will use when sending the webhook payload.
webhookSecretstringNoValidates that webhook deliveries originate from GitHub.
sslVerificationstringYesGitHub verifies SSL certificates when delivering webhooks.

Output

ParameterTypeDescription
event_typestringGitHub event type from X-GitHub-Event header (e.g., pull_request)
actionstringAction performed (opened, closed, synchronize, reopened, edited, etc.)
numbernumberPull request number
pull_requestobjectpull_request output from the tool
↳ idnumberPull request ID
↳ node_idstringPull request node ID
↳ numbernumberPull request number
↳ titlestringPull request title
↳ bodystringPull request description
↳ statestringPull request state (open, closed)
↳ mergedbooleanWhether the PR was merged
↳ merged_atstringTimestamp when PR was merged
↳ merged_byobjectmerged_by output from the tool
↳ loginstringUsername
↳ idnumberUser ID
↳ node_idstringUser node ID
↳ avatar_urlstringAvatar URL
↳ html_urlstringProfile URL
↳ user_typestringUser type (User, Bot, Organization)
↳ draftbooleanWhether the PR is a draft
↳ html_urlstringPull request HTML URL
↳ diff_urlstringPull request diff URL
↳ patch_urlstringPull request patch URL
↳ userobjectuser output from the tool
↳ loginstringUsername
↳ idnumberUser ID
↳ node_idstringUser node ID
↳ avatar_urlstringAvatar URL
↳ html_urlstringProfile URL
↳ user_typestringUser type (User, Bot, Organization)
↳ headobjecthead output from the tool
↳ refstringSource branch name
↳ shastringSource branch commit SHA
↳ repoobjectrepo output from the tool
↳ namestringSource repository name
↳ full_namestringSource repository full name
↳ baseobjectbase output from the tool
↳ refstringTarget branch name
↳ shastringTarget branch commit SHA
↳ repoobjectrepo output from the tool
↳ namestringTarget repository name
↳ full_namestringTarget repository full name
↳ additionsnumberNumber of lines added
↳ deletionsnumberNumber of lines deleted
↳ changed_filesnumberNumber of files changed
↳ labelsarrayArray of label objects
↳ assigneesarrayArray of assigned users
↳ requested_reviewersarrayArray of requested reviewers
↳ created_atstringPull request creation timestamp
↳ updated_atstringPull request last update timestamp
↳ closed_atstringPull request closed timestamp
repositoryobjectrepository output from the tool
↳ idnumberRepository ID
↳ node_idstringRepository node ID
↳ namestringRepository name
↳ full_namestringRepository full name (owner/repo)
↳ privatebooleanWhether the repository is private
↳ html_urlstringRepository HTML URL
↳ repo_descriptionstringRepository description
↳ forkbooleanWhether the repository is a fork
↳ urlstringRepository API URL
↳ homepagestringRepository homepage URL
↳ sizenumberRepository size in KB
↳ stargazers_countnumberNumber of stars
↳ watchers_countnumberNumber of watchers
↳ languagestringPrimary programming language
↳ forks_countnumberNumber of forks
↳ open_issues_countnumberNumber of open issues
↳ default_branchstringDefault branch name
↳ ownerobjectowner output from the tool
↳ loginstringOwner username
↳ idnumberOwner ID
↳ avatar_urlstringOwner avatar URL
↳ html_urlstringOwner profile URL
↳ owner_typestringOwner type (User, Organization)
senderobjectsender output from the tool
↳ loginstringUsername
↳ idnumberUser ID
↳ node_idstringUser node ID
↳ avatar_urlstringAvatar URL
↳ html_urlstringProfile URL
↳ user_typestringUser type (User, Bot, Organization)

GitHub PR Reviewed

Trigger workflow when a pull request review is submitted, edited, or dismissed in a GitHub repository

Configuration

ParameterTypeRequiredDescription
contentTypestringYesFormat GitHub will use when sending the webhook payload.
webhookSecretstringNoValidates that webhook deliveries originate from GitHub.
sslVerificationstringYesGitHub verifies SSL certificates when delivering webhooks.

Output

ParameterTypeDescription
event_typestringGitHub event type from X-GitHub-Event header (e.g., pull_request_review)
actionstringAction performed (submitted, edited, dismissed)
reviewobjectreview output from the tool
↳ idnumberReview ID
↳ node_idstringReview node ID
↳ userobjectuser output from the tool
↳ loginstringReviewer username
↳ idnumberReviewer user ID
↳ node_idstringReviewer node ID
↳ avatar_urlstringReviewer avatar URL
↳ html_urlstringReviewer profile URL
↳ user_typestringUser type (User, Bot, Organization)
↳ bodystringReview comment text
↳ statestringReview state (approved, changes_requested, commented, dismissed)
↳ html_urlstringReview HTML URL
↳ submitted_atstringReview submission timestamp
↳ commit_idstringCommit SHA that was reviewed
↳ author_associationstringAuthor association (OWNER, MEMBER, COLLABORATOR, CONTRIBUTOR, etc.)
pull_requestobjectpull_request output from the tool
↳ idnumberPull request ID
↳ node_idstringPull request node ID
↳ numbernumberPull request number
↳ titlestringPull request title
↳ bodystringPull request description
↳ statestringPull request state (open, closed)
↳ mergedbooleanWhether the PR was merged
↳ draftbooleanWhether the PR is a draft
↳ html_urlstringPull request HTML URL
↳ diff_urlstringPull request diff URL
↳ patch_urlstringPull request patch URL
↳ userobjectuser output from the tool
↳ loginstringPR author username
↳ idnumberPR author user ID
↳ node_idstringPR author node ID
↳ avatar_urlstringPR author avatar URL
↳ html_urlstringPR author profile URL
↳ user_typestringUser type (User, Bot, Organization)
↳ headobjecthead output from the tool
↳ refstringSource branch name
↳ shastringSource branch commit SHA
↳ repoobjectrepo output from the tool
↳ namestringSource repository name
↳ full_namestringSource repository full name
↳ baseobjectbase output from the tool
↳ refstringTarget branch name
↳ shastringTarget branch commit SHA
↳ repoobjectrepo output from the tool
↳ namestringTarget repository name
↳ full_namestringTarget repository full name
↳ created_atstringPull request creation timestamp
↳ updated_atstringPull request last update timestamp
repositoryobjectrepository output from the tool
↳ idnumberRepository ID
↳ node_idstringRepository node ID
↳ namestringRepository name
↳ full_namestringRepository full name (owner/repo)
↳ privatebooleanWhether the repository is private
↳ html_urlstringRepository HTML URL
↳ repo_descriptionstringRepository description
↳ ownerobjectowner output from the tool
↳ loginstringOwner username
↳ idnumberOwner ID
↳ node_idstringOwner node ID
↳ avatar_urlstringOwner avatar URL
↳ html_urlstringOwner profile URL
↳ owner_typestringOwner type (User, Organization)
senderobjectsender output from the tool
↳ loginstringUsername
↳ idnumberUser ID
↳ node_idstringUser node ID
↳ avatar_urlstringAvatar URL
↳ html_urlstringProfile URL
↳ user_typestringUser type (User, Bot, Organization)

GitHub Push

Trigger workflow when code is pushed to a repository

Configuration

ParameterTypeRequiredDescription
contentTypestringYesFormat GitHub will use when sending the webhook payload.
webhookSecretstringNoValidates that webhook deliveries originate from GitHub.
sslVerificationstringYesGitHub verifies SSL certificates when delivering webhooks.

Output

ParameterTypeDescription
event_typestringGitHub event type from X-GitHub-Event header (e.g., push)
branchstringBranch name derived from ref (e.g., main from refs/heads/main)
refstringGit reference that was pushed (e.g., refs/heads/main)
beforestringSHA of the commit before the push
afterstringSHA of the commit after the push
createdbooleanWhether this push created a new branch or tag
deletedbooleanWhether this push deleted a branch or tag
forcedbooleanWhether this was a force push
base_refstringBase reference for the push
comparestringURL to compare the changes
commitsarrayArray of commit objects included in this push
head_commitobjecthead_commit output from the tool
↳ idstringCommit SHA of the most recent commit
↳ tree_idstringGit tree SHA
↳ distinctbooleanWhether this commit is distinct
↳ messagestringCommit message
↳ timestampstringCommit timestamp
↳ urlstringCommit URL
↳ authorobjectauthor output from the tool
↳ namestringAuthor name
↳ emailstringAuthor email
↳ usernamestringAuthor GitHub username
↳ committerobjectcommitter output from the tool
↳ namestringCommitter name
↳ emailstringCommitter email
↳ usernamestringCommitter GitHub username
↳ addedarrayArray of file paths added in this commit
↳ removedarrayArray of file paths removed in this commit
↳ modifiedarrayArray of file paths modified in this commit
pusherobjectpusher output from the tool
↳ namestringPusher name
↳ emailstringPusher email
repositoryobjectrepository output from the tool
↳ idnumberRepository ID
↳ node_idstringRepository node ID
↳ namestringRepository name
↳ full_namestringRepository full name (owner/repo)
↳ privatebooleanWhether the repository is private
↳ html_urlstringRepository HTML URL
↳ repo_descriptionstringRepository description
↳ forkbooleanWhether the repository is a fork
↳ urlstringRepository API URL
↳ homepagestringRepository homepage URL
↳ sizenumberRepository size in KB
↳ stargazers_countnumberNumber of stars
↳ watchers_countnumberNumber of watchers
↳ languagestringPrimary programming language
↳ forks_countnumberNumber of forks
↳ open_issues_countnumberNumber of open issues
↳ default_branchstringDefault branch name
↳ ownerobjectowner output from the tool
↳ loginstringOwner username
↳ idnumberOwner ID
↳ node_idstringOwner node ID
↳ avatar_urlstringOwner avatar URL
↳ html_urlstringOwner profile URL
↳ owner_typestringOwner type (User, Organization)
senderobjectsender output from the tool
↳ loginstringUsername
↳ idnumberUser ID
↳ node_idstringUser node ID
↳ avatar_urlstringAvatar URL
↳ html_urlstringProfile URL
↳ user_typestringUser type (User, Bot, Organization)

GitHub Release Published

Trigger workflow when a new release is published in a GitHub repository

Configuration

ParameterTypeRequiredDescription
contentTypestringYesFormat GitHub will use when sending the webhook payload.
webhookSecretstringNoValidates that webhook deliveries originate from GitHub.
sslVerificationstringYesGitHub verifies SSL certificates when delivering webhooks.

Output

ParameterTypeDescription
event_typestringGitHub event type from X-GitHub-Event header (e.g., release)
actionstringAction performed (published, unpublished, created, edited, deleted, prereleased, released)
releaseobjectrelease output from the tool
↳ idnumberRelease ID
↳ node_idstringRelease node ID
↳ tag_namestringGit tag name for the release
↳ target_commitishstringTarget branch or commit SHA
↳ namestringRelease name/title
↳ bodystringRelease description/notes in markdown format
↳ draftbooleanWhether the release is a draft
↳ prereleasebooleanWhether the release is a pre-release
↳ created_atstringRelease creation timestamp
↳ published_atstringRelease publication timestamp
↳ urlstringRelease API URL
↳ html_urlstringRelease HTML URL
↳ assets_urlstringRelease assets API URL
↳ upload_urlstringURL for uploading release assets
↳ tarball_urlstringSource code tarball download URL
↳ zipball_urlstringSource code zipball download URL
↳ discussion_urlstringDiscussion URL if available
↳ authorobjectauthor output from the tool
↳ loginstringUsername
↳ idnumberUser ID
↳ node_idstringUser node ID
↳ avatar_urlstringAvatar URL
↳ gravatar_idstringGravatar ID
↳ urlstringUser API URL
↳ html_urlstringProfile URL
↳ followers_urlstringFollowers API URL
↳ following_urlstringFollowing API URL
↳ gists_urlstringGists API URL
↳ starred_urlstringStarred repositories API URL
↳ subscriptions_urlstringSubscriptions API URL
↳ organizations_urlstringOrganizations API URL
↳ repos_urlstringRepositories API URL
↳ events_urlstringEvents API URL
↳ received_events_urlstringReceived events API URL
↳ user_typestringUser type (User, Bot, Organization)
↳ site_adminbooleanWhether user is a site administrator
↳ assetsarrayArray of release asset objects with download URLs
repositoryobjectrepository output from the tool
↳ idnumberRepository ID
↳ node_idstringRepository node ID
↳ namestringRepository name
↳ full_namestringRepository full name (owner/repo)
↳ privatebooleanWhether the repository is private
↳ html_urlstringRepository HTML URL
↳ repo_descriptionstringRepository description
↳ forkbooleanWhether the repository is a fork
↳ urlstringRepository API URL
↳ archive_urlstringArchive API URL
↳ assignees_urlstringAssignees API URL
↳ blobs_urlstringBlobs API URL
↳ branches_urlstringBranches API URL
↳ collaborators_urlstringCollaborators API URL
↳ comments_urlstringComments API URL
↳ commits_urlstringCommits API URL
↳ compare_urlstringCompare API URL
↳ contents_urlstringContents API URL
↳ contributors_urlstringContributors API URL
↳ deployments_urlstringDeployments API URL
↳ downloads_urlstringDownloads API URL
↳ events_urlstringEvents API URL
↳ forks_urlstringForks API URL
↳ git_commits_urlstringGit commits API URL
↳ git_refs_urlstringGit refs API URL
↳ git_tags_urlstringGit tags API URL
↳ hooks_urlstringHooks API URL
↳ issue_comment_urlstringIssue comment API URL
↳ issue_events_urlstringIssue events API URL
↳ issues_urlstringIssues API URL
↳ keys_urlstringKeys API URL
↳ labels_urlstringLabels API URL
↳ languages_urlstringLanguages API URL
↳ merges_urlstringMerges API URL
↳ milestones_urlstringMilestones API URL
↳ notifications_urlstringNotifications API URL
↳ pulls_urlstringPull requests API URL
↳ releases_urlstringReleases API URL
↳ stargazers_urlstringStargazers API URL
↳ statuses_urlstringStatuses API URL
↳ subscribers_urlstringSubscribers API URL
↳ subscription_urlstringSubscription API URL
↳ tags_urlstringTags API URL
↳ teams_urlstringTeams API URL
↳ trees_urlstringTrees API URL
↳ homepagestringRepository homepage URL
↳ sizenumberRepository size in KB
↳ stargazers_countnumberNumber of stars
↳ watchers_countnumberNumber of watchers
↳ languagestringPrimary programming language
↳ has_issuesbooleanWhether issues are enabled
↳ has_projectsbooleanWhether projects are enabled
↳ has_downloadsbooleanWhether downloads are enabled
↳ has_wikibooleanWhether wiki is enabled
↳ has_pagesbooleanWhether GitHub Pages is enabled
↳ forks_countnumberNumber of forks
↳ mirror_urlstringMirror URL if repository is a mirror
↳ archivedbooleanWhether the repository is archived
↳ disabledbooleanWhether the repository is disabled
↳ open_issues_countnumberNumber of open issues
↳ licenseobjectlicense output from the tool
↳ keystringLicense key
↳ namestringLicense name
↳ spdx_idstringSPDX license identifier
↳ urlstringLicense API URL
↳ node_idstringLicense node ID
↳ allow_forkingbooleanWhether forking is allowed
↳ is_templatebooleanWhether repository is a template
↳ topicsarrayArray of repository topics
↳ visibilitystringRepository visibility (public, private, internal)
↳ forksnumberNumber of forks
↳ open_issuesnumberNumber of open issues
↳ watchersnumberNumber of watchers
↳ default_branchstringDefault branch name
↳ created_atstringRepository creation timestamp
↳ updated_atstringRepository last update timestamp
↳ pushed_atstringRepository last push timestamp
↳ ownerobjectowner output from the tool
↳ loginstringOwner username
↳ idnumberOwner ID
↳ node_idstringOwner node ID
↳ avatar_urlstringOwner avatar URL
↳ gravatar_idstringOwner gravatar ID
↳ urlstringOwner API URL
↳ html_urlstringOwner profile URL
↳ followers_urlstringFollowers API URL
↳ following_urlstringFollowing API URL
↳ gists_urlstringGists API URL
↳ starred_urlstringStarred repositories API URL
↳ subscriptions_urlstringSubscriptions API URL
↳ organizations_urlstringOrganizations API URL
↳ repos_urlstringRepositories API URL
↳ events_urlstringEvents API URL
↳ received_events_urlstringReceived events API URL
↳ owner_typestringOwner type (User, Organization)
↳ site_adminbooleanWhether owner is a site administrator
senderobjectsender output from the tool
↳ loginstringUsername
↳ idnumberUser ID
↳ node_idstringUser node ID
↳ avatar_urlstringAvatar URL
↳ gravatar_idstringGravatar ID
↳ urlstringUser API URL
↳ html_urlstringProfile URL
↳ followers_urlstringFollowers API URL
↳ following_urlstringFollowing API URL
↳ gists_urlstringGists API URL
↳ starred_urlstringStarred repositories API URL
↳ subscriptions_urlstringSubscriptions API URL
↳ organizations_urlstringOrganizations API URL
↳ repos_urlstringRepositories API URL
↳ events_urlstringEvents API URL
↳ received_events_urlstringReceived events API URL
↳ user_typestringUser type (User, Bot, Organization)
↳ site_adminbooleanWhether user is a site administrator

GitHub Webhook

Trigger workflow from GitHub events like push, pull requests, issues, and more

Configuration

ParameterTypeRequiredDescription
contentTypestringYesFormat GitHub will use when sending the webhook payload.
webhookSecretstringNoValidates that webhook deliveries originate from GitHub.
sslVerificationstringYesGitHub verifies SSL certificates when delivering webhooks.

Output

ParameterTypeDescription
refstringGit reference (e.g., refs/heads/fix/telegram-wh)
beforestringSHA of the commit before the push
afterstringSHA of the commit after the push
createdbooleanWhether the push created the reference
deletedbooleanWhether the push deleted the reference
forcedbooleanWhether the push was forced
base_refstringBase reference for the push
comparestringURL to compare the changes
repositoryobjectrepository output from the tool
↳ idnumberRepository ID
↳ node_idstringRepository node ID
↳ namestringRepository name
↳ full_namestringRepository full name (owner/repo)
↳ privatebooleanWhether the repository is private
↳ html_urlstringRepository HTML URL
↳ forkbooleanWhether the repository is a fork
↳ urlstringRepository API URL
↳ created_atnumberRepository creation timestamp
↳ updated_atstringRepository last updated time
↳ pushed_atnumberRepository last push timestamp
↳ git_urlstringRepository git URL
↳ ssh_urlstringRepository SSH URL
↳ clone_urlstringRepository clone URL
↳ homepagestringRepository homepage URL
↳ sizenumberRepository size
↳ stargazers_countnumberNumber of stars
↳ watchers_countnumberNumber of watchers
↳ languagestringPrimary programming language
↳ forks_countnumberNumber of forks
↳ archivedbooleanWhether the repository is archived
↳ disabledbooleanWhether the repository is disabled
↳ open_issues_countnumberNumber of open issues
↳ topicsarrayRepository topics
↳ visibilitystringRepository visibility (public, private)
↳ forksnumberNumber of forks
↳ open_issuesnumberNumber of open issues
↳ watchersnumberNumber of watchers
↳ default_branchstringDefault branch name
↳ stargazersnumberNumber of stargazers
↳ master_branchstringMaster branch name
↳ ownerobjectowner output from the tool
↳ namestringOwner name
↳ emailstringOwner email
↳ loginstringOwner username
↳ idnumberOwner ID
↳ node_idstringOwner node ID
↳ avatar_urlstringOwner avatar URL
↳ gravatar_idstringOwner gravatar ID
↳ urlstringOwner API URL
↳ html_urlstringOwner profile URL
↳ user_view_typestringUser view type
↳ site_adminbooleanWhether the owner is a site admin
↳ licenseobjectRepository license information
↳ keystringLicense key (e.g., apache-2.0)
↳ namestringLicense name
↳ spdx_idstringSPDX license identifier
↳ urlstringLicense URL
↳ node_idstringLicense node ID
pusherobjectInformation about who pushed the changes
↳ namestringPusher name
↳ emailstringPusher email
senderobjectsender output from the tool
↳ loginstringSender username
↳ idnumberSender ID
↳ node_idstringSender node ID
↳ avatar_urlstringSender avatar URL
↳ gravatar_idstringSender gravatar ID
↳ urlstringSender API URL
↳ html_urlstringSender profile URL
↳ user_view_typestringUser view type
↳ site_adminbooleanWhether the sender is a site admin
commitsarrayArray of commit objects
head_commitobjectHead commit object
↳ idstringCommit SHA
↳ tree_idstringTree SHA
↳ distinctbooleanWhether the commit is distinct
↳ messagestringCommit message
↳ timestampstringCommit timestamp
↳ urlstringCommit URL
↳ authorobjectCommit author
↳ namestringAuthor name
↳ emailstringAuthor email
↳ committerobjectCommit committer
↳ namestringCommitter name
↳ emailstringCommitter email
↳ addedarrayArray of added files
↳ removedarrayArray of removed files
↳ modifiedarrayArray of modified files
event_typestringType of GitHub event (e.g., push, pull_request, issues)
actionstringThe action that was performed (e.g., opened, closed, synchronize)
branchstringBranch name extracted from ref