Integrate Github into the workflow. Can get get PR details, create PR comment, get repository info, and get latest commit. Can be used in trigger mode to trigger a workflow when a PR is created, commented on, or a commit is pushed.
Fetch PR details including diff and files changed
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner |
repo | string | Yes | Repository name |
pullNumber | number | Yes | Pull request number |
apiKey | string | Yes | GitHub API token |
| Parameter | Type | Description |
|---|
content | string | Human-readable PR summary |
metadata | object | Detailed PR metadata including file changes |
Create comments on GitHub PRs
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner |
repo | string | Yes | Repository name |
body | string | Yes | Comment content |
pullNumber | number | Yes | Pull request number |
path | string | No | File path for review comment |
commentType | string | No | Type of comment (pr_comment or file_comment) |
apiKey | string | Yes | GitHub API token |
| Parameter | Type | Description |
|---|
content | string | Human-readable comment confirmation |
metadata | object | Comment metadata |
Retrieve comprehensive GitHub repository metadata including stars, forks, issues, and primary language. Supports both public and private repositories with optional authentication.
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner (user or organization) |
repo | string | Yes | Repository name |
apiKey | string | Yes | GitHub Personal Access Token |
| Parameter | Type | Description |
|---|
content | string | Human-readable repository summary |
metadata | object | Repository metadata |
Retrieve the latest commit from a GitHub repository
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner (user or organization) |
repo | string | Yes | Repository name |
branch | string | No | Branch name (defaults to the repository's default branch) |
apiKey | string | Yes | GitHub API token |
| Parameter | Type | Description |
|---|
content | string | Human-readable commit summary |
metadata | object | Commit metadata |
Create a comment on a GitHub issue
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner |
repo | string | Yes | Repository name |
issue_number | number | Yes | Issue number |
body | string | Yes | Comment content |
apiKey | string | Yes | GitHub API token |
| Parameter | Type | Description |
|---|
content | string | Human-readable comment confirmation |
metadata | object | Comment metadata |
List all comments on a GitHub issue
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner |
repo | string | Yes | Repository name |
issue_number | number | Yes | Issue number |
since | string | No | Only show comments updated after this ISO 8601 timestamp |
per_page | number | No | Number of results per page (max 100) |
page | number | No | Page number |
apiKey | string | Yes | GitHub API token |
| Parameter | Type | Description |
|---|
content | string | Human-readable comments summary |
metadata | object | Comments list metadata |
Update an existing comment on a GitHub issue or pull request
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner |
repo | string | Yes | Repository name |
comment_id | number | Yes | Comment ID |
body | string | Yes | Updated comment content |
apiKey | string | Yes | GitHub API token |
| Parameter | Type | Description |
|---|
content | string | Human-readable update confirmation |
metadata | object | Updated comment metadata |
Delete a comment on a GitHub issue or pull request
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner |
repo | string | Yes | Repository name |
comment_id | number | Yes | Comment ID |
apiKey | string | Yes | GitHub API token |
| Parameter | Type | Description |
|---|
content | string | Human-readable deletion confirmation |
metadata | object | Deletion result metadata |
List all review comments on a GitHub pull request
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner |
repo | string | Yes | Repository name |
pullNumber | number | Yes | Pull request number |
sort | string | No | Sort by created or updated |
direction | string | No | Sort direction (asc or desc) |
since | string | No | Only show comments updated after this ISO 8601 timestamp |
per_page | number | No | Number of results per page (max 100) |
page | number | No | Page number |
apiKey | string | Yes | GitHub API token |
| Parameter | Type | Description |
|---|
content | string | Human-readable review comments summary |
metadata | object | Review comments list metadata |
Create a new pull request in a GitHub repository
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner |
repo | string | Yes | Repository name |
title | string | Yes | Pull request title |
head | string | Yes | The name of the branch where your changes are implemented |
base | string | Yes | The name of the branch you want the changes pulled into |
body | string | No | Pull request description (Markdown) |
draft | boolean | No | Create as draft pull request |
apiKey | string | Yes | GitHub API token |
| Parameter | Type | Description |
|---|
content | string | Human-readable PR creation confirmation |
metadata | object | Pull request metadata |
Update an existing pull request in a GitHub repository
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner |
repo | string | Yes | Repository name |
pullNumber | number | Yes | Pull request number |
title | string | No | New pull request title |
body | string | No | New pull request description (Markdown) |
state | string | No | New state (open or closed) |
base | string | No | New base branch name |
apiKey | string | Yes | GitHub API token |
| Parameter | Type | Description |
|---|
content | string | Human-readable PR update confirmation |
metadata | object | Updated pull request metadata |
Merge a pull request in a GitHub repository
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner |
repo | string | Yes | Repository name |
pullNumber | number | Yes | Pull request number |
commit_title | string | No | Title for the merge commit |
commit_message | string | No | Extra detail to append to merge commit message |
merge_method | string | No | Merge method: merge, squash, or rebase |
apiKey | string | Yes | GitHub API token |
| Parameter | Type | Description |
|---|
content | string | Human-readable merge confirmation |
metadata | object | Merge result metadata |
List pull requests in a GitHub repository
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner |
repo | string | Yes | Repository name |
state | string | No | Filter by state: open, closed, or all |
head | string | No | Filter by head user or branch name (format: user:ref-name or organization:ref-name) |
base | string | No | Filter by base branch name |
sort | string | No | Sort by: created, updated, popularity, or long-running |
direction | string | No | Sort direction: asc or desc |
per_page | number | No | Results per page (max 100) |
page | number | No | Page number |
apiKey | string | Yes | GitHub API token |
| Parameter | Type | Description |
|---|
content | string | Human-readable list of pull requests |
metadata | object | Pull requests list metadata |
Get the list of files changed in a pull request
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner |
repo | string | Yes | Repository name |
pullNumber | number | Yes | Pull request number |
per_page | number | No | Results per page (max 100) |
page | number | No | Page number |
apiKey | string | Yes | GitHub API token |
| Parameter | Type | Description |
|---|
content | string | Human-readable list of files changed in PR |
metadata | object | PR files metadata |
Close a pull request in a GitHub repository
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner |
repo | string | Yes | Repository name |
pullNumber | number | Yes | Pull request number |
apiKey | string | Yes | GitHub API token |
| Parameter | Type | Description |
|---|
content | string | Human-readable PR close confirmation |
metadata | object | Closed pull request metadata |
Request reviewers for a pull request
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner |
repo | string | Yes | Repository name |
pullNumber | number | Yes | Pull request number |
reviewers | string | Yes | Comma-separated list of user logins to request reviews from |
team_reviewers | string | No | Comma-separated list of team slugs to request reviews from |
apiKey | string | Yes | GitHub API token |
| Parameter | Type | Description |
|---|
content | string | Human-readable reviewer request confirmation |
metadata | object | Requested reviewers metadata |
Get the content of a file from a GitHub repository. Supports files up to 1MB. Content is returned decoded and human-readable.
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner (user or organization) |
repo | string | Yes | Repository name |
path | string | Yes | Path to the file in the repository (e.g., "src/index.ts") |
ref | string | No | Branch name, tag, or commit SHA (defaults to repository default branch) |
apiKey | string | Yes | GitHub Personal Access Token |
| Parameter | Type | Description |
|---|
content | string | Human-readable file information with content preview |
metadata | object | File metadata including name, path, SHA, size, and URLs |
Create a new file in a GitHub repository. The file content will be automatically Base64 encoded. Supports files up to 1MB.
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner (user or organization) |
repo | string | Yes | Repository name |
path | string | Yes | Path where the file will be created (e.g., "src/newfile.ts") |
message | string | Yes | Commit message for this file creation |
content | string | Yes | File content (plain text, will be Base64 encoded automatically) |
branch | string | No | Branch to create the file in (defaults to repository default branch) |
apiKey | string | Yes | GitHub Personal Access Token |
| Parameter | Type | Description |
|---|
content | string | Human-readable file creation confirmation |
metadata | object | File and commit metadata |
Update an existing file in a GitHub repository. Requires the file SHA. Content will be automatically Base64 encoded. Supports files up to 1MB.
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner (user or organization) |
repo | string | Yes | Repository name |
path | string | Yes | Path to the file to update (e.g., "src/index.ts") |
message | string | Yes | Commit message for this file update |
content | string | Yes | New file content (plain text, will be Base64 encoded automatically) |
sha | string | Yes | The blob SHA of the file being replaced (get from github_get_file_content) |
branch | string | No | Branch to update the file in (defaults to repository default branch) |
apiKey | string | Yes | GitHub Personal Access Token |
| Parameter | Type | Description |
|---|
content | string | Human-readable file update confirmation |
metadata | object | Updated file and commit metadata |
Delete a file from a GitHub repository. Requires the file SHA. This operation cannot be undone through the API.
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner (user or organization) |
repo | string | Yes | Repository name |
path | string | Yes | Path to the file to delete (e.g., "src/oldfile.ts") |
message | string | Yes | Commit message for this file deletion |
sha | string | Yes | The blob SHA of the file being deleted (get from github_get_file_content) |
branch | string | No | Branch to delete the file from (defaults to repository default branch) |
apiKey | string | Yes | GitHub Personal Access Token |
| Parameter | Type | Description |
|---|
content | string | Human-readable file deletion confirmation |
metadata | object | Deletion confirmation and commit metadata |
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.
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner (user or organization) |
repo | string | Yes | Repository name |
path | string | No | Directory path (e.g., "src/components"). Leave empty for root directory. |
ref | string | No | Branch name, tag, or commit SHA (defaults to repository default branch) |
apiKey | string | Yes | GitHub Personal Access Token |
| Parameter | Type | Description |
|---|
content | string | Human-readable directory tree listing |
metadata | object | Directory contents metadata |
List all branches in a GitHub repository. Optionally filter by protected status and control pagination.
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner (user or organization) |
repo | string | Yes | Repository name |
protected | boolean | No | Filter branches by protection status |
per_page | number | No | Number of results per page (max 100, default 30) |
page | number | No | Page number for pagination (default 1) |
apiKey | string | Yes | GitHub Personal Access Token |
| Parameter | Type | Description |
|---|
content | string | Human-readable list of branches |
metadata | object | Branch list metadata |
Get detailed information about a specific branch in a GitHub repository, including commit details and protection status.
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner (user or organization) |
repo | string | Yes | Repository name |
branch | string | Yes | Branch name |
apiKey | string | Yes | GitHub Personal Access Token |
| Parameter | Type | Description |
|---|
content | string | Human-readable branch details |
metadata | object | Branch metadata |
Create a new branch in a GitHub repository by creating a git reference pointing to a specific commit SHA.
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner (user or organization) |
repo | string | Yes | Repository name |
branch | string | Yes | Name of the branch to create |
sha | string | Yes | Commit SHA to point the branch to |
apiKey | string | Yes | GitHub Personal Access Token |
| Parameter | Type | Description |
|---|
content | string | Human-readable branch creation confirmation |
metadata | object | Git reference metadata |
Delete a branch from a GitHub repository by removing its git reference. Protected branches cannot be deleted.
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner (user or organization) |
repo | string | Yes | Repository name |
branch | string | Yes | Name of the branch to delete |
apiKey | string | Yes | GitHub Personal Access Token |
| Parameter | Type | Description |
|---|
content | string | Human-readable deletion confirmation |
metadata | object | Deletion metadata |
Get the branch protection rules for a specific branch, including status checks, review requirements, and restrictions.
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner (user or organization) |
repo | string | Yes | Repository name |
branch | string | Yes | Branch name |
apiKey | string | Yes | GitHub Personal Access Token |
| Parameter | Type | Description |
|---|
content | string | Human-readable branch protection summary |
metadata | object | Branch protection configuration |
Update branch protection rules for a specific branch, including status checks, review requirements, admin enforcement, and push restrictions.
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner (user or organization) |
repo | string | Yes | Repository name |
branch | string | Yes | Branch name |
required_status_checks | object | Yes | Required status check configuration (null to disable). Object with strict (boolean) and contexts (string array) |
enforce_admins | boolean | Yes | Whether to enforce restrictions for administrators |
required_pull_request_reviews | object | Yes | PR review requirements (null to disable). Object with optional required_approving_review_count, dismiss_stale_reviews, require_code_owner_reviews |
restrictions | object | Yes | Push restrictions (null to disable). Object with users (string array) and teams (string array) |
apiKey | string | Yes | GitHub Personal Access Token |
| Parameter | Type | Description |
|---|
content | string | Human-readable branch protection update summary |
metadata | object | Updated branch protection configuration |
Create a new issue in a GitHub repository
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner |
repo | string | Yes | Repository name |
title | string | Yes | Issue title |
body | string | No | Issue description/body |
assignees | string | No | Comma-separated list of usernames to assign to this issue |
labels | string | No | Comma-separated list of label names to add to this issue |
milestone | number | No | Milestone number to associate with this issue |
apiKey | string | Yes | GitHub API token |
| Parameter | Type | Description |
|---|
content | string | Human-readable issue creation confirmation |
metadata | object | Issue metadata |
Update an existing issue in a GitHub repository
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner |
repo | string | Yes | Repository name |
issue_number | number | Yes | Issue number |
title | string | No | New issue title |
body | string | No | New issue description/body |
state | string | No | Issue state (open or closed) |
labels | array | No | Array of label names (replaces all existing labels) |
assignees | array | No | Array of usernames (replaces all existing assignees) |
apiKey | string | Yes | GitHub API token |
| Parameter | Type | Description |
|---|
content | string | Human-readable issue update confirmation |
metadata | object | Updated issue metadata |
List issues in a GitHub repository. Note: This includes pull requests as PRs are considered issues in GitHub
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner |
repo | string | Yes | Repository name |
state | string | No | Filter by state: open, closed, or all (default: open) |
assignee | string | No | Filter by assignee username |
creator | string | No | Filter by creator username |
labels | string | No | Comma-separated list of label names to filter by |
sort | string | No | Sort by: created, updated, or comments (default: created) |
direction | string | No | Sort direction: asc or desc (default: desc) |
per_page | number | No | Results per page (max 100, default: 30) |
page | number | No | Page number (default: 1) |
apiKey | string | Yes | GitHub API token |
| Parameter | Type | Description |
|---|
content | string | Human-readable list of issues |
metadata | object | Issues list metadata |
Get detailed information about a specific issue in a GitHub repository
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner |
repo | string | Yes | Repository name |
issue_number | number | Yes | Issue number |
apiKey | string | Yes | GitHub API token |
| Parameter | Type | Description |
|---|
content | string | Human-readable issue details |
metadata | object | Detailed issue metadata |
Close an issue in a GitHub repository
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner |
repo | string | Yes | Repository name |
issue_number | number | Yes | Issue number |
state_reason | string | No | Reason for closing: completed or not_planned |
apiKey | string | Yes | GitHub API token |
| Parameter | Type | Description |
|---|
content | string | Human-readable issue close confirmation |
metadata | object | Closed issue metadata |
Add labels to an issue in a GitHub repository
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner |
repo | string | Yes | Repository name |
issue_number | number | Yes | Issue number |
labels | string | Yes | Comma-separated list of label names to add to the issue |
apiKey | string | Yes | GitHub API token |
| Parameter | Type | Description |
|---|
content | string | Human-readable labels confirmation |
metadata | object | Labels metadata |
Remove a label from an issue in a GitHub repository
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner |
repo | string | Yes | Repository name |
issue_number | number | Yes | Issue number |
name | string | Yes | Label name to remove |
apiKey | string | Yes | GitHub API token |
| Parameter | Type | Description |
|---|
content | string | Human-readable label removal confirmation |
metadata | object | Remaining labels metadata |
Add assignees to an issue in a GitHub repository
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner |
repo | string | Yes | Repository name |
issue_number | number | Yes | Issue number |
assignees | string | Yes | Comma-separated list of usernames to assign to the issue |
apiKey | string | Yes | GitHub API token |
| Parameter | Type | Description |
|---|
content | string | Human-readable assignees confirmation |
metadata | object | Updated issue metadata with assignees |
Create a new release for a GitHub repository. Specify tag name, target commit, title, description, and whether it should be a draft or prerelease.
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner (user or organization) |
repo | string | Yes | Repository name |
tag_name | string | Yes | The name of the tag for this release |
target_commitish | string | No | Specifies 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. |
name | string | No | The name of the release |
body | string | No | Text describing the contents of the release (markdown supported) |
draft | boolean | No | true to create a draft (unpublished) release, false to create a published one |
prerelease | boolean | No | true to identify the release as a prerelease, false to identify as a full release |
apiKey | string | Yes | GitHub Personal Access Token |
| Parameter | Type | Description |
|---|
content | string | Human-readable release creation summary |
metadata | object | Release metadata including download URLs |
Update an existing GitHub release. Modify tag name, target commit, title, description, draft status, or prerelease status.
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner (user or organization) |
repo | string | Yes | Repository name |
release_id | number | Yes | The unique identifier of the release |
tag_name | string | No | The name of the tag |
target_commitish | string | No | Specifies the commitish value for where the tag is created from |
name | string | No | The name of the release |
body | string | No | Text describing the contents of the release (markdown supported) |
draft | boolean | No | true to set as draft, false to publish |
prerelease | boolean | No | true to identify as a prerelease, false for a full release |
apiKey | string | Yes | GitHub Personal Access Token |
| Parameter | Type | Description |
|---|
content | string | Human-readable release update summary |
metadata | object | Updated release metadata including download URLs |
List all releases for a GitHub repository. Returns release information including tags, names, and download URLs.
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner (user or organization) |
repo | string | Yes | Repository name |
per_page | number | No | Number of results per page (max 100) |
page | number | No | Page number of the results to fetch |
apiKey | string | Yes | GitHub Personal Access Token |
| Parameter | Type | Description |
|---|
content | string | Human-readable list of releases with summary |
metadata | object | Releases metadata |
Get detailed information about a specific GitHub release by ID. Returns release metadata including assets and download URLs.
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner (user or organization) |
repo | string | Yes | Repository name |
release_id | number | Yes | The unique identifier of the release |
apiKey | string | Yes | GitHub Personal Access Token |
| Parameter | Type | Description |
|---|
content | string | Human-readable release details |
metadata | object | Release metadata including download URLs |
Delete a GitHub release by ID. This permanently removes the release but does not delete the associated Git tag.
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner (user or organization) |
repo | string | Yes | Repository name |
release_id | number | Yes | The unique identifier of the release to delete |
apiKey | string | Yes | GitHub Personal Access Token |
| Parameter | Type | Description |
|---|
content | string | Human-readable deletion confirmation |
metadata | object | Deletion result metadata |
List all workflows in a GitHub repository. Returns workflow details including ID, name, path, state, and badge URL.
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner (user or organization) |
repo | string | Yes | Repository name |
per_page | number | No | Number of results per page (default: 30, max: 100) |
page | number | No | Page number of results to fetch (default: 1) |
apiKey | string | Yes | GitHub Personal Access Token |
| Parameter | Type | Description |
|---|
content | string | Human-readable workflows summary |
metadata | object | Workflows metadata |
Get details of a specific GitHub Actions workflow by ID or filename. Returns workflow information including name, path, state, and badge URL.
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner (user or organization) |
repo | string | Yes | Repository name |
workflow_id | string | Yes | Workflow ID (number) or workflow filename (e.g., "main.yaml") |
apiKey | string | Yes | GitHub Personal Access Token |
| Parameter | Type | Description |
|---|
content | string | Human-readable workflow details |
metadata | object | Workflow metadata |
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.
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner (user or organization) |
repo | string | Yes | Repository name |
workflow_id | string | Yes | Workflow ID (number) or workflow filename (e.g., "main.yaml") |
ref | string | Yes | Git reference (branch or tag name) to run the workflow on |
inputs | object | No | Input keys and values configured in the workflow file |
apiKey | string | Yes | GitHub Personal Access Token |
| Parameter | Type | Description |
|---|
content | string | Confirmation message |
metadata | object | Empty metadata object (204 No Content response) |
List workflow runs for a repository. Supports filtering by actor, branch, event, and status. Returns run details including status, conclusion, and links.
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner (user or organization) |
repo | string | Yes | Repository name |
actor | string | No | Filter by user who triggered the workflow |
branch | string | No | Filter by branch name |
event | string | No | Filter by event type (e.g., push, pull_request, workflow_dispatch) |
status | string | No | Filter by status (queued, in_progress, completed, waiting, requested, pending) |
per_page | number | No | Number of results per page (default: 30, max: 100) |
page | number | No | Page number of results to fetch (default: 1) |
apiKey | string | Yes | GitHub Personal Access Token |
| Parameter | Type | Description |
|---|
content | string | Human-readable workflow runs summary |
metadata | object | Workflow runs metadata |
Get detailed information about a specific workflow run by ID. Returns status, conclusion, timing, and links to the run.
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner (user or organization) |
repo | string | Yes | Repository name |
run_id | number | Yes | Workflow run ID |
apiKey | string | Yes | GitHub Personal Access Token |
| Parameter | Type | Description |
|---|
content | string | Human-readable workflow run details |
metadata | object | Workflow run metadata |
Cancel a workflow run. Returns 202 Accepted if cancellation is initiated, or 409 Conflict if the run cannot be cancelled (already completed).
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner (user or organization) |
repo | string | Yes | Repository name |
run_id | number | Yes | Workflow run ID to cancel |
apiKey | string | Yes | GitHub Personal Access Token |
| Parameter | Type | Description |
|---|
content | string | Cancellation status message |
metadata | object | Cancellation metadata |
Rerun a workflow run. Optionally enable debug logging for the rerun. Returns 201 Created on success.
| Parameter | Type | Required | Description |
|---|
owner | string | Yes | Repository owner (user or organization) |
repo | string | Yes | Repository name |
run_id | number | Yes | Workflow run ID to rerun |
enable_debug_logging | boolean | No | Enable debug logging for the rerun (default: false) |
apiKey | string | Yes | GitHub Personal Access Token |
| Parameter | Type | Description |
|---|
content | string | Rerun confirmation message |
metadata | object | Rerun metadata |
List GitHub Projects V2 for an organization or user. Returns up to 20 projects with their details including ID, title, number, URL, and status.
| Parameter | Type | Required | Description |
|---|
owner_type | string | Yes | Owner type: "org" for organization or "user" for user |
owner_login | string | Yes | Organization or user login name |
apiKey | string | Yes | GitHub Personal Access Token with project read permissions |
| Parameter | Type | Description |
|---|
content | string | Human-readable list of projects |
metadata | object | Projects metadata |
Get detailed information about a specific GitHub Project V2 by its number. Returns project details including ID, title, description, URL, and status.
| Parameter | Type | Required | Description |
|---|
owner_type | string | Yes | Owner type: "org" for organization or "user" for user |
owner_login | string | Yes | Organization or user login name |
project_number | number | Yes | Project number |
apiKey | string | Yes | GitHub Personal Access Token with project read permissions |
| Parameter | Type | Description |
|---|
content | string | Human-readable project details |
metadata | object | Project metadata |
Create a new GitHub Project V2. Requires the owner Node ID (not login name). Returns the created project with ID, title, and URL.
| Parameter | Type | Required | Description |
|---|
owner_id | string | Yes | Owner Node ID (format: PVT_... or MDQ6...). Use GitHub GraphQL API to get this ID from organization or user login. |
title | string | Yes | Project title |
apiKey | string | Yes | GitHub Personal Access Token with project write permissions |
| Parameter | Type | Description |
|---|
content | string | Human-readable confirmation message |
metadata | object | Created project metadata |
Update an existing GitHub Project V2. Can update title, description, visibility (public), or status (closed). Requires the project Node ID.
| Parameter | Type | Required | Description |
|---|
project_id | string | Yes | Project Node ID (format: PVT_...) |
title | string | No | New project title |
shortDescription | string | No | New project short description |
project_public | boolean | No | Set project visibility (true = public, false = private) |
closed | boolean | No | Set project status (true = closed, false = open) |
apiKey | string | Yes | GitHub Personal Access Token with project write permissions |
| Parameter | Type | Description |
|---|
content | string | Human-readable confirmation message |
metadata | object | Updated project metadata |
Delete a GitHub Project V2. This action is permanent and cannot be undone. Requires the project Node ID.
| Parameter | Type | Required | Description |
|---|
project_id | string | Yes | Project Node ID (format: PVT_...) |
apiKey | string | Yes | GitHub Personal Access Token with project admin permissions |
| Parameter | Type | Description |
|---|
content | string | Human-readable confirmation message |
metadata | object | Deleted project metadata |
Trigger workflow when a new issue is opened in a GitHub repository
| Parameter | Type | Description |
|---|
action | string | Action performed (opened, closed, reopened, edited, etc.) |
issue.id | number | Issue ID |
issue.node_id | string | Issue node ID |
issue.number | number | Issue number |
issue.title | string | Issue title |
issue.body | string | Issue body/description |
issue.state | string | Issue state (open, closed) |
issue.state_reason | string | Reason for state (completed, not_planned, reopened) |
issue.html_url | string | Issue HTML URL |
issue.user.login | string | Username |
issue.user.id | number | User ID |
issue.user.node_id | string | User node ID |
issue.user.avatar_url | string | Avatar URL |
issue.user.html_url | string | Profile URL |
issue.user.user_type | string | User type (User, Bot, Organization) |
issue.labels | array | Array of label objects |
issue.assignees | array | Array of assigned users |
issue.milestone | object | Milestone object if assigned |
issue.created_at | string | Issue creation timestamp |
issue.updated_at | string | Issue last update timestamp |
issue.closed_at | string | Issue closed timestamp |
repository.id | number | Repository ID |
repository.node_id | string | Repository node ID |
repository.name | string | Repository name |
repository.full_name | string | Repository full name (owner/repo) |
repository.private | boolean | Whether the repository is private |
repository.html_url | string | Repository HTML URL |
repository.repo_description | string | Repository description |
repository.fork | boolean | Whether the repository is a fork |
repository.url | string | Repository API URL |
repository.homepage | string | Repository homepage URL |
repository.size | number | Repository size in KB |
repository.stargazers_count | number | Number of stars |
repository.watchers_count | number | Number of watchers |
repository.language | string | Primary programming language |
repository.forks_count | number | Number of forks |
repository.open_issues_count | number | Number of open issues |
repository.default_branch | string | Default branch name |
repository.owner.login | string | Owner username |
repository.owner.id | number | Owner ID |
repository.owner.avatar_url | string | Owner avatar URL |
repository.owner.html_url | string | Owner profile URL |
repository.owner.owner_type | string | Owner type (User, Organization) |
sender.login | string | Username |
sender.id | number | User ID |
sender.node_id | string | User node ID |
sender.avatar_url | string | Avatar URL |
sender.html_url | string | Profile URL |
sender.user_type | string | User type (User, Bot, Organization) |
Trigger workflow when an issue is closed in a GitHub repository
| Parameter | Type | Description |
|---|
action | string | Action performed (opened, closed, reopened, edited, etc.) |
issue.id | number | Issue ID |
issue.node_id | string | Issue node ID |
issue.number | number | Issue number |
issue.title | string | Issue title |
issue.body | string | Issue body/description |
issue.state | string | Issue state (open, closed) |
issue.state_reason | string | Reason for state (completed, not_planned, reopened) |
issue.html_url | string | Issue HTML URL |
issue.user.login | string | Username |
issue.user.id | number | User ID |
issue.user.node_id | string | User node ID |
issue.user.avatar_url | string | Avatar URL |
issue.user.html_url | string | Profile URL |
issue.user.user_type | string | User type (User, Bot, Organization) |
issue.labels | array | Array of label objects |
issue.assignees | array | Array of assigned users |
issue.milestone | object | Milestone object if assigned |
issue.created_at | string | Issue creation timestamp |
issue.updated_at | string | Issue last update timestamp |
issue.closed_at | string | Issue closed timestamp |
repository.id | number | Repository ID |
repository.node_id | string | Repository node ID |
repository.name | string | Repository name |
repository.full_name | string | Repository full name (owner/repo) |
repository.private | boolean | Whether the repository is private |
repository.html_url | string | Repository HTML URL |
repository.repo_description | string | Repository description |
repository.fork | boolean | Whether the repository is a fork |
repository.url | string | Repository API URL |
repository.homepage | string | Repository homepage URL |
repository.size | number | Repository size in KB |
repository.stargazers_count | number | Number of stars |
repository.watchers_count | number | Number of watchers |
repository.language | string | Primary programming language |
repository.forks_count | number | Number of forks |
repository.open_issues_count | number | Number of open issues |
repository.default_branch | string | Default branch name |
repository.owner.login | string | Owner username |
repository.owner.id | number | Owner ID |
repository.owner.avatar_url | string | Owner avatar URL |
repository.owner.html_url | string | Owner profile URL |
repository.owner.owner_type | string | Owner type (User, Organization) |
sender.login | string | Username |
sender.id | number | User ID |
sender.node_id | string | User node ID |
sender.avatar_url | string | Avatar URL |
sender.html_url | string | Profile URL |
sender.user_type | string | User type (User, Bot, Organization) |
Trigger workflow when a comment is added to an issue (not pull requests)
| Parameter | Type | Description |
|---|
action | string | Action performed (created, edited, deleted) |
issue.number | number | Issue number |
issue.title | string | Issue title |
issue.state | string | Issue state (open, closed) |
issue.html_url | string | Issue HTML URL |
issue.user.login | string | Username |
issue.user.id | number | User ID |
issue.user.node_id | string | User node ID |
issue.user.avatar_url | string | Avatar URL |
issue.user.html_url | string | Profile URL |
issue.user.user_type | string | User type (User, Bot, Organization) |
comment.id | number | Comment ID |
comment.node_id | string | Comment node ID |
comment.body | string | Comment text |
comment.html_url | string | Comment HTML URL |
comment.user.login | string | Username |
comment.user.id | number | User ID |
comment.user.node_id | string | User node ID |
comment.user.avatar_url | string | Avatar URL |
comment.user.html_url | string | Profile URL |
comment.user.user_type | string | User type (User, Bot, Organization) |
comment.created_at | string | Comment creation timestamp |
comment.updated_at | string | Comment last update timestamp |
repository.id | number | Repository ID |
repository.node_id | string | Repository node ID |
repository.name | string | Repository name |
repository.full_name | string | Repository full name (owner/repo) |
repository.private | boolean | Whether the repository is private |
repository.html_url | string | Repository HTML URL |
repository.repo_description | string | Repository description |
repository.fork | boolean | Whether the repository is a fork |
repository.url | string | Repository API URL |
repository.homepage | string | Repository homepage URL |
repository.size | number | Repository size in KB |
repository.stargazers_count | number | Number of stars |
repository.watchers_count | number | Number of watchers |
repository.language | string | Primary programming language |
repository.forks_count | number | Number of forks |
repository.open_issues_count | number | Number of open issues |
repository.default_branch | string | Default branch name |
repository.owner.login | string | Owner username |
repository.owner.id | number | Owner ID |
repository.owner.avatar_url | string | Owner avatar URL |
repository.owner.html_url | string | Owner profile URL |
repository.owner.owner_type | string | Owner type (User, Organization) |
sender.login | string | Username |
sender.id | number | User ID |
sender.node_id | string | User node ID |
sender.avatar_url | string | Avatar URL |
sender.html_url | string | Profile URL |
sender.user_type | string | User type (User, Bot, Organization) |
Trigger workflow when a new pull request is opened in a GitHub repository
| Parameter | Type | Description |
|---|
action | string | Action performed (opened, closed, synchronize, reopened, edited, etc.) |
number | number | Pull request number |
pull_request.id | number | Pull request ID |
pull_request.node_id | string | Pull request node ID |
pull_request.number | number | Pull request number |
pull_request.title | string | Pull request title |
pull_request.body | string | Pull request description |
pull_request.state | string | Pull request state (open, closed) |
pull_request.merged | boolean | Whether the PR was merged |
pull_request.merged_at | string | Timestamp when PR was merged |
pull_request.merged_by.login | string | Username |
pull_request.merged_by.id | number | User ID |
pull_request.merged_by.node_id | string | User node ID |
pull_request.merged_by.avatar_url | string | Avatar URL |
pull_request.merged_by.html_url | string | Profile URL |
pull_request.merged_by.user_type | string | User type (User, Bot, Organization) |
pull_request.draft | boolean | Whether the PR is a draft |
pull_request.html_url | string | Pull request HTML URL |
pull_request.diff_url | string | Pull request diff URL |
pull_request.patch_url | string | Pull request patch URL |
pull_request.user.login | string | Username |
pull_request.user.id | number | User ID |
pull_request.user.node_id | string | User node ID |
pull_request.user.avatar_url | string | Avatar URL |
pull_request.user.html_url | string | Profile URL |
pull_request.user.user_type | string | User type (User, Bot, Organization) |
pull_request.head.ref | string | Source branch name |
pull_request.head.sha | string | Source branch commit SHA |
pull_request.head.repo.name | string | Source repository name |
pull_request.head.repo.full_name | string | Source repository full name |
pull_request.base.ref | string | Target branch name |
pull_request.base.sha | string | Target branch commit SHA |
pull_request.base.repo.name | string | Target repository name |
pull_request.base.repo.full_name | string | Target repository full name |
pull_request.additions | number | Number of lines added |
pull_request.deletions | number | Number of lines deleted |
pull_request.changed_files | number | Number of files changed |
pull_request.labels | array | Array of label objects |
pull_request.assignees | array | Array of assigned users |
pull_request.requested_reviewers | array | Array of requested reviewers |
pull_request.created_at | string | Pull request creation timestamp |
pull_request.updated_at | string | Pull request last update timestamp |
pull_request.closed_at | string | Pull request closed timestamp |
repository.id | number | Repository ID |
repository.node_id | string | Repository node ID |
repository.name | string | Repository name |
repository.full_name | string | Repository full name (owner/repo) |
repository.private | boolean | Whether the repository is private |
repository.html_url | string | Repository HTML URL |
repository.repo_description | string | Repository description |
repository.fork | boolean | Whether the repository is a fork |
repository.url | string | Repository API URL |
repository.homepage | string | Repository homepage URL |
repository.size | number | Repository size in KB |
repository.stargazers_count | number | Number of stars |
repository.watchers_count | number | Number of watchers |
repository.language | string | Primary programming language |
repository.forks_count | number | Number of forks |
repository.open_issues_count | number | Number of open issues |
repository.default_branch | string | Default branch name |
repository.owner.login | string | Owner username |
repository.owner.id | number | Owner ID |
repository.owner.avatar_url | string | Owner avatar URL |
repository.owner.html_url | string | Owner profile URL |
repository.owner.owner_type | string | Owner type (User, Organization) |
sender.login | string | Username |
sender.id | number | User ID |
sender.node_id | string | User node ID |
sender.avatar_url | string | Avatar URL |
sender.html_url | string | Profile URL |
sender.user_type | string | User type (User, Bot, Organization) |
Trigger workflow when a pull request is closed without being merged (e.g., abandoned) in a GitHub repository
| Parameter | Type | Description |
|---|
action | string | Action performed (opened, closed, synchronize, reopened, edited, etc.) |
number | number | Pull request number |
pull_request.id | number | Pull request ID |
pull_request.node_id | string | Pull request node ID |
pull_request.number | number | Pull request number |
pull_request.title | string | Pull request title |
pull_request.body | string | Pull request description |
pull_request.state | string | Pull request state (open, closed) |
pull_request.merged | boolean | Whether the PR was merged |
pull_request.merged_at | string | Timestamp when PR was merged |
pull_request.merged_by.login | string | Username |
pull_request.merged_by.id | number | User ID |
pull_request.merged_by.node_id | string | User node ID |
pull_request.merged_by.avatar_url | string | Avatar URL |
pull_request.merged_by.html_url | string | Profile URL |
pull_request.merged_by.user_type | string | User type (User, Bot, Organization) |
pull_request.draft | boolean | Whether the PR is a draft |
pull_request.html_url | string | Pull request HTML URL |
pull_request.diff_url | string | Pull request diff URL |
pull_request.patch_url | string | Pull request patch URL |
pull_request.user.login | string | Username |
pull_request.user.id | number | User ID |
pull_request.user.node_id | string | User node ID |
pull_request.user.avatar_url | string | Avatar URL |
pull_request.user.html_url | string | Profile URL |
pull_request.user.user_type | string | User type (User, Bot, Organization) |
pull_request.head.ref | string | Source branch name |
pull_request.head.sha | string | Source branch commit SHA |
pull_request.head.repo.name | string | Source repository name |
pull_request.head.repo.full_name | string | Source repository full name |
pull_request.base.ref | string | Target branch name |
pull_request.base.sha | string | Target branch commit SHA |
pull_request.base.repo.name | string | Target repository name |
pull_request.base.repo.full_name | string | Target repository full name |
pull_request.additions | number | Number of lines added |
pull_request.deletions | number | Number of lines deleted |
pull_request.changed_files | number | Number of files changed |
pull_request.labels | array | Array of label objects |
pull_request.assignees | array | Array of assigned users |
pull_request.requested_reviewers | array | Array of requested reviewers |
pull_request.created_at | string | Pull request creation timestamp |
pull_request.updated_at | string | Pull request last update timestamp |
pull_request.closed_at | string | Pull request closed timestamp |
repository.id | number | Repository ID |
repository.node_id | string | Repository node ID |
repository.name | string | Repository name |
repository.full_name | string | Repository full name (owner/repo) |
repository.private | boolean | Whether the repository is private |
repository.html_url | string | Repository HTML URL |
repository.repo_description | string | Repository description |
repository.fork | boolean | Whether the repository is a fork |
repository.url | string | Repository API URL |
repository.homepage | string | Repository homepage URL |
repository.size | number | Repository size in KB |
repository.stargazers_count | number | Number of stars |
repository.watchers_count | number | Number of watchers |
repository.language | string | Primary programming language |
repository.forks_count | number | Number of forks |
repository.open_issues_count | number | Number of open issues |
repository.default_branch | string | Default branch name |
repository.owner.login | string | Owner username |
repository.owner.id | number | Owner ID |
repository.owner.avatar_url | string | Owner avatar URL |
repository.owner.html_url | string | Owner profile URL |
sender.login | string | Username |
sender.id | number | User ID |
sender.node_id | string | User node ID |
sender.avatar_url | string | Avatar URL |
sender.html_url | string | Profile URL |
sender.user_type | string | User type (User, Bot, Organization) |
Trigger workflow when a pull request is successfully merged in a GitHub repository
| Parameter | Type | Description |
|---|
action | string | Action performed (opened, closed, synchronize, reopened, edited, etc.) |
number | number | Pull request number |
pull_request.id | number | Pull request ID |
pull_request.node_id | string | Pull request node ID |
pull_request.number | number | Pull request number |
pull_request.title | string | Pull request title |
pull_request.body | string | Pull request description |
pull_request.state | string | Pull request state (open, closed) |
pull_request.merged | boolean | Whether the PR was merged |
pull_request.merged_at | string | Timestamp when PR was merged |
pull_request.merged_by.login | string | Username |
pull_request.merged_by.id | number | User ID |
pull_request.merged_by.node_id | string | User node ID |
pull_request.merged_by.avatar_url | string | Avatar URL |
pull_request.merged_by.html_url | string | Profile URL |
pull_request.merged_by.user_type | string | User type (User, Bot, Organization) |
pull_request.draft | boolean | Whether the PR is a draft |
pull_request.html_url | string | Pull request HTML URL |
pull_request.diff_url | string | Pull request diff URL |
pull_request.patch_url | string | Pull request patch URL |
pull_request.user.login | string | Username |
pull_request.user.id | number | User ID |
pull_request.user.node_id | string | User node ID |
pull_request.user.avatar_url | string | Avatar URL |
pull_request.user.html_url | string | Profile URL |
pull_request.user.user_type | string | User type (User, Bot, Organization) |
pull_request.head.ref | string | Source branch name |
pull_request.head.sha | string | Source branch commit SHA |
pull_request.head.repo.name | string | Source repository name |
pull_request.head.repo.full_name | string | Source repository full name |
pull_request.base.ref | string | Target branch name |
pull_request.base.sha | string | Target branch commit SHA |
pull_request.base.repo.name | string | Target repository name |
pull_request.base.repo.full_name | string | Target repository full name |
pull_request.additions | number | Number of lines added |
pull_request.deletions | number | Number of lines deleted |
pull_request.changed_files | number | Number of files changed |
pull_request.labels | array | Array of label objects |
pull_request.assignees | array | Array of assigned users |
pull_request.requested_reviewers | array | Array of requested reviewers |
pull_request.created_at | string | Pull request creation timestamp |
pull_request.updated_at | string | Pull request last update timestamp |
pull_request.closed_at | string | Pull request closed timestamp |
repository.id | number | Repository ID |
repository.node_id | string | Repository node ID |
repository.name | string | Repository name |
repository.full_name | string | Repository full name (owner/repo) |
repository.private | boolean | Whether the repository is private |
repository.html_url | string | Repository HTML URL |
repository.repo_description | string | Repository description |
repository.fork | boolean | Whether the repository is a fork |
repository.url | string | Repository API URL |
repository.homepage | string | Repository homepage URL |
repository.size | number | Repository size in KB |
repository.stargazers_count | number | Number of stars |
repository.watchers_count | number | Number of watchers |
repository.language | string | Primary programming language |
repository.forks_count | number | Number of forks |
repository.open_issues_count | number | Number of open issues |
repository.default_branch | string | Default branch name |
repository.owner.login | string | Owner username |
repository.owner.id | number | Owner ID |
repository.owner.avatar_url | string | Owner avatar URL |
repository.owner.html_url | string | Owner profile URL |
sender.login | string | Username |
sender.id | number | User ID |
sender.node_id | string | User node ID |
sender.avatar_url | string | Avatar URL |
sender.html_url | string | Profile URL |
sender.user_type | string | User type (User, Bot, Organization) |
Trigger workflow when a comment is added to a pull request in a GitHub repository
| Parameter | Type | Description |
|---|
action | string | Action performed (created, edited, deleted) |
issue.id | number | Issue ID |
issue.node_id | string | Issue node ID |
issue.number | number | Issue/PR number |
issue.title | string | Issue/PR title |
issue.body | string | Issue/PR description |
issue.state | string | Issue/PR state (open, closed) |
issue.html_url | string | Issue/PR HTML URL |
issue.user.login | string | Username |
issue.user.id | number | User ID |
issue.user.node_id | string | User node ID |
issue.user.avatar_url | string | Avatar URL |
issue.user.html_url | string | Profile URL |
issue.user.user_type | string | User type (User, Bot, Organization) |
issue.labels | array | Array of label objects |
issue.assignees | array | Array of assigned users |
issue.pull_request.url | string | Pull request API URL (present only for PR comments) |
issue.pull_request.html_url | string | Pull request HTML URL |
issue.pull_request.diff_url | string | Pull request diff URL |
issue.pull_request.patch_url | string | Pull request patch URL |
issue.created_at | string | Issue/PR creation timestamp |
issue.updated_at | string | Issue/PR last update timestamp |
comment.id | number | Comment ID |
comment.node_id | string | Comment node ID |
comment.url | string | Comment API URL |
comment.html_url | string | Comment HTML URL |
comment.body | string | Comment text |
comment.user.login | string | Username |
comment.user.id | number | User ID |
comment.user.node_id | string | User node ID |
comment.user.avatar_url | string | Avatar URL |
comment.user.html_url | string | Profile URL |
comment.user.user_type | string | User type (User, Bot, Organization) |
comment.created_at | string | Comment creation timestamp |
comment.updated_at | string | Comment last update timestamp |
repository.id | number | Repository ID |
repository.node_id | string | Repository node ID |
repository.name | string | Repository name |
repository.full_name | string | Repository full name (owner/repo) |
repository.private | boolean | Whether the repository is private |
repository.html_url | string | Repository HTML URL |
repository.repo_description | string | Repository description |
repository.owner.login | string | Owner username |
repository.owner.id | number | Owner ID |
repository.owner.node_id | string | Owner node ID |
repository.owner.avatar_url | string | Owner avatar URL |
repository.owner.html_url | string | Owner profile URL |
repository.owner.owner_type | string | Owner type (User, Organization) |
sender.login | string | Username |
sender.id | number | User ID |
sender.node_id | string | User node ID |
sender.avatar_url | string | Avatar URL |
sender.html_url | string | Profile URL |
sender.user_type | string | User type (User, Bot, Organization) |
Trigger workflow when a pull request review is submitted, edited, or dismissed in a GitHub repository
| Parameter | Type | Description |
|---|
action | string | Action performed (submitted, edited, dismissed) |
review.id | number | Review ID |
review.node_id | string | Review node ID |
review.user.login | string | Reviewer username |
review.user.id | number | Reviewer user ID |
review.user.node_id | string | Reviewer node ID |
review.user.avatar_url | string | Reviewer avatar URL |
review.user.html_url | string | Reviewer profile URL |
review.user.user_type | string | User type (User, Bot, Organization) |
review.body | string | Review comment text |
review.state | string | Review state (approved, changes_requested, commented, dismissed) |
review.html_url | string | Review HTML URL |
review.submitted_at | string | Review submission timestamp |
review.commit_id | string | Commit SHA that was reviewed |
review.author_association | string | Author association (OWNER, MEMBER, COLLABORATOR, CONTRIBUTOR, etc.) |
pull_request.id | number | Pull request ID |
pull_request.node_id | string | Pull request node ID |
pull_request.number | number | Pull request number |
pull_request.title | string | Pull request title |
pull_request.body | string | Pull request description |
pull_request.state | string | Pull request state (open, closed) |
pull_request.merged | boolean | Whether the PR was merged |
pull_request.draft | boolean | Whether the PR is a draft |
pull_request.html_url | string | Pull request HTML URL |
pull_request.diff_url | string | Pull request diff URL |
pull_request.patch_url | string | Pull request patch URL |
pull_request.user.login | string | PR author username |
pull_request.user.id | number | PR author user ID |
pull_request.user.node_id | string | PR author node ID |
pull_request.user.avatar_url | string | PR author avatar URL |
pull_request.user.html_url | string | PR author profile URL |
pull_request.user.user_type | string | User type (User, Bot, Organization) |
pull_request.head.ref | string | Source branch name |
pull_request.head.sha | string | Source branch commit SHA |
pull_request.head.repo.name | string | Source repository name |
pull_request.head.repo.full_name | string | Source repository full name |
pull_request.base.ref | string | Target branch name |
pull_request.base.sha | string | Target branch commit SHA |
pull_request.base.repo.name | string | Target repository name |
pull_request.base.repo.full_name | string | Target repository full name |
pull_request.created_at | string | Pull request creation timestamp |
pull_request.updated_at | string | Pull request last update timestamp |
repository.id | number | Repository ID |
repository.node_id | string | Repository node ID |
repository.name | string | Repository name |
repository.full_name | string | Repository full name (owner/repo) |
repository.private | boolean | Whether the repository is private |
repository.html_url | string | Repository HTML URL |
repository.repo_description | string | Repository description |
repository.owner.login | string | Owner username |
repository.owner.id | number | Owner ID |
repository.owner.node_id | string | Owner node ID |
repository.owner.avatar_url | string | Owner avatar URL |
repository.owner.html_url | string | Owner profile URL |
repository.owner.owner_type | string | Owner type (User, Organization) |
sender.login | string | Username |
sender.id | number | User ID |
sender.node_id | string | User node ID |
sender.avatar_url | string | Avatar URL |
sender.html_url | string | Profile URL |
sender.user_type | string | User type (User, Bot, Organization) |
Trigger workflow when code is pushed to a repository
| Parameter | Type | Description |
|---|
ref | string | Git reference that was pushed (e.g., refs/heads/main) |
before | string | SHA of the commit before the push |
after | string | SHA of the commit after the push |
created | boolean | Whether this push created a new branch or tag |
deleted | boolean | Whether this push deleted a branch or tag |
forced | boolean | Whether this was a force push |
base_ref | string | Base reference for the push |
compare | string | URL to compare the changes |
commits | array | Array of commit objects included in this push |
head_commit.id | string | Commit SHA of the most recent commit |
head_commit.tree_id | string | Git tree SHA |
head_commit.distinct | boolean | Whether this commit is distinct |
head_commit.message | string | Commit message |
head_commit.timestamp | string | Commit timestamp |
head_commit.url | string | Commit URL |
head_commit.author.name | string | Author name |
head_commit.author.email | string | Author email |
head_commit.author.username | string | Author GitHub username |
head_commit.committer.name | string | Committer name |
head_commit.committer.email | string | Committer email |
head_commit.committer.username | string | Committer GitHub username |
head_commit.added | array | Array of file paths added in this commit |
head_commit.removed | array | Array of file paths removed in this commit |
head_commit.modified | array | Array of file paths modified in this commit |
pusher.name | string | Pusher name |
pusher.email | string | Pusher email |
repository.id | number | Repository ID |
repository.node_id | string | Repository node ID |
repository.name | string | Repository name |
repository.full_name | string | Repository full name (owner/repo) |
repository.private | boolean | Whether the repository is private |
repository.html_url | string | Repository HTML URL |
repository.repo_description | string | Repository description |
repository.fork | boolean | Whether the repository is a fork |
repository.url | string | Repository API URL |
repository.homepage | string | Repository homepage URL |
repository.size | number | Repository size in KB |
repository.stargazers_count | number | Number of stars |
repository.watchers_count | number | Number of watchers |
repository.language | string | Primary programming language |
repository.forks_count | number | Number of forks |
repository.open_issues_count | number | Number of open issues |
repository.default_branch | string | Default branch name |
repository.owner.login | string | Owner username |
repository.owner.id | number | Owner ID |
repository.owner.node_id | string | Owner node ID |
repository.owner.avatar_url | string | Owner avatar URL |
repository.owner.html_url | string | Owner profile URL |
repository.owner.owner_type | string | Owner type (User, Organization) |
sender.login | string | Username |
sender.id | number | User ID |
sender.node_id | string | User node ID |
sender.avatar_url | string | Avatar URL |
sender.html_url | string | Profile URL |
sender.user_type | string | User type (User, Bot, Organization) |
Trigger workflow when a new release is published in a GitHub repository
| Parameter | Type | Description |
|---|
action | string | Action performed (published, unpublished, created, edited, deleted, prereleased, released) |
release.id | number | Release ID |
release.node_id | string | Release node ID |
release.tag_name | string | Git tag name for the release |
release.target_commitish | string | Target branch or commit SHA |
release.name | string | Release name/title |
release.body | string | Release description/notes in markdown format |
release.draft | boolean | Whether the release is a draft |
release.prerelease | boolean | Whether the release is a pre-release |
release.created_at | string | Release creation timestamp |
release.published_at | string | Release publication timestamp |
release.url | string | Release API URL |
release.html_url | string | Release HTML URL |
release.assets_url | string | Release assets API URL |
release.upload_url | string | URL for uploading release assets |
release.tarball_url | string | Source code tarball download URL |
release.zipball_url | string | Source code zipball download URL |
release.discussion_url | string | Discussion URL if available |
release.author.login | string | Username |
release.author.id | number | User ID |
release.author.node_id | string | User node ID |
release.author.avatar_url | string | Avatar URL |
release.author.gravatar_id | string | Gravatar ID |
release.author.url | string | User API URL |
release.author.html_url | string | Profile URL |
release.author.followers_url | string | Followers API URL |
release.author.following_url | string | Following API URL |
release.author.gists_url | string | Gists API URL |
release.author.starred_url | string | Starred repositories API URL |
release.author.subscriptions_url | string | Subscriptions API URL |
release.author.organizations_url | string | Organizations API URL |
release.author.repos_url | string | Repositories API URL |
release.author.events_url | string | Events API URL |
release.author.received_events_url | string | Received events API URL |
release.author.user_type | string | User type (User, Bot, Organization) |
release.author.site_admin | boolean | Whether user is a site administrator |
release.assets | array | Array of release asset objects with download URLs |
repository.id | number | Repository ID |
repository.node_id | string | Repository node ID |
repository.name | string | Repository name |
repository.full_name | string | Repository full name (owner/repo) |
repository.private | boolean | Whether the repository is private |
repository.html_url | string | Repository HTML URL |
repository.repo_description | string | Repository description |
repository.fork | boolean | Whether the repository is a fork |
repository.url | string | Repository API URL |
repository.archive_url | string | Archive API URL |
repository.assignees_url | string | Assignees API URL |
repository.blobs_url | string | Blobs API URL |
repository.branches_url | string | Branches API URL |
repository.collaborators_url | string | Collaborators API URL |
repository.comments_url | string | Comments API URL |
repository.commits_url | string | Commits API URL |
repository.compare_url | string | Compare API URL |
repository.contents_url | string | Contents API URL |
repository.contributors_url | string | Contributors API URL |
repository.deployments_url | string | Deployments API URL |
repository.downloads_url | string | Downloads API URL |
repository.events_url | string | Events API URL |
repository.forks_url | string | Forks API URL |
repository.git_commits_url | string | Git commits API URL |
repository.git_refs_url | string | Git refs API URL |
repository.git_tags_url | string | Git tags API URL |
repository.hooks_url | string | Hooks API URL |
repository.issue_comment_url | string | Issue comment API URL |
repository.issue_events_url | string | Issue events API URL |
repository.issues_url | string | Issues API URL |
repository.keys_url | string | Keys API URL |
repository.labels_url | string | Labels API URL |
repository.languages_url | string | Languages API URL |
repository.merges_url | string | Merges API URL |
repository.milestones_url | string | Milestones API URL |
repository.notifications_url | string | Notifications API URL |
repository.pulls_url | string | Pull requests API URL |
repository.releases_url | string | Releases API URL |
repository.stargazers_url | string | Stargazers API URL |
repository.statuses_url | string | Statuses API URL |
repository.subscribers_url | string | Subscribers API URL |
repository.subscription_url | string | Subscription API URL |
repository.tags_url | string | Tags API URL |
repository.teams_url | string | Teams API URL |
repository.trees_url | string | Trees API URL |
repository.homepage | string | Repository homepage URL |
repository.size | number | Repository size in KB |
repository.stargazers_count | number | Number of stars |
repository.watchers_count | number | Number of watchers |
repository.language | string | Primary programming language |
repository.has_issues | boolean | Whether issues are enabled |
repository.has_projects | boolean | Whether projects are enabled |
repository.has_downloads | boolean | Whether downloads are enabled |
repository.has_wiki | boolean | Whether wiki is enabled |
repository.has_pages | boolean | Whether GitHub Pages is enabled |
repository.forks_count | number | Number of forks |
repository.mirror_url | string | Mirror URL if repository is a mirror |
repository.archived | boolean | Whether the repository is archived |
repository.disabled | boolean | Whether the repository is disabled |
repository.open_issues_count | number | Number of open issues |
repository.license.key | string | License key |
repository.license.name | string | License name |
repository.license.spdx_id | string | SPDX license identifier |
repository.license.url | string | License API URL |
repository.license.node_id | string | License node ID |
repository.allow_forking | boolean | Whether forking is allowed |
repository.is_template | boolean | Whether repository is a template |
repository.topics | array | Array of repository topics |
repository.visibility | string | Repository visibility (public, private, internal) |
repository.forks | number | Number of forks |
repository.open_issues | number | Number of open issues |
repository.watchers | number | Number of watchers |
repository.default_branch | string | Default branch name |
repository.created_at | string | Repository creation timestamp |
repository.updated_at | string | Repository last update timestamp |
repository.pushed_at | string | Repository last push timestamp |
repository.owner.login | string | Owner username |
repository.owner.id | number | Owner ID |
repository.owner.node_id | string | Owner node ID |
repository.owner.avatar_url | string | Owner avatar URL |
repository.owner.gravatar_id | string | Owner gravatar ID |
repository.owner.url | string | Owner API URL |
repository.owner.html_url | string | Owner profile URL |
repository.owner.followers_url | string | Followers API URL |
repository.owner.following_url | string | Following API URL |
repository.owner.gists_url | string | Gists API URL |
repository.owner.starred_url | string | Starred repositories API URL |
repository.owner.subscriptions_url | string | Subscriptions API URL |
repository.owner.organizations_url | string | Organizations API URL |
repository.owner.repos_url | string | Repositories API URL |
repository.owner.events_url | string | Events API URL |
repository.owner.received_events_url | string | Received events API URL |
repository.owner.owner_type | string | Owner type (User, Organization) |
repository.owner.site_admin | boolean | Whether owner is a site administrator |
sender.login | string | Username |
sender.id | number | User ID |
sender.node_id | string | User node ID |
sender.avatar_url | string | Avatar URL |
sender.gravatar_id | string | Gravatar ID |
sender.url | string | User API URL |
sender.html_url | string | Profile URL |
sender.followers_url | string | Followers API URL |
sender.following_url | string | Following API URL |
sender.gists_url | string | Gists API URL |
sender.starred_url | string | Starred repositories API URL |
sender.subscriptions_url | string | Subscriptions API URL |
sender.organizations_url | string | Organizations API URL |
sender.repos_url | string | Repositories API URL |
sender.events_url | string | Events API URL |
sender.received_events_url | string | Received events API URL |
sender.user_type | string | User type (User, Bot, Organization) |
sender.site_admin | boolean | Whether user is a site administrator |
Trigger workflow when a GitHub Actions workflow run is requested, in progress, or completed
| Parameter | Type | Description |
|---|
action | string | Action performed (requested, in_progress, completed) |
workflow_run.id | number | Workflow run ID |
workflow_run.node_id | string | Workflow run node ID |
workflow_run.name | string | Workflow name |
workflow_run.workflow_id | number | Workflow ID |
workflow_run.run_number | number | Run number for this workflow |
workflow_run.run_attempt | number | Attempt number for this run |
workflow_run.event | string | Event that triggered the workflow (push, pull_request, etc.) |
workflow_run.status | string | Current status (queued, in_progress, completed) |
workflow_run.conclusion | string | Conclusion (success, failure, cancelled, skipped, timed_out, action_required) |
workflow_run.head_branch | string | Branch name |
workflow_run.head_sha | string | Commit SHA that triggered the workflow |
workflow_run.path | string | Path to the workflow file |
workflow_run.display_title | string | Display title for the run |
workflow_run.run_started_at | string | Timestamp when the run started |
workflow_run.created_at | string | Workflow run creation timestamp |
workflow_run.updated_at | string | Workflow run last update timestamp |
workflow_run.html_url | string | Workflow run HTML URL |
workflow_run.check_suite_id | number | Associated check suite ID |
workflow_run.check_suite_node_id | string | Associated check suite node ID |
workflow_run.url | string | Workflow run API URL |
workflow_run.actor.login | string | Username |
workflow_run.actor.id | number | User ID |
workflow_run.actor.node_id | string | User node ID |
workflow_run.actor.avatar_url | string | Avatar URL |
workflow_run.actor.html_url | string | Profile URL |
workflow_run.actor.user_type | string | User type (User, Bot, Organization) |
workflow_run.triggering_actor.login | string | Username |
workflow_run.triggering_actor.id | number | User ID |
workflow_run.triggering_actor.node_id | string | User node ID |
workflow_run.triggering_actor.avatar_url | string | Avatar URL |
workflow_run.triggering_actor.html_url | string | Profile URL |
workflow_run.triggering_actor.user_type | string | User type (User, Bot, Organization) |
workflow_run.repository.id | number | Repository ID |
workflow_run.repository.node_id | string | Repository node ID |
workflow_run.repository.name | string | Repository name |
workflow_run.repository.full_name | string | Repository full name |
workflow_run.repository.private | boolean | Whether repository is private |
workflow_run.head_repository.id | number | Head repository ID |
workflow_run.head_repository.node_id | string | Head repository node ID |
workflow_run.head_repository.name | string | Head repository name |
workflow_run.head_repository.full_name | string | Head repository full name |
workflow_run.head_repository.private | boolean | Whether repository is private |
workflow_run.head_commit.id | string | Commit SHA |
workflow_run.head_commit.tree_id | string | Tree ID |
workflow_run.head_commit.message | string | Commit message |
workflow_run.head_commit.timestamp | string | Commit timestamp |
workflow_run.head_commit.author.name | string | Author name |
workflow_run.head_commit.author.email | string | Author email |
workflow_run.head_commit.committer.name | string | Committer name |
workflow_run.head_commit.committer.email | string | Committer email |
workflow_run.pull_requests | array | Array of associated pull requests |
workflow_run.referenced_workflows | array | Array of referenced workflow runs |
workflow.id | number | Workflow ID |
workflow.node_id | string | Workflow node ID |
workflow.name | string | Workflow name |
workflow.path | string | Path to workflow file |
workflow.state | string | Workflow state (active, deleted, disabled_fork, etc.) |
workflow.created_at | string | Workflow creation timestamp |
workflow.updated_at | string | Workflow last update timestamp |
workflow.url | string | Workflow API URL |
workflow.html_url | string | Workflow HTML URL |
workflow.badge_url | string | Workflow badge URL |
repository.id | number | Repository ID |
repository.node_id | string | Repository node ID |
repository.name | string | Repository name |
repository.full_name | string | Repository full name (owner/repo) |
repository.private | boolean | Whether the repository is private |
repository.html_url | string | Repository HTML URL |
repository.repo_description | string | Repository description |
repository.owner.login | string | Owner username |
repository.owner.id | number | Owner ID |
repository.owner.node_id | string | Owner node ID |
repository.owner.avatar_url | string | Owner avatar URL |
repository.owner.html_url | string | Owner profile URL |
repository.owner.owner_type | string | Owner type (User, Organization) |
sender.login | string | Username |
sender.id | number | User ID |
sender.node_id | string | User node ID |
sender.avatar_url | string | Avatar URL |
sender.html_url | string | Profile URL |
sender.user_type | string | User type (User, Bot, Organization) |
- Category:
tools
- Type:
github