GitHub

GitHub hosts code and tracks the work around it — issues, pull requests, releases and Actions runs.

Authentication

• GitHub App installation
• OAuth 2.0

Actions

Generic API request. Call any GitHub REST endpoint on this connection, for the case where no shipped action covers it yet. The connection supplies the base URL, the authentication and the egress route, so only the path, query and body are yours to fill.

• Add a reaction to a commentReact to a comment with an emoji - eyes to show a comment is being looked at, +1 to acknowledge it - on either kind of comment GitHub has: a conversation comment on an issue or pull request (target issuecomment) or an inline review comment on a pull request's diff (target pullrequestreviewcomment).
• Add labels to issueAdd labels to an existing issue or pull request — GitHub treats both as issues here, so pass a PR number the same way.
• Comment on a discussionPost a comment on a repository discussion, or a reply under a top-level comment.
• Create a Git blobStore one file's new contents in the repository's object database and get back its sha, which a github:createtree entry then points at.
• Create a Git commitCreate a commit object from a tree (github:createtree) and its parent commits - the way to land several file changes as one commit.
• Create a Git referenceCreate a branch or a tag by pointing a new reference at an existing commit — this is how you branch without cloning, and how you publish a tag.
• Create a Git treeBuild the file tree of a new commit: the tree of basetree with each listed path replaced by a blob (sha from github:createblob) or by inline text content.
• Create issueOpen a new issue in a repository, optionally pre-labelled and pre-assigned.
• Create issue commentAdd a comment to an issue or pull request (POST /repos/{owner}/{repo}/issues/{issuenumber}/comments, JSON body).
• Create or update fileWrite a single file into a repository as one commit — creating it when it does not exist, replacing it when it does.
• Create pull requestOpen a pull request proposing that head be merged into base — both are branch names in the repository, and head is the branch carrying your changes.
• Create pull request reviewSubmit a review on a pull request - approve it, request changes, or comment, chosen with event - optionally with inline comments anchored to lines of the diff, all published together as one review.
• Create releasePublish a GitHub release against a tag, with optional release notes.
• Delete a fileDestructiveRemove one file from a repository as a single commit — the counterpart of createorupdatefile.
• Delete a Git referenceDestructiveDelete a branch or a tag.
• Dispatch workflowDestructiveTrigger a GitHub Actions workflow run (POST /repos/{owner}/{repo}/actions/workflows/{workflowid}/dispatches, JSON body).
• Download job logsDownload the plain-text log of one GitHub Actions job into a file reference — the full console output of every step, timestamped line by line, which is what explains a failed job.
• Get a branchRead one branch by name and get back the commit at its tip plus whether a protection rule covers it.
• Get a Git referenceRead where a branch or tag points - the first step of committing through the Git Data API, since the returned object.sha is the branch head, the parent of the new commit, and checking it again just before github:updateref shows whether someone pushed meanwhile.
• Get a member's verified organization emailsRead the verified email addresses a user holds in an organization's verified domains, with the user's database id and login.
• Get a releaseFetch a single release by its numeric id.
• Get authenticated userGet the profile of the user the connection is authenticated as (GET /user).
• Get issueRead one issue by its repository-scoped number, to check its current title and open/closed state when investigating work or checking a possible duplicate.
• Get pull requestRead one pull request by its repository-scoped number, to inspect its branches, mergeability and review state before merging or reviewing it.
• Get repositoryGet a single repository by owner and name (GET /repos/{owner}/{repo}).
• Get repository contentRead a path in a repository — a file or a directory.
• Get the latest releaseFetch the repository's latest release — the most recent non-draft, non-prerelease release by the sort GitHub applies, which is not necessarily the newest tag.
• List branchesList a repository's branches, paged with page and perPage.
• List check runs for a refList the check runs reported against a commit, branch or tag — every CI job, linter and app check with its status, conclusion and summary.
• List commitsList commits in a repository, newest first.
• List issue commentsList comments on an issue or pull request (GET /repos/{owner}/{repo}/issues/{issuenumber}/comments).
• List issuesList the issues in a repository, narrowed by state, labels, milestone, assignee, creator, mention or last-update time, and ordered by creation, update or comment count.
• List organization repositoriesList the repositories owned by a GitHub organization.
• List pull request commitsList the commits that make up a pull request, in the order they appear on the head branch— use it to read commit messages before reviewing, or to find the head sha that github:createprreview needs for a line-anchored review comment.
• List pull request filesList the files a pull request changes, each with its status, line counts and patch - the unified diff of that file, which is what a review reads and what inline review comments anchor to.
• List pull request review commentsRead the inline review comments on a pull request's diff - each with its path, line, diffhunk and inreplytoid - to see what reviewers asked for and which thread each comment belongs to.
• List pull requestsList the pull requests on a repository, to survey what is open for review or to find a PR number before reviewing or merging it.
• List releasesList a repository's releases, newest first, paged with page and perPage.
• List repositoriesList the repositories the connected GitHub user owns or collaborates on.
• List workflow run jobsList the jobs of one GitHub Actions workflow run, each with its status, conclusion, runner and per-step results — the way to find which job and step of a failed run broke.
• List workflow runsList all GitHub Actions workflow runs for a repository (GET /repos/{owner}/{repo}/actions/runs).
• List workflowsList the GitHub Actions workflows in a repository (GET /repos/{owner}/{repo}/actions/workflows).
• Merge pull requestDestructiveMerge an open pull request, choosing how history is written with mergeMethod (merge commit, squash or rebase) and optionally naming the merge commit.
• Reply to a review commentAnswer inside an inline review thread on a pull request's diff, so the reply sits under the reviewer's comment rather than at the bottom of the conversation.
• Search codeSearch inside file contents on the default branch of indexed repositories.
• Search issues and pull requestsSearch issues and pull requests across GitHub using its search query syntax — the way to find work by criteria rather than by number (for example repo:octocat/Hello-World is:issue is:open).
• Update a Git referenceMove a branch to a new commit - the step that publishes a commit made with github:createcommit, and on a pull request's head branch the step that adds it to the pull request.
• Update issueDestructiveUpdate an existing issue: retitle it, rewrite its markdown body, close or reopen it with state, or reset its labels and assignees.
• Update pull requestDestructiveChange an open pull request in place — retitle it, rewrite its description, retarget its base branch, or close and reopen it.

Triggers

• Branch or tag createdStarts when a branch or a tag is created in a GitHub repository.
• Branch or tag deletedStarts when a Git branch or tag is deleted in a GitHub repository.
• Branch protection configuration activityStarts on every GitHub branchprotectionconfiguration webhook delivery for the repository — branch protection is turned on or off for the whole repository.
• Branch protection rule activityStarts on every GitHub branchprotectionrule webhook delivery for the repository — a branch protection rule is created, edited or deleted.
• Check run activityStarts on every GitHub checkrun webhook delivery for the repository — a check run is created or reaches a conclusion.
• Check suite completedStarts when every check run in a check suite has finished and a conclusion is available.
• Code pushedStarts when commits are pushed to a branch or a tag is pushed in a GitHub repository.
• Code scanning alert activityStarts on every GitHub codescanningalert webhook delivery for the repository — a code scanning alert is raised, fixed, closed, reopened or reassigned.
• Commit comment createdStarts when someone comments directly on a commit in the repository.
• Commit status changedStarts when the state of a commit status changes in a GitHub repository.
• Dependabot alert activityStarts on every GitHub dependabotalert webhook delivery for the repository — a Dependabot alert is raised, dismissed, fixed, reopened or reassigned.
• Deploy key activityStarts on every GitHub deploykey webhook delivery for the repository — a deploy key is added to or removed from the repository.
• Deployment createdStarts when a deployment is created for a GitHub repository.
• Deployment status createdStarts when a deployment status is posted against a deployment in the repository — how a deployment reports that it succeeded, failed, or moved to another state.
• Discussion activityStarts on every GitHub discussion webhook delivery for the repository — a discussion is created, edited, answered, labelled, locked, pinned, transferred, closed, reopened or deleted.
• Discussion comment activityStarts on every GitHub discussioncomment webhook delivery for the repository — a comment on a discussion is created, edited or deleted.
• GitHub Pages build finishedStarts when a GitHub Pages site build finishes for the repository, whether the build succeeded or errored.
• Issue activityStarts on every GitHub issues webhook delivery for the repository — an issue is opened, edited, closed, reopened, assigned, labelled, milestoned, pinned, locked, transferred, typed or deleted.
• Issue comment activityStarts on every GitHub issuecomment webhook delivery for the repository — a comment on an issue or a pull request is created, edited, deleted, pinned or unpinned.
• Issue dependency activityStarts on every GitHub issuedependencies webhook delivery for the repository — a blocking or blocked-by relationship between two issues is added or removed.
• Label activityStarts on every GitHub label webhook delivery for the repository — a repository label is created, edited or deleted.
• Milestone activityStarts on every GitHub milestone webhook delivery for the repository — a milestone is created, edited, closed, reopened or deleted.
• Organization activityStarts on every GitHub organization webhook delivery for the organization — the organization is renamed or deleted, or a member is invited, added or removed.
• Organization block activityStarts on every GitHub orgblock webhook delivery for the organization — the organization blocks or unblocks a user.
• Organization custom property activityStarts on every GitHub customproperty webhook delivery for the organization — a custom property definition is created, updated, deleted or promoted to the enterprise.
• Package activityStarts on every GitHub package webhook delivery for the repository — a GitHub Packages package is published or updated.
• Project activityStarts on every GitHub projectsv2 webhook delivery for the organization — a project is created, edited, closed, reopened or deleted.
• Project item activityStarts on every GitHub projectsv2item webhook delivery for the organization — an item is added to a project, edited, reordered, archived, restored, converted to an issue or deleted.
• Project status update activityStarts on every GitHub projectsv2statusupdate webhook delivery for the organization — a status update on a project is created, edited or deleted.
• Pull request activityStarts on every GitHub pullrequest webhook delivery for the repository — a pull request is opened, edited, closed, merged, reopened, synchronized, assigned, labelled, review-requested, enqueued or any other pullrequest action.
• Pull request review activityStarts on every GitHub pullrequestreview webhook delivery for the repository — a review is submitted, edited or dismissed on a pull request.
• Pull request review comment activityStarts on every GitHub pullrequestreviewcomment webhook delivery for the repository — a comment on a pull request diff is created, edited or deleted.
• Pull request review thread activityStarts on every GitHub pullrequestreviewthread webhook delivery for the repository — a review thread on a pull request is resolved or unresolved.
• Pull requests and issues for the agentAnswers as an agent on GitHub: when someone @-mentions the connected account on an issue, a pull request or a discussion — or, as you choose, a pull request is opened or asks it for review, an issue is opened, or CI fails on a pull request — the agent answers there in comments, and later comments on the same item…
• Release activityStarts on every GitHub release webhook delivery for the repository — a release is drafted, published, edited, released, prereleased, unpublished or deleted.
• Repository activityStarts on every GitHub repository webhook delivery for the repository — the repository is edited, renamed, transferred, archived, unarchived, made public or made private.
• Repository collaborator activityStarts on every GitHub member webhook delivery for the repository — a collaborator is added to the repository, has their permission changed, or is removed.
• Repository custom property values updatedStarts when the organization custom property values set on a repository change.
• Repository forkedStarts when a GitHub repository is forked.
• Repository import finishedStarts when a repository import into GitHub finishes.
• Repository made publicStarts when a private GitHub repository is made public.
• Repository ruleset activityStarts on every GitHub repositoryruleset webhook delivery for the repository — a repository ruleset is created, edited or deleted.
• Repository security advisory activityStarts on every GitHub repositoryadvisory webhook delivery for the repository — a repository security advisory is reported or published.
• Repository starred (watch event)Starts when someone stars the GitHub repository — GitHub's watch event reports starring, not watching, and sends no delivery when a star is removed.
• Secret detected in a new locationStarts when secret scanning records a new location for an existing alert in a GitHub repository — the same secret found in another commit, issue, pull request, or discussion.
• Secret scanning alert activityStarts on every GitHub secretscanningalert webhook delivery for the repository — a secret scanning alert is raised, resolved, reopened, validated, reassigned or publicly leaked.
• Secret scanning scan completedStarts when a secret scanning backfill scan of the repository finishes.
• Security feature enabled or disabledStarts when a code security or analysis feature is turned on or off for the repository — advanced security, secret scanning, push protection or Dependabot updates.
• Star activityStarts on every GitHub star webhook delivery for the repository — the repository is starred or unstarred.
• Sub-issue activityStarts on every GitHub subissues webhook delivery for the repository — a sub-issue or parent-issue relationship is added or removed.
• Team activityStarts on every GitHub team webhook delivery for the organization — a team is created, edited or deleted, or gains or loses access to a repository.
• Team granted access to this repositoryStarts when a team is added to the repository this trigger watches.
• Team membership activityStarts on every GitHub membership webhook delivery for the organization — a user is added to or removed from a team in the organization.
• Webhook deletedStarts when this trigger's own GitHub webhook is deleted.
• Wiki page updatedStarts when a wiki page is created or edited in a GitHub repository.
• Workflow job activityStarts on every GitHub workflowjob webhook delivery for the repository — a GitHub Actions job is queued, starts waiting for approval, begins running or completes.
• Workflow run activityStarts on every GitHub workflowrun webhook delivery for the repository — a GitHub Actions workflow run is requested, begins running or completes.

Product names, logos and brands are the property of their respective owners and are used here for identification only. Their use does not imply endorsement by, or affiliation with, those owners.