GitHub

ToolJet can connect to GitHub account to read and write data. In order for ToolJet to access and manipulate data on GitHub, a GitHub Personal Access Token is necessary to authenticate and interact with the GitHub API.

note

Before following this guide, it is assumed that you have already completed the process of Using Marketplace plugins.

Connection

For connecting to GitHub, following credentials are required:

• Personal Access Token: Generate a Personal Access Token from your GitHub Account Settings

caution

If a Personal Access Token is not provided, the data from the private repositories will not be retrieved via the GitHub Plugin. However, the public repositories data can still be retrieved.

Supported queries

• Get user info
• Get repository
• Get repository issues
• Get repository pull requests

Get user info

All the details regarding the user is retrieved by running this query.

Required parameters:

• Username: To obtain the details, the username of the user must be provided for this field. You can input the username of a GitHub organization or a user for this field.

Get repository

All the details regarding the repository are retrieved by running this query.

Required parameters:

• Owner: The owner's name of the repository is required for this field. The owner can either be a GitHub organization or a user.
• Repository: Provide the name of the repository of which you want to retrieve the details.

Get repository issues

Running this query will retrieve a list of issues from a repository. You can select whether to obtain All, Open, or Closed issues.

Required parameters:

• Owner: The owner's name of the repository is required for this field. The owner can either be a GitHub organization or a user.
• Repository: Provide the name of the repository of which you want to retrieve the issues.
• State: Choose the state of the issues that you would like to retrieve: All, Open, or Closed.

Get repository pull requests

Running this query will retrieve a list of pull requests from a repository. You can select whether to obtain All, Open, or Closed issues.

Required parameters:

• Owner: The owner's name of the repository is required for this field. The owner can either be a GitHub organization or a user.
• Repository: Provide the name of the repository of which you want to retrieve the pull requests.
• State: Choose the state of the pull requests that you would like to retrieve: All, Open, or Closed.