GitHub

GitHub is a web-based Git repository hosting service. It offers all of the distributed revision control and source code management (SCM) functionality of Git as well as adding its own features.

This connector is available in the following products and regions:

Service	Class	Regions
Logic Apps	Standard	All Logic Apps regions except the following:      -   Azure China regions      -   US Department of Defense (DoD)
Power Automate	Standard	All Power Automate regions except the following:      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)
Power Apps	Standard	All Power Apps regions except the following:      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)

Contact
Name	Microsoft
URL	Microsoft LogicApps Support Microsoft Power Automate Support Microsoft Power Apps Support

Connector Metadata
Publisher	Microsoft
Website	https://github.com/

Connector github apps publisher

This connector uses apps by aaptapps account

Connector in-depth

For more information about the connector, see the in-depth section.

Known issues and limitations

Please note that triggers search for issue items across owned and member repositories assigned to the authenticated user. Organization repositories are not supported.

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds
Frequency of trigger polls	1	15 seconds

Actions

Add selected repository to an organization secret (Preview)	Adds a repository to an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.
Check if a user is a repository collaborator	Check if a user is a repository collaborator.
Compare two commits (Preview)	Both base and head must be branch names in repositoryName. To compare branches across other repositories in the same network as repositoryName, use the format <USERNAME>:branch. The response is equivalent to running the git log base..head command; however, commits are returned in chronological order.
Create a pull request (Preview)	This operation is to create a pull request in a repository. To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to create a pull request.
Create a reference (Preview)	Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.
Create a repository dispatch event (Preview)	This operation is to trigger a webhook event called repository_dispatch when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the repository_dispatch event occurs.
Create a repository using a template (Preview)	Creates a new repository using a repository template. The authenticated user must own or be a member of an organization that owns the repository.
Create an issue	This operation is used to create a new issue for a specific repository.
Create or update a repository secret (Preview)	Creates or updates a repository secret with an encrypted value. Encrypt your secret using LibSodium.
Deletes a GitHub Webhook (Preview)	Deletes a GitHub Webhook
Find issues by state and keyword	Find issues by state and keyword.
Get a particular issue of a repository	Get a particular issue of a repository.
Get a pull request (Preview)	This operation is used to get a pull request for the repository.
Get a reference (Preview)	Returns a single reference from your Git database. The reference parameter must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the reference doesn't match an existing ref, a 404 is returned.
Get a repository by Id (Preview)	Gets a repository by Id.
Get a repository public key (Preview)	Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets.
Get all issues of a repository	Get all issues of a repository.
Get all Pull Requests of A Repository	Get all Pull Requests of A Repository.
Get the authenticated user	Get the authenticated user.
Get the list of files from a pull request (Preview)	This operation is used to get the list of files from a pull request for the repository.
List repository collaborators	List repository collaborators.
Lists all labels for a repository	Lists all labels for a repository.
Lists all labels for an issue	Lists all labels for an issue.
Lists all milestones of a repository	Lists all milestones of a repository.
Lists all public repositories for a user	Lists all public repositories for a user.
Lists all public repositories for an organization	Lists all public repositories for an organization.
Lists all repositories for the authenticated user	Lists all repositories (both public and private) for the authenticated user.
Lists the available assignees for issues in a repository	Lists the available assignees for issues in a repository.
Merge a pull request (Preview)	This operation is used to merge a pull request for the repository.
Remove requested reviewers from a pull request (Preview)	Remove requested reviewers from a pull request from a given set of users and/or teams.
Remove selected repository from an organization secret (Preview)	Removes a repository from an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.
Request reviewers for a pull request (Preview)	Requests reviews for a pull request from a given set of users and/or teams.
Search Github using Query	Search Github using Query
Update a milestone	Update an existing milestone.
Update a pull request (Preview)	This operation is used to update a pull request for the repository. To update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
Update an Issue	Update an existing issue given the issue number.

Add selected repository to an organization secret (Preview)

Operation ID:

AddSelectedRepoToOrgSecret

Adds a repository to an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.

Parameters

Name	Key	Required	Type	Description
Repository Owner	repositoryOwner	True	string	Name of the repository owner.
Repository Id	repositoryId	True	integer	Unique Identifier of the repository.
Secret Name	secretName	True	string	Name of the secret.

Check if a user is a repository collaborator

Operation ID:

checkCollaborator

Check if a user is a repository collaborator.

Parameters

Name	Key	Required	Type	Description
Repository Owner	repositoryOwner	True	string	Name of the repository owner.
Repository Name	repositoryName	True	string	Name of the repository.
user Name	userName	True	string	The handle for the GitHub user account.

Returns

Model for fetching single API response

response

object

Compare two commits (Preview)

Operation ID:

CompareRepositoryCommits

Both base and head must be branch names in repositoryName. To compare branches across other repositories in the same network as repositoryName, use the format <USERNAME>:branch. The response is equivalent to running the git log base..head command; however, commits are returned in chronological order.

Parameters

Name	Key	Required	Type	Description
Repository Owner	repositoryOwner	True	string	Name of the repository owner.
Repository Name	repositoryName	True	string	Name of the repository.
Base	base	True	string	base parameter
Head	head	True	string	head parameter

Returns

Commit Comparison

Body

CommitComparison

Create a pull request (Preview)

Operation ID:

CreatePullRequest

This operation is to create a pull request in a repository. To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to create a pull request.

Parameters

Name	Key	Required	Type	Description
Repository Owner	repositoryOwner	True	string	Name of the repository owner.
Repository Name	repositoryName	True	string	Name of the repository.
Title	title		string	The title of the new pull request.
Head	head	True	string	The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.
Base	base	True	string	The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.
Body	body		string	The contents of the pull request.
Can Maintainer Modify?	maintainer_can_modify		boolean	Indicates whether maintainers can modify the pull request.
Draft	draft		boolean	Indicates whether the pull request is a draft.

Returns

Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.

Body

PullRequest

Create a reference (Preview)

Operation ID:

CreateReference

Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.

Parameters

Name	Key	Required	Type	Description
Repository Owner	repositoryOwner	True	string	Name of the repository owner.
Repository Name	repositoryName	True	string	Name of the repository.
Reference	ref	True	string	The name of the fully qualified reference (ie: refs/heads/master). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.
Sha	sha	True	string	The SHA1 value for this reference.

Returns

Git references within a repository

Body

GitReference

Create a repository dispatch event (Preview)

Operation ID:

CreateRepositoryDispatchEvent

This operation is to trigger a webhook event called repository_dispatch when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the repository_dispatch event occurs.

Parameters

Name	Key	Required	Type	Description
Repository Owner	repositoryOwner	True	string	Name of the repository owner.
Repository Name	repositoryName	True	string	Name of the repository.
Event Name	event_type		string	A custom webhook event name.
Event Payload	client_payload		object	JSON payload with extra information about the webhook event that your action or worklow may use.

Create a repository using a template (Preview)

Operation ID:

CreateRepositoryUsingTemplate

Creates a new repository using a repository template. The authenticated user must own or be a member of an organization that owns the repository.

Parameters

Name	Key	Required	Type	Description
Template Owner	templateOwner	True	string	Name of the template repository owner.
Template Repository	templateRepository	True	string	Name of the template repository.
Owner	owner		string	The organization or person who will own the new repository. If left blank, the authenticated user will be the owner.
Name	name	True	string	The name of the new repository.
Description	description		string	A short description of the new repository.
Is Private?	private		boolean	Either true to create a new private repository or false to create a new public one.

Returns

A git repository

Body

RepositoryDetails

Create an issue

Operation ID:

CreateIssue

This operation is used to create a new issue for a specific repository.

Parameters

Name	Key	Required	Type	Description
Repository Owner	repositoryOwner	True	string	Name of the repository owner.
Repository Name	repositoryName	True	string	Name of the repository.
Title	title	True	string	Summary of the issue.
Body	body		string	Description of the issue.

Returns

Properties of a GitHub issue.

Body

IssueDetailsModel

Create or update a repository secret (Preview)

Operation ID:

CreateUpdateRepositorySecret

Creates or updates a repository secret with an encrypted value. Encrypt your secret using LibSodium.

Parameters

Name	Key	Required	Type	Description
Repository Owner	repositoryOwner	True	string	Name of the repository owner.
Repository Name	repositoryName	True	string	Name of the repository.
Secret Name	secretName	True	string	Name of the secret.
encrypted_value	encrypted_value		string	Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an Repository public key action.
key_id	key_id		string	ID of the key you used to encrypt the secret.

Deletes a GitHub Webhook (Preview)

Operation ID:

DeleteWebhookTrigger

Deletes a GitHub Webhook

Parameters

Name	Key	Required	Type	Description
Repository Owner	repositoryOwner	True	string	Name of the repository owner.
Repository Name	repositoryName	True	string	Name of the repository.
GitHub Webhook ID	webhookId	True	string	ID of the GitHub Webhook

Find issues by state and keyword

Operation ID:

SearchIssues

Find issues by state and keyword.

Parameters

Name	Key	Required	Type	Description
q	q	True	string	Search keywords and qualifiers.
sort	sort		string	The property to sort the results by.
order	order		string	Direction of sort.
per_page	per_page		integer	Number of results per page.
page	page		integer	Page number to fetch

Returns

Model for fetching search results

Body

MultipleSearchFetchModel

Get a particular issue of a repository

Operation ID:

GetIssueNum

Get a particular issue of a repository.

Parameters

Name	Key	Required	Type	Description
Repository Owner	repositoryOwner	True	string	Name of the repository owner.
Repository Name	repositoryName	True	string	Name of the repository.
Issue Number	issueNumber	True	integer	Issue Number for a given issue.

Returns

Properties of a GitHub issue.

Body

IssueDetailsModel

Get a pull request (Preview)

Operation ID:

GetPullRequest

This operation is used to get a pull request for the repository.

Parameters

Name	Key	Required	Type	Description
Repository Owner	repositoryOwner	True	string	Name of the repository owner.
Repository Name	repositoryName	True	string	Name of the repository.
Pull Number	pullNumber	True	integer	Pull Number.

Returns

Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.

Body

PullRequest

Get a reference (Preview)

Operation ID:

GetReference

Returns a single reference from your Git database. The reference parameter must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the reference doesn't match an existing ref, a 404 is returned.

Parameters

Name	Key	Required	Type	Description
Repository Owner	repositoryOwner	True	string	Name of the repository owner.
Repository Name	repositoryName	True	string	Name of the repository.
Reference	reference	True	string	The ref in the URL must be formatted as heads/ for branches and tags/ for tags.

Returns

Git references within a repository

Body

GitReference

Get a repository by Id (Preview)

Operation ID:

GetRepositoryById

Gets a repository by Id.

Parameters

Name	Key	Required	Type	Description
Repository Id	repositoryId	True	integer	Unique Identifier of the repository.

Returns

A git repository

Body

RepositoryDetails

Get a repository public key (Preview)

Operation ID:

GetRepositoryPublicKey

Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets.

Parameters

Name	Key	Required	Type	Description
Repository Owner	repositoryOwner	True	string	Name of the repository owner.
Repository Name	repositoryName	True	string	Name of the repository.

Returns

The public key used for setting Actions Secrets.

Body

ActionsPublicKey

Get all issues of a repository

Operation ID:

GetIssues

Get all issues of a repository.

Parameters

Name	Key	Required	Type	Description
Repository Owner	repositoryOwner	True	string	Name of the repository owner.
Repository Name	repositoryName	True	string	Name of the repository.
milestone	milestone		string	Filter by milestone.
state	state		string	Filter by state.
assignee	assignee		string	Filter by assignee.
creator	creator		string	Filter by creator.
mentioned	mentioned		string	Filter by mentions.
labels	labels		string	Filter by label names.
sort	sort		string	Field to sort results by.
direction	direction		string	Direction of sort.
since	since		string	Filter by issues after given date.
per_page	per_page		integer	Number of results per page.
page	page		integer	Page number to display.

Returns

Model for fetching list API response

Items

MultipleFetchModel

Get all Pull Requests of A Repository

Operation ID:

GetPullRequests

Get all Pull Requests of A Repository.

Parameters

Name	Key	Required	Type	Description
Repository Owner	repositoryOwner	True	string	Name of the repository owner.
Repository Name	repositoryName	True	string	Name of the repository.
state	state		string	Filter by state.
head	head		string	Filter by head user or organization.
base	base		string	Filter by base branch name.
sort	sort		string	What to sort the results by.
direction	direction		string	Direction of sort.
perPage	per_page		integer	Number of results per page.
page	page		integer	Page number to display.

Returns

Model for fetching list API response

Items

MultipleFetchModel

Get the authenticated user

Operation ID:

GetUser

Get the authenticated user.

Returns

Properties of a GitHub user.

Body

UserDetailsModel

Get the list of files from a pull request (Preview)

Operation ID:

GetPullRequestFiles

This operation is used to get the list of files from a pull request for the repository.

Parameters

Name	Key	Required	Type	Description
Repository Owner	repositoryOwner	True	string	Name of the repository owner.
Repository Name	repositoryName	True	string	Name of the repository.
Pull Number	pullNumber	True	integer	Pull Number.

Returns

response

array of PullRequestFile

List repository collaborators

Operation ID:

ListCollaborators

List repository collaborators.

Parameters

Name	Key	Required	Type	Description
Repository Owner	repositoryOwner	True	string	Name of the repository owner.
Repository Name	repositoryName	True	string	Name of the repository.
per_page	per_page		integer	Number of results per page.
page	page		integer	Page number to display.

Returns

Model for fetching list API response

Items

MultipleFetchModel

Lists all labels for a repository

Operation ID:

GetLabels

Lists all labels for a repository.

Parameters

Name	Key	Required	Type	Description
Repository Owner	repositoryOwner	True	string	Name of the repository owner.
Repository Name	repositoryName	True	string	Name of the repository.
per_page	per_page		integer	Number of results per page.
page	page		integer	Page number to display.

Returns

Model for fetching list API response

Items

MultipleFetchModel

Lists all labels for an issue

Operation ID:

GetIssueLabels

Lists all labels for an issue.

Parameters

Name	Key	Required	Type	Description
Repository Owner	repositoryOwner	True	string	Name of the repository owner.
Repository Name	repositoryName	True	string	Name of the repository.
Issue Number	issueNumber	True	integer	Issue Number for a given issue.
per_page	per_page		integer	Number of results per page.
page	page		integer	Page number to display.

Returns

Model for fetching list API response

Items

MultipleFetchModel

Lists all milestones of a repository

Operation ID:

GetMilestones

Lists all milestones of a repository.

Parameters

Name	Key	Required	Type	Description
Repository Owner	repositoryOwner	True	string	Name of the repository owner.
Repository Name	repositoryName	True	string	Name of the repository.
state	state		string	State of the milestone.
sort	sort		string	What to sort the results by.
direction	direction		string	Direction of sort.
per_page	per_page		integer	Number of results per page.
page	page		integer	Page number to display.

Returns

Model for fetching list API response

Items

MultipleFetchModel

Lists all public repositories for a user

Operation ID:

GetRepos

Lists all public repositories for a user.

Parameters

Name	Key	Required	Type	Description
Repository Owner	repositoryOwner	True	string	Name of the repository owner.
type	type		string	Limit results to repositories of the specified type.
sort	sort		string	The property to sort the results by.
direction	direction		string	Direction of sort.
per_page	per_page		integer	Number of results per page.
page	page		integer	Page number to fetch

Returns

Model for fetching list API response

Items

MultipleFetchModel

Lists all public repositories for an organization

Operation ID:

GetOrgRepos

Lists all public repositories for an organization.

Parameters

Name	Key	Required	Type	Description
Repository Owner	repositoryOwner	True	string	Name of the repository owner.
type	type		string	Limit results to repositories of the specified type.
sort	sort		string	The property to sort the results by.
direction	direction		string	Direction of sort.
per_page	per_page		integer	Number of results per page.
page	page		integer	Page number to fetch

Returns

Model for fetching list API response

Items

MultipleFetchModel

Lists all repositories for the authenticated user

Operation ID:

GetUserRepos

Lists all repositories (both public and private) for the authenticated user.

Parameters

Name	Key	Required	Type	Description
visibility	visibility		string	Limit results to repositories of the specified visibility(public/private/all).
affiliation	affiliation		string	Limit results based on affiliation.
since	since		string	Limit results to repositories updated after a given time.
before	before		string	Limit results to repositories updated before a given time.
type	type		string	Limit results to repositories of the specified type.
sort	sort		string	The property to sort the results by.
direction	direction		string	Direction of sort.
per_page	per_page		integer	Number of results per page.
page	page		integer	Page number to fetch

Returns

Model for fetching list API response

Items

MultipleFetchModel

Lists the available assignees for issues in a repository

Operation ID:

GetAssignees

Lists the available assignees for issues in a repository.

Parameters

Name	Key	Required	Type	Description
Repository Owner	repositoryOwner	True	string	Name of the repository owner.
Repository Name	repositoryName	True	string	Name of the repository.
per_page	per_page		integer	Number of results per page.
page	page		integer	Page number to display.

Returns

Model for fetching list API response

Items

MultipleFetchModel

Merge a pull request (Preview)

Operation ID:

MergePullRequest

This operation is used to merge a pull request for the repository.

Parameters

Name	Key	Required	Type	Description
Repository Owner	repositoryOwner	True	string	Name of the repository owner.
Repository Name	repositoryName	True	string	Name of the repository.
Pull Number	pullNumber	True	integer	Pull Number.
Commit Title	commitTitle		string	Title for the automatic commit message.
Commit Message	commitMessage		string	Extra detail to append to automatic commit message.
Sha	sha		string	SHA that pull request head must match to allow merge.
Merge Method	mergeMethod		string	Merge method to use. Possible values are merge, squash or rebase. Default is merge.

Returns

Pull Request Merge Result.

Body

PullRequestMergeResult

Remove requested reviewers from a pull request (Preview)

Operation ID:

RemoveReviewersPullRequest

Remove requested reviewers from a pull request from a given set of users and/or teams.

Parameters

Name	Key	Required	Type	Description
Repository Owner	repositoryOwner	True	string	Name of the repository owner.
Repository Name	repositoryName	True	string	Name of the repository.
Pull Number	pullNumber	True	integer	Pull Number.
reviewers	reviewers		array of string
team_reviewers	team_reviewers		array of string

Remove selected repository from an organization secret (Preview)

Operation ID:

RemoveSelectedRepoFromOrgSecret

Removes a repository from an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.

Parameters

Name	Key	Required	Type	Description
Repository Owner	repositoryOwner	True	string	Name of the repository owner.
Repository Id	repositoryId	True	integer	Unique Identifier of the repository.
Secret Name	secretName	True	string	Name of the secret.

Request reviewers for a pull request (Preview)

Operation ID:

RequestReviewersPullRequest

Requests reviews for a pull request from a given set of users and/or teams.

Parameters

Name	Key	Required	Type	Description
Repository Owner	repositoryOwner	True	string	Name of the repository owner.
Repository Name	repositoryName	True	string	Name of the repository.
Pull Number	pullNumber	True	integer	Pull Number.
reviewers	reviewers		array of string
team_reviewers	team_reviewers		array of string

Search Github using Query

Operation ID:

SearchGithubWithQuery

Search Github using Query

Parameters

Name	Key	Required	Type	Description
query	query		string	query

Update a milestone

Operation ID:

UpdateMilestone

Update an existing milestone.

Parameters

Name	Key	Required	Type	Description
Repository Owner	repositoryOwner	True	string	Name of the repository owner.
Repository Name	repositoryName	True	string	Name of the repository.
Milestone Number	milestoneNumber	True	integer	Milestone number for a given milestone.
Title	title		string	Summary of the milestone.
State	state		string	The open or close state of the milestone.
milestones	description		string	A description of the milestone.
due_on	due_on		string	Due date of the milestone.

Returns

A collection of related issues and pull requests.

response

Milestone

Update a pull request (Preview)

Operation ID:

UpdatePullRequest

This operation is used to update a pull request for the repository. To update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

Parameters

Name	Key	Required	Type	Description
Repository Owner	repositoryOwner	True	string	Name of the repository owner.
Repository Name	repositoryName	True	string	Name of the repository.
Pull Number	pullNumber	True	integer	Pull Number.
Title	title		string	The title of the pull request.
Body	body		string	The contents of the pull request.
State	state		string	State of this Pull Request. Either open or closed.
Base	base		string	The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.
Can Maintainer Modify?	maintainer_can_modify		boolean	Indicates whether maintainers can modify the pull request.

Returns

Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.

Body

PullRequest

Update an Issue

Operation ID:

UpdateIssueNum

Update an existing issue given the issue number.

Parameters

Name	Key	Required	Type	Description
Repository Owner	repositoryOwner	True	string	Name of the repository owner.
Repository Name	repositoryName	True	string	Name of the repository.
Issue Number	issueNumber	True	integer	Issue Number for a given issue.
Title	title		string	Summary of the issue.
Body	body		string	Description of the issue.
assignee	assignee		string	Assignee of the issue.
State	state		string	The open or close state of an issue. Can be one of open or closed.
ChangeReason	state_reason		string	The reason for change of state.
milestones	milestone		string	Number of milestones to associate with issue.
labels	labels		array of string	labels associated with the issue.
assignees	assignees		array of string	UserSnames to assign to the issue.

Returns

Properties of a GitHub issue.

Body

IssueDetailsModel

Triggers

When a new issue is opened and assigned to me	This operation triggers when an issue is opened and assigned to the logged in user.
When a pull request is created or modified (Preview)	Creates a GitHub Webhook for Pull Requests
When an issue assigned to me is closed	This operation triggers when an issue assigned to the logged in user is closed.
When an issue is assigned to me	This operation triggers when an issue is assigned to the logged in user.

When a new issue is opened and assigned to me

Operation ID:

IssueOpened

This operation triggers when an issue is opened and assigned to the logged in user.

Returns

Properties of a GitHub issue.

Body

IssueDetailsModel

When a pull request is created or modified (Preview)

Operation ID:

WebhookPullRequestTrigger

Creates a GitHub Webhook for Pull Requests

Parameters

Name	Key	Required	Type	Description
Repository Owner	repositoryOwner	True	string	Name of the repository owner.
Repository Name	repositoryName	True	string	Name of the repository.
Webhook events to listen on	events	True	array of string	Webhook events to listen on

Returns

Webhook pull request response.

Body

WebhookPullRequestResponse

When an issue assigned to me is closed

Operation ID:

IssueClosed

This operation triggers when an issue assigned to the logged in user is closed.

Returns

Properties of a GitHub issue.

Body

IssueDetailsModel

When an issue is assigned to me

Operation ID:

IssueAssigned

This operation triggers when an issue is assigned to the logged in user.

Returns

Properties of a GitHub issue.

Body

IssueDetailsModel

Definitions

IssueDetailsModel

Properties of a GitHub issue.

Name	Path	Type	Description
Title	title	string	Summary of the issue.
Body	body	string	Description of the issue.
assignee	assignee	UserDetailsModel	Properties of a GitHub user.
Id	number	integer	Unique id of the issue.
State	state	string	Status of the issue.
Created Date-Time	created_at	string	yyyy-MM-ddTHH:mm:ss.fffZ (UTC format).
Repository Url	repository_url	string	Web link to the repository.

MultipleSearchFetchModel

Model for fetching search results

Name	Path	Type	Description
body	body	array of GeneralAPIModel	body of result

MultipleFetchModel

Model for fetching list API response

Name	Path	Type	Description
Items		GeneralAPIModel	Model for fetching single API response

GeneralAPIModel

Model for fetching single API response

UserDetailsModel

Properties of a GitHub user.

Name	Path	Type	Description
Login	login	string	User Login.
Id	id	integer	User Id.
Node Id	node_id	string	User Node Id.
Avatar Url	avatar_url	string	User Avatar Url.
Gravatar Id	gravatar_id	string	User Gravatar Id.
Url	url	string	User Url.
Html Url	html_url	string	User Html Url.
Followers Url	followers_url	string	User FollowersUrl
Following Url	following_url	string	User Following Url.
Gists Url	gists_url	string	User Gists Url.
Starred Url	starred_url	string	User Starred Url.
Subscriptions Url	subscriptions_url	string	User Subscriptions Url.
Organizations Url	organizations_url	string	User Organizations Url.
Repos Url	repos_url	string	User Repos Url.
Events Url	events_url	string	User Events Url.
Received Events Url	received_events_url	string	User Received Events Url.
Type	type	string	User Type.
Site Admin	site_admin	boolean	Is User Site Admin?
Name	name	string	User Name.
Company	company	string	User Company.
Blog	blog	string	User Blog.
Location	location	string	User Location.
Email	email	string	User Email.
Hireable	hireable	boolean	User Hireable?
Bio	bio	string	User Bio.
Public Repos	public_repos	integer	User Public Repos.
Public Gists	public_gists	integer	User Public Gists.
Followers	followers	integer	User Followers.
Following	following	integer	User Following.
Created At	created_at	date-time	User Created At.
Updated At	updated_at	date-time	User Updated At.

Verification

Name	Path	Type	Description
Is Verified	verified	boolean	Indicates whether GitHub considers the signature in this commit to be verified.
Verification reason	reason	string	The reason for verified value.
Signed value	payload	string	The value that was signed.
Commit Signature	signature	string	The signature that was extracted from the commit.

GitUser

Metaproperties for Git author/committer information.

Name	Path	Type	Description
Git User Name	name	string	User Name
Git User Email	email	string	Email
Timestamp of Commit	date	string	Timestamp of Commit.

DiffEntry

Diff Entry

Name	Path	Type	Description
File Name	filename	string	Changed File Name.
Additions	additions	integer	Number of additions in the file
Deletions	deletions	integer	Number of Deletions in the file
Changes	changes	integer	Number of Changes in the file
Status	status	string	Status of the change modified, renamed etc.,
Raw Url	raw_url	string	Raw Url link to the file
Blob Url	blob_url	string	Blob Url link to the file
Patch	patch	string	Actual changes made to the file.
Sha of the change	sha	string	SHA of the change.
Contents Url	contents_url	string	File Contents Url.
Previous FileName	previous_filename	string	Previous FileName if the FileName is changed

Commit

Commit

Name	Path	Type	Description
Commit Url	url	string	The HTTP URL for the commit.
Commit Sha	sha	string	SHA of the commit
Node Id	node_id	string	Node Id of the commit.
HTML Url	html_url	string	HTML Url of the commit
Comments Url	comments_url	string	Comments Url of the commit
Commit Url	commit.url	string	Url of the commit.
author	commit.author	GitUser	Metaproperties for Git author/committer information.
committer	commit.committer	GitUser	Metaproperties for Git author/committer information.
Commit message	commit.message	string	Commit Message.
Comment Count	commit.comment_count	integer	Comments Count of the commit
Commit Sha	commit.tree.sha	string	SHA of the Commit
Commit Url	commit.tree.url	uri	Commit Url.
verification	commit.verification	Verification
author	author	UserDetailsModel	Properties of a GitHub user.
committer	committer	UserDetailsModel	Properties of a GitHub user.
parents	parents	array of object
Parent Sha	parents.sha	string	Parent branch commit sha
Parent branch Url	parents.url	string	Url of the parent branch.
Parent branch HTML Url	parents.html_url	string	HTML Url of the parent branch.
Additions	stats.additions	integer	Number of additions
Deletions	stats.deletions	integer	Number of Deletions
Total	stats.total	integer	Total changes
files	files	array of DiffEntry

CommitComparison

Commit Comparison

Name	Path	Type	Description
Url	url	string	Url for the comparison
HTML Url	html_url	string	Html Url for the comparison
Permanent Url	permalink_url	string	Permanent Url for the comparison
Diff Url	diff_url	string	Diff Url
Patch Url	patch_url	string	Patch Url
base_commit	base_commit	Commit	Commit
merge_base_commit	merge_base_commit	Commit	Commit
Status	status	string	Status of the comparision eg. diverged etc.,
Ahead by	ahead_by	integer	ahead by base branch
Behind by	behind_by	integer	behind_by base branch
Total Commits	total_commits	integer	total commits
Commits	commits	array of Commit	commits
Files	files	array of DiffEntry	files

ActionsPublicKey

The public key used for setting Actions Secrets.

Name	Path	Type	Description
Key Id	key_id	string	The identifier for the key.
Key	key	string	The Base64 encoded public key.
Id	id	integer	Unique identifier of the key.
Url	url	string	Public key url.
Title	title	string	Public key title.
Created At	created_at	string	The date and time when the key was created.

LicenseDetails

License Details

Name	Path	Type	Description
Key	key	string	The lowercased SPDX Id of the license.
Name	name	string	The license full name specified by https://spdx.org/licenses.
Url	url	uri	URL to the license on https://choosealicense.com.
SPDX Id	spdx_id	string	Short identifier specified by https://spdx.org/licenses.
Node Id	node_id	string	License Node Id.
HTML Url	html_url	uri	License HTML URL.

RepositoryMiniDetails

A git repository

Name	Path	Type	Description
Repository Id	id	integer	Unique identifier of the repository.
Repository Node Id	node_id	string	The Node Id of the repository.
Repository Name	name	string	The name of the repository.
Repository Full Name	full_name	string	The full name of the repository.
admin	permissions.admin	boolean
pull	permissions.pull	boolean
triage	permissions.triage	boolean
push	permissions.push	boolean
maintain	permissions.maintain	boolean
owner	owner	UserDetailsModel	Properties of a GitHub user.
Is Repository Private?	private	boolean	Whether the repository is private or public.
Repository Description	description	string	The description of the repository
Repository Homepage	homepage	uri	The homepage for this repository
Repository Language	language	string	The language for this repository
Is Repository Archived?	archived	boolean	Whether the repository is archived.
Is Repository Disabled?	disabled	boolean	Returns whether or not this repository disabled.
Repository Visibility	visibility	string	The repository visibility: public, private, or internal.
Repository Created At	created_at	date-time	the date and time when the repository was created.
Repository Updated At	updated_at	date-time	the date and time when the repository was last updated.
Repository Allow Rebase Merge	allow_rebase_merge	boolean	Whether to allow rebase merges for pull requests.
Repository Allow Squash Merge	allow_squash_merge	boolean	Whether to allow squash merges for pull requests.
Repository Delete Branch On Merge	delete_branch_on_merge	boolean	Whether to delete head branches when pull requests are merged
Repository Allow Merge Commit	allow_merge_commit	boolean	Whether to allow merge commits for pull requests.
Repository Master Branch	master_branch	string	Repository master branch.

RepositoryDetails

A git repository

Name	Path	Type	Description
Id	id	integer	Unique identifier of the repository.
Node Id	node_id	string	The Node Id of the repository.
Name	name	string	The name of the repository.
Full Name	full_name	string	The full name of the repository.
License	license	LicenseDetails	License Details
Forks	forks	integer	The number of forks of the repository.
admin	permissions.admin	boolean
pull	permissions.pull	boolean
triage	permissions.triage	boolean
push	permissions.push	boolean
maintain	permissions.maintain	boolean
owner	owner	UserDetailsModel	Properties of a GitHub user.
Is Private?	private	boolean	Whether the repository is private or public.
Html Url	html_url	uri	The Html Url of the repository
Description	description	string	The description of the repository
Is a Fork?	fork	boolean	If the repository is a fork?
Url	url	uri	The HTTP URL for this repository
Archive Url	archive_url	string	The Archive URL for this repository
Assignees Url	assignees_url	string	The Assignees URL for this repository
Blobs Url	blobs_url	string	The Blobs URL for this repository
Branches Url	branches_url	string	The Branches URL for this repository
Collaborators Url	collaborators_url	string	The Collaborators URL for this repository
Comments Url	comments_url	string	The Comments URL for this repository
Commits Url	commits_url	string	The Commits URL for this repository
Compare Url	compare_url	string	The Compare URL for this repository
Contents Url	contents_url	string	The Contents URL for this repository
Contributors Url	contributors_url	uri	The Contributors URL for this repository
Deployments Url	deployments_url	uri	The Deployments URL for this repository
Downloads Url	downloads_url	uri	The Downloads URL for this repository
Events Url	events_url	uri	The Events URL for this repository
Forks Url	forks_url	uri	The Forks URL for this repository
Git Commits Url	git_commits_url	string	The Git Commits URL for this repository
Git References Url	git_refs_url	string	The Git References URL for this repository
Git Tags Url	git_tags_url	string	The Git Tags URL for this repository
Git Url	git_url	string	The Git URL for this repository
Issue Comment Url	issue_comment_url	string	The issue comment URL for this repository
Issue Events Url	issue_events_url	string	The issue events URL for this repository
Issues Url	issues_url	string	The issues URL for this repository
Keys Url	keys_url	string	The keys URL for this repository
Labels Url	labels_url	string	The labels URL for this repository
Languages Url	languages_url	uri	The languages URL for this repository
Merges Url	merges_url	uri	The merges URL for this repository
Milestones Url	milestones_url	string	The milestones URL for this repository
Notifications Url	notifications_url	string	The notifications URL for this repository
Pulls Url	pulls_url	string	The pulls URL for this repository
Releases Url	releases_url	string	The releases URL for this repository
SSH Url	ssh_url	string	The SSH URL to clone this repository
Stargazers Url	stargazers_url	uri	The stargazers (Stargazers are the people that have bookmarked the GitHub repository) URL for this repository
Statuses Url	statuses_url	string	The statuses URL for this repository
Subscribers Url	subscribers_url	uri	The subscribers URL for this repository
Subscription Url	subscription_url	uri	The subscription URL for this repository
Tags Url	tags_url	uri	The tags URL for this repository
Teams Url	teams_url	uri	The teams URL for this repository
Trees Url	trees_url	string	The trees URL for this repository
Clone Url	clone_url	string	The clone URL for this repository
Mirror Url	mirror_url	uri	The original mirror URL for this repository
Hooks Url	hooks_url	uri	The hooks URL for this repository
SVN Url	svn_url	uri	The SVN URL for this repository
Homepage	homepage	uri	The homepage for this repository
Language	language	string	The language for this repository
Forks Count	forks_count	integer	Number of forks there are of this repository in the whole network.
Stargazers Count	stargazers_count	integer	Number of users who have starred the repository.
Watchers Count	watchers_count	integer	Number of users watching the repository.
Size	size	integer	Size of the repository
Default Branch	default_branch	string	The default branch of the repository.
Open Issues Count	open_issues_count	integer	Number of open issues in the repository.
Is Template?	is_template	boolean	Whether this repository acts as a template that can be used to generate new repositories.
Topics	topics	array of string	List of topics in the repository
Has Issues?	has_issues	boolean	Whether issues are enabled.
Has Projects?	has_projects	boolean	Whether projects are enabled.
Has Wiki?	has_wiki	boolean	Whether the wiki is enabled.
Has Pages?	has_pages	boolean	Whether pages are enabled.
Has Downloads?	has_downloads	boolean	Whether downloads are enabled.
Is Archived?	archived	boolean	Whether the repository is archived.
Is Disabled?	disabled	boolean	Returns whether or not this repository disabled.
Visibility	visibility	string	The repository visibility: public, private, or internal.
Pushed At	pushed_at	date-time	When the repository was last pushed to.
Created At	created_at	date-time	the date and time when the repository was created.
Updated At	updated_at	date-time	the date and time when the repository was last updated.
Allow Rebase Merge	allow_rebase_merge	boolean	Whether to allow rebase merges for pull requests.
Template Repository Id	template_repository.id	integer	Unique identifier of the repository.
Template Repository Node Id	template_repository.node_id	string	The Node Id of the repository.
Template Repository Name	template_repository.name	string	The name of the repository.
Template Repository Full Name	template_repository.full_name	string	The full name of the repository.
owner	template_repository.owner	UserDetailsModel	Properties of a GitHub user.
Is Template Repository Private?	template_repository.private	boolean	Whether the repository is private or public.
Template Repository Html Url	template_repository.html_url	uri	The Html Url of the repository
Template Repository Description	template_repository.description	string	The description of the repository
Is Template Repository a Fork?	template_repository.fork	boolean	If the repository is a fork?
Template Repository Url	template_repository.url	uri	The HTTP URL for this repository
Template Repository Archive Url	template_repository.archive_url	string	The Archive URL for this repository
Template Repository Assignees Url	template_repository.assignees_url	string	The Assignees URL for this repository
Template Repository Blobs Url	template_repository.blobs_url	string	The Blobs URL for this repository
Template Repository Branches Url	template_repository.branches_url	string	The Branches URL for this repository
Template Repository Collaborators Url	template_repository.collaborators_url	string	The Collaborators URL for this repository
Template Repository Comments Url	template_repository.comments_url	string	The Comments URL for this repository
Template Repository Commits Url	template_repository.commits_url	string	The Commits URL for this repository
Template Repository Compare Url	template_repository.compare_url	string	The Compare URL for this repository
Template Repository Contents Url	template_repository.contents_url	string	The Contents URL for this repository
Template Repository Contributors Url	template_repository.contributors_url	uri	The Contributors URL for this repository
Template Repository Deployments Url	template_repository.deployments_url	uri	The Deployments URL for this repository
Template Repository Downloads Url	template_repository.downloads_url	uri	The Downloads URL for this repository
Template Repository Events Url	template_repository.events_url	uri	The Events URL for this repository
Template Repository Forks Url	template_repository.forks_url	uri	The Forks URL for this repository
Template Repository Git Commits Url	template_repository.git_commits_url	string	The Git Commits URL for this repository
Template Repository Git References Url	template_repository.git_refs_url	string	The Git References URL for this repository
Template Repository Git Tags Url	template_repository.git_tags_url	string	The Git Tags URL for this repository
Template Repository Git Url	template_repository.git_url	string	The Git URL for this repository
Template Repository Issue Comment Url	template_repository.issue_comment_url	string	The issue comment URL for this repository
Template Repository Issue Events Url	template_repository.issue_events_url	string	The issue events URL for this repository
Template Repository Issues Url	template_repository.issues_url	string	The issues URL for this repository
Template Repository Keys Url	template_repository.keys_url	string	The keys URL for this repository
Template Repository Labels Url	template_repository.labels_url	string	The labels URL for this repository
Template Repository Languages Url	template_repository.languages_url	uri	The languages URL for this repository
Template Repository Merges Url	template_repository.merges_url	uri	The merges URL for this repository
Template Repository Milestones Url	template_repository.milestones_url	string	The milestones URL for this repository
Template Repository Notifications Url	template_repository.notifications_url	string	The notifications URL for this repository
Template Repository Pulls Url	template_repository.pulls_url	string	The pulls URL for this repository
Template Repository Releases Url	template_repository.releases_url	string	The releases URL for this repository
Template Repository SSH Url	template_repository.ssh_url	string	The SSH URL to clone this repository
Template Repository Stargazers Url	template_repository.stargazers_url	uri	The stargazers (Stargazers are the people that have bookmarked the GitHub repository) URL for this repository
Template Repository Statuses Url	template_repository.statuses_url	string	The statuses URL for this repository
Template Repository Subscribers Url	template_repository.subscribers_url	uri	The subscribers URL for this repository
Template Repository Subscription Url	template_repository.subscription_url	uri	The subscription URL for this repository
Template Repository Tags Url	template_repository.tags_url	uri	The tags URL for this repository
Template Repository Teams Url	template_repository.teams_url	uri	The teams URL for this repository
Template Repository Trees Url	template_repository.trees_url	string	The trees URL for this repository
Template Repository Clone Url	template_repository.clone_url	string	The clone URL for this repository
Template Repository Mirror Url	template_repository.mirror_url	uri	The original mirror URL for this repository
Template Repository Hooks Url	template_repository.hooks_url	uri	The hooks URL for this repository
Template Repository SVN Url	template_repository.svn_url	uri	The SVN URL for this repository
Template Repository Homepage	template_repository.homepage	uri	The homepage for this repository
Template Repository Language	template_repository.language	string	The language for this repository
Template Repository Forks Count	template_repository.forks_count	integer	Number of forks there are of this repository in the whole network.
Template Repository Stargazers Count	template_repository.stargazers_count	integer	Number of users who have starred the repository.
Template Repository Watchers Count	template_repository.watchers_count	integer	Number of users watching the repository.
Template Repository Size	template_repository.size	integer	Size of the repository
Template Repository Default Branch	template_repository.default_branch	string	The default branch of the repository.
Template Repository Open Issues Count	template_repository.open_issues_count	integer	Number of open issues in the repository.
Is Template Repository a Template?	template_repository.is_template	boolean	Whether this repository acts as a template that can be used to generate new repositories.
Template Repository Topics	template_repository.topics	array of string	List of topics in the repository
Template Repository Has Issues?	template_repository.has_issues	boolean	Whether issues are enabled.
Template Repository Has Projects?	template_repository.has_projects	boolean	Whether projects are enabled.
Template Repository Has Wiki?	template_repository.has_wiki	boolean	Whether the wiki is enabled.
Template Repository Has Pages?	template_repository.has_pages	boolean	Whether pages are enabled.
Template Repository Has Downloads?	template_repository.has_downloads	boolean	Whether downloads are enabled.
Is Template Repository Archived?	template_repository.archived	boolean	Whether the repository is archived.
Is Template Repository Disabled?	template_repository.disabled	boolean	Returns whether or not this repository disabled.
Template Repository Visibility	template_repository.visibility	string	The repository visibility: public, private, or internal.
Template Repository Pushed At	template_repository.pushed_at	date-time	When the repository was last pushed to.
Template Repository Created At	template_repository.created_at	date-time	the date and time when the repository was created.
Template Repository Updated At	template_repository.updated_at	date-time	the date and time when the repository was last updated.
admin	template_repository.permissions.admin	boolean
push	template_repository.permissions.push	boolean
pull	template_repository.permissions.pull	boolean
Template Repository Allow Rebase Merge	template_repository.allow_rebase_merge	boolean	Whether to allow rebase merges for pull requests.
Template Repository of Template Repository	template_repository.template_repository	string	Template repository.
Template Repository Temp Clone Token	template_repository.temp_clone_token	string	Temporary authentication token for cloning this repository.
Template Repository Allow Squash Merge	template_repository.allow_squash_merge	boolean	Whether to allow squash merges for pull requests.
Template Repository Delete Branch On Merge	template_repository.delete_branch_on_merge	boolean	Whether to delete head branches when pull requests are merged
Template Repository Allow Merge Commit	template_repository.allow_merge_commit	boolean	Whether to allow merge commits for pull requests.
Template Repository Subscribers Count	template_repository.subscribers_count	integer	Number of subscribers for the repository.
Template Repository Network Count	template_repository.network_count	integer	Repository Network Count
Temp Clone Token	temp_clone_token	string	Temporary authentication token for cloning this repository.
Allow Squash Merge	allow_squash_merge	boolean	Whether to allow squash merges for pull requests.
Delete Branch On Merge	delete_branch_on_merge	boolean	Whether to delete head branches when pull requests are merged
Allow Merge Commit	allow_merge_commit	boolean	Whether to allow merge commits for pull requests.
Subscribers Count	subscribers_count	integer	Number of subscribers for the repository.
Network Count	network_count	integer	Repository Network Count
Open Issues	open_issues	integer	Repository open issues.
Watchers	watchers	integer	Repository Watchers.
Master Branch	master_branch	string	Repository master branch.
Starred At	starred_at	string	Repository Starred At

GitReference

Git references within a repository

Name	Path	Type	Description
Reference	ref	string	The name of the fully qualified reference.
Node Id	node_id	string	The Node Id of the reference.
Url	url	uri	The url of the reference.
type	object.type	string	The type of the object.
Sha	object.sha	string	The SHA for the reference.
Url	object.url	uri	The url of the object.

PullRequestMergeResult

Pull Request Merge Result.

Name	Path	Type	Description
Sha	sha	string	SHA for the merge commit.
Is Merged?	merged	boolean	Whether or not the pull request was merged.
Message	message	string	Merge response message.

Milestone

A collection of related issues and pull requests.

Name	Path	Type	Description
Milestone Url	url	uri	The HTTP URL for the milestone.
Milestone Html Url	html_url	uri	The HTML URL for the milestone.
Milestone Labels Url	labels_url	uri	The labels URL for the milestone.
Milestone Id	id	integer	The Unique Identifier for the milestone.
Milestone Node Id	node_id	string	The Node ID for the milestone.
Milestone Number	number	integer	The number of the milestone.
Milestone State	state	string	The state of the milestone.
Milestone Title	title	string	The title of the milestone.
Milestone Description	description	string	The description of the milestone.
creator	creator	UserDetailsModel	Properties of a GitHub user.
Milestone Open Issues	open_issues	integer	Number of open issues for the repository.
Milestone Closed Issues	closed_issues	integer	Number of closed issues for the repository.
Milestone Created At	created_at	date-time	The date and time when the milestone was created.
Milestone Updated At	updated_at	date-time	The date and time when the milestone was last updated.
Milestone Closed At	closed_at	date-time	The date and time when the milestone was closed.
Milestone Due On	due_on	date-time	The due date of the milestone.

Label

Color-coded labels help you categorize and filter your issues (just like labels in Gmail).

Name	Path	Type	Description
Id	id	integer	The Unique Identifier for the label.
Node Id	node_id	string	The Node ID for the label.
Url	url	uri	URL for the label
Name	name	string	The name of the label.
Description	description	string	A brief description of this label.
Color	color	string	6-character hex code, without the leading #, identifying the color
Is Default?	default	boolean	Whether or not this is a default label.

TeamDetails

Groups of organization members that gives permissions on specified repositories.

Name	Path	Type	Description
Id	id	integer	Unique identifier of the team.
Node Id	node_id	string	The Node ID for the team.
Url	url	uri	URL for the team.
Members Url	members_url	string	The HTTP URL for the team members.
	name	string	Name of the team
Description	description	string	Description of the team
Permission	permission	string	Permission that the team will have for its repositories
Privacy	privacy	string	The level of privacy this team should have
HTML Url	html_url	uri	HTML Url of the team.
Repositories Url	repositories_url	uri	The HTTP URL for this team's repositories.
Slug	slug	string	The slug corresponding to the team.
LDAP DN	ldap_dn	string	Distinguished Name (DN) that team maps to within LDAP environment

PullRequest

Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.

Name	Path	Type	Description
Pull Request Url	url	uri	The HTTP URL for this pull request.
Pull Request Id	id	integer	The Unique Identifier for the pull request.
Pull Request Node Id	node_id	string	The Node ID for the pull request.
Pull Request Html Url	html_url	uri	The HTML URL for the pull request.
Pull Request Diff Url	diff_url	uri	The Diff URL for the pull request.
Pull Request Patch Url	patch_url	uri	The patch URL for the pull request.
Pull Request Issue Url	issue_url	uri	The issue URL for the pull request.
Pull Request Commit Url	commits_url	uri	The commit URL for the pull request.
Pull Request Review Comments Url	review_comments_url	uri	The review comments URL for the pull request.
Pull Request Review Comment Url	review_comment_url	string	The review comment URL for the pull request.
Pull Request Diff Url	comments_url	uri	The Diff URL for the pull request.
Pull Request Statuses Url	statuses_url	uri	The statuses URL for the pull request.
Pull Request Number	number	integer	Number uniquely identifying the pull request within its repository.
Pull Request State	state	string	State of this Pull Request. Either open or closed.
Is Pull Request Locked?	locked	boolean	Whether the pull request is locked or not.
Pull Request Title	title	string	The title of the pull request.
user	user	UserDetailsModel	Properties of a GitHub user.
Pull Request Body	body	string	The body as Markdown.
Pull Request Labels	labels	array of Label	The list of labels associated with the pull request.
	milestone	Milestone	A collection of related issues and pull requests.
Pull Request Active Lock Reason	active_lock_reason	string	Reason that the conversation was locked.
Pull Request Created At	created_at	date-time	The date and time when the pull request was created.
Pull Request Updated At	updated_at	date-time	The date and time when the pull request was last updated.
Pull Request Closed At	closed_at	date-time	The date and time when the pull request was closed.
Pull Request Merged At	merged_at	date-time	The date and time that the pull request was merged.
Pull Request Merge Commit Sha	merge_commit_sha	string	The merge commit Sha of the pull request.
assignee	assignee	UserDetailsModel	Properties of a GitHub user.
Pull Request Assignees	assignees	array of UserDetailsModel	The list of assignees for the pull request.
Pull Request Requested Reviewers	requested_reviewers	array of UserDetailsModel	The list of Users assigned to this pull request.
Pull Request Requested Teams	requested_teams	array of TeamDetails	The list of requested teams to this pull request.
Pull Request Head Label	head.label	string	Head label.
Pull Request Head Reference	head.ref	string	Head Reference
repo	head.repo	RepositoryMiniDetails	A git repository
Pull Request Head Sha	head.sha	string	Head Sha
user	head.user	UserDetailsModel	Properties of a GitHub user.
Pull Request Base Label	base.label	string	Head label.
Pull Request Base Reference	base.ref	string	Head Reference
repo	base.repo	RepositoryMiniDetails	A git repository
Pull Request Base Sha	base.sha	string	Head Sha
user	base.user	UserDetailsModel	Properties of a GitHub user.
Pull RequestAuthor Association	author_association	string	Author's association with the subject of the comment.
Is Pull Request Draft?	draft	boolean	Indicates whether or not the pull request is a draft.
Is Pull Request Merged?	merged	boolean	Whether or not the pull request was merged.
Is Pull Request Mergeable?	mergeable	boolean	Whether or not the pull request can be merged based on the existence of merge conflicts.
Is Pull Request Rebaseable?	rebaseable	boolean	Whether or not the pull request is rebaseable.
Pull Request Mergeable State	mergeable_state	string	The mergeable state of the pull request.
merged_by	merged_by	UserDetailsModel	Properties of a GitHub user.
Pull Request Comments Count	comments	integer	The number of comments in this pull request.
Pull Request Review Comments Count	review_comments	integer	The number of review comments in this pull request.
Can Maintainer Modify Pull Request?	maintainer_can_modify	boolean	Indicates whether maintainers can modify the pull request.
Pull Request Commits Count	commits	integer	The number of commits in this pull request.
Pull Request Additions Count	additions	integer	The number of additions in this pull request.
Pull Request Deletions Count	deletions	integer	The number of deletions in this pull request.
Pull Request Changed Files Count	changed_files	integer	The number of changed files in this pull request.

PullRequestFile

Name	Path	Type	Description
sha for the file	sha	string	The sha for the file.
The file name	filename	string	The file name.
Modification status for the file	status	string	The modification status for the file.
Number of additions made to the file	additions	integer	The number of additions made to the file.
Number of deletions made to the file	deletions	integer	The number of deletions made to the file.
Number of changes made to the file	changes	integer	The number of changes made to the file.
Blob Url for the file	blob_url	string	The blob Url for the file.
Raw Url for the file	raw_url	string	The Raw Url for the file.
Contents Url for the file	contents_url	string	The contents Url for the file.
Patch content for the file	patch	string	The patch content for the file.

WebhookPullRequestResponse

Webhook pull request response.

Name	Path	Type	Description
Action Performed	action	string	The action that was performed.
Pull Request Number	number	integer	The pull request number.
pull_request	pull_request	PullRequest	Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.

object

This is the type 'object'.