GitHub Issues icon

GitHub Issues

Consume issues from the GitHub API

Actions4

Overview

This node allows you to interact with GitHub Issues via the GitHub API. Specifically, the "Get" operation under the "Issue" resource fetches detailed information about a single issue from a specified GitHub repository. This is useful for workflows that need to retrieve issue data for tracking, reporting, or automation purposes.

Common scenarios:

  • Automatically fetching issue details when an issue ID is provided.
  • Integrating GitHub issue data into project management dashboards.
  • Triggering downstream actions based on issue metadata (e.g., labels, status).

Practical example:
You want to get details of issue #123 in the n8n-io/n8n repository owned by n8n-io. You configure this node with the owner as n8n-io, repository as n8n, and issue number as 123. The node then returns all relevant data about that issue, such as title, body, state, assignees, comments count, etc.

Properties

Name Meaning
Authentication Method to authenticate with GitHub API. Options: "Access Token" or "OAuth2".
Repository Owner The owner of the GitHub repository. Can be selected from a list, entered as a URL, or typed by name.
Repository Name The name of the GitHub repository. Can be selected from a list, entered as a URL, or typed by name.
Issue The specific issue to retrieve. Can be selected from a list or entered by its numeric ID.

Output

The node outputs JSON data representing the GitHub issue object retrieved from the API. This includes fields such as:

  • id: Unique identifier of the issue.
  • number: Issue number within the repository.
  • title: Title of the issue.
  • body: Description or content of the issue.
  • state: Current state (e.g., open, closed).
  • assignees: List of users assigned to the issue.
  • labels: Labels attached to the issue.
  • comments: Number of comments.
  • created_at, updated_at, closed_at: Timestamps related to the issue lifecycle.
  • Other metadata as provided by the GitHub API.

The node does not output binary data.

Dependencies

  • Requires a valid GitHub API authentication credential, either an access token or OAuth2 token.
  • Needs network access to https://api.github.com.
  • No additional external dependencies beyond standard HTTP requests.

Troubleshooting

  • Authentication errors: Ensure your API token or OAuth2 credentials have sufficient permissions to read issues from the target repository.
  • Invalid repository or owner: Double-check the owner and repository names or URLs are correct and accessible.
  • Issue not found: Verify the issue number exists in the specified repository.
  • Rate limiting: GitHub API enforces rate limits; if exceeded, wait or use authenticated requests with higher limits.
  • Validation errors: Input fields like URLs or names must match expected patterns; otherwise, validation errors will occur.

Links and References

Discussion