Skip to content

GitHub

The GitHub API node lets you interact with GitHub repositories in your workflows. You can list, get, create, update, and comment on issues, pull requests, commits, and releases through a single flexible node.

All operations require a GitHub connection configured with a Personal Access Token.

Configuration

FieldDescriptionNotes
ConnectionGitHub connection to useRequired
OwnerRepository owner (user or organization)Required. Supports templates
RepositoryRepository nameRequired. Supports templates
ResourceWhat to operate on: Issues, Pull Requests, Commits, ReleasesRequired
OperationAction to perform: List, Get, Create, Update, CommentRequired. Available operations depend on resource
Resource IDIssue/PR number or commit SHARequired for Get, Update, Comment
Query ParametersAdditional API parameters as key-value pairsOptional. Shown for List only
Request Body (JSON)JSON body for create, update, or commentRequired for Create, Update, Comment

Operation / Resource Matrix

ResourceListGetCreateUpdateComment
IssuesYYYYY
Pull RequestsYY--Y
CommitsYY---
ReleasesYYY--

Examples

List Open Issues

Set Resource to Issues, Operation to List, and add a query parameter state = open.

Create an Issue

Set Resource to Issues, Operation to Create, and provide the body:

json
{
  "title": "Bug: login page broken",
  "body": "Steps to reproduce...",
  "labels": ["bug", "priority:high"]
}

Comment on a Pull Request

Set Resource to Pull Requests, Operation to Comment, Resource ID to the PR number, and provide:

json
{
  "body": "Automated review: all checks passed for {{data.sha}}"
}

Create a Release

Set Resource to Releases, Operation to Create, and provide:

json
{
  "tag_name": "v1.0.0",
  "name": "Release v1.0.0",
  "body": "First stable release",
  "draft": false,
  "prerelease": false
}

Output

All operations return the raw GitHub API response object. Common fields include:

FieldDescription
idGitHub resource ID
numberIssue or PR number
titleTitle (issues, PRs, releases)
stateCurrent state (open, closed)
html_urlLink to view on GitHub
created_atISO timestamp
updated_atISO timestamp

List operations return an array of these objects.

Streaming Support

  • List operations emit each result item individually, enabling streaming pipelines
  • Create, Update, Comment operations process each upstream item, making them suitable for batch operations (e.g., comment on every issue matching a filter)

Template References

Use template expressions to reference data from upstream nodes. For example, set Owner to {{data.owner}} and Repository to {{data.repo}} to dynamically target different repositories.