This page was generated based on Github’s Documentation. See our welcome page for context and details.

Github Event `pull_request_review_comment` #

Github Action Trigger #

Webhook event payload	Activity types	`GITHUB_SHA`	`GITHUB_REF`
`pull_request_review_comment`	- `created` - `edited` - `deleted`	Last merge commit on the `GITHUB_REF` branch	PR merge branch `refs/pull/PULL_REQUEST_NUMBER/merge`

Note: More than one activity type triggers this event. For information about each activity type, see “Webhook events and payloads.” By default, all activity types trigger workflows that run on this event. You can limit your workflow runs to specific activity types using the types keyword. For more information, see “Workflow syntax for GitHub Actions.”

Runs your workflow when a pull request review comment is modified. A pull request review comment is a comment on a pull request’s diff. For activity related to pull request reviews or pull request comments, use the pull_request_review or issue_comment events instead. For information about the pull request review comment APIs, see “Objects” in the GraphQL API documentation or “Pulls” in the REST API documentation.

For example, you can run a workflow when a pull request review comment has been created or deleted.

on:
  pull_request_review_comment:
    types: [created, deleted]

Workflows in forked repositories #

Workflows don’t run in forked repositories by default. You must enable GitHub Actions in the Actions tab of the forked repository.

With the exception of GITHUB_TOKEN, secrets are not passed to the runner when a workflow is triggered from a forked repository. The GITHUB_TOKEN has read-only permissions in pull requests from forked repositories. For more information, see “Automatic token authentication.”

Pull request events for forked repositories #

For pull requests from a forked repository to the base repository, GitHub sends the pull_request, issue_comment, pull_request_review_comment, pull_request_review, and pull_request_target events to the base repository. No pull request events occur on the forked repository.

When a first-time contributor submits a pull request to a public repository, a maintainer with write access may need to approve running workflows on the pull request. For more information, see “Approving workflow runs from public forks.”

For pull requests from a forked repository to a private repository, workflows only run when they are enabled, see “Managing GitHub Actions settings for a repository.”

Note: Workflows triggered by Dependabot pull requests are treated as though they are from a forked repository, and are also subject to these restrictions.

Event Payload #

source

Activities: created, deleted, edited

Common Fields #

These fields are common to every event types available with this trigger.

field	type	required	description
`github.event.comment`	object	required	The comment itself.
`github.event.comment._links`	object	required
`github.event.comment._links.html`	object	required
`github.event.comment._links.html.href`	string	required
`github.event.comment._links.pull_request`	object	required
`github.event.comment._links.pull_request.href`	string	required
`github.event.comment._links.self`	object	required
`github.event.comment._links.self.href`	string	required
`github.event.comment.author_association`	`COLLABORATOR`, `CONTRIBUTOR`, `FIRST_TIMER`, `FIRST_TIME_CONTRIBUTOR`, `MANNEQUIN`, `MEMBER`, `NONE`, `OWNER`	required	How the author is associated with the repository.
`github.event.comment.body`	string	required	The text of the comment.
`github.event.comment.commit_id`	string	required	The SHA of the commit to which the comment applies.
`github.event.comment.created_at`	string	required
`github.event.comment.diff_hunk`	string	required	The diff of the line that the comment refers to.
`github.event.comment.html_url`	string	required	HTML URL for the pull request review comment.
`github.event.comment.id`	integer	required	The ID of the pull request review comment.
`github.event.comment.in_reply_to_id`	integer	optional	The comment ID to reply to.
`github.event.comment.line`	integer or null	required	The line of the blob to which the comment applies. The last line of the range for a multi-line comment
`github.event.comment.node_id`	string	required	The node ID of the pull request review comment.
`github.event.comment.original_commit_id`	string	required	The SHA of the original commit to which the comment applies.
`github.event.comment.original_position`	integer	required	The index of the original line in the diff to which the comment applies.
`github.event.comment.original_start_line`	integer or null	required	The first line of the range for a multi-line comment.
`github.event.comment.path`	string	required	The relative path of the file to which the comment applies.
`github.event.comment.position`	integer or null	required	The line index in the diff to which the comment applies.
`github.event.comment.pull_request_review_id`	integer or null	required	The ID of the pull request review to which the comment belongs.
`github.event.comment.pull_request_url`	string	required	URL for the pull request that the review comment belongs to.
`github.event.comment.reactions`	object	required
`github.event.comment.reactions.+1`	integer	required
`github.event.comment.reactions.-1`	integer	required
`github.event.comment.reactions.confused`	integer	required
`github.event.comment.reactions.eyes`	integer	required
`github.event.comment.reactions.heart`	integer	required
`github.event.comment.reactions.hooray`	integer	required
`github.event.comment.reactions.laugh`	integer	required
`github.event.comment.reactions.rocket`	integer	required
`github.event.comment.reactions.total_count`	integer	required
`github.event.comment.reactions.url`	string	required
`github.event.comment.side`	`LEFT`, `RIGHT`	required	The side of the first line of the range for a multi-line comment.
`github.event.comment.start_line`	integer or null	required	The first line of the range for a multi-line comment.
`github.event.comment.start_side`	`LEFT`, `RIGHT`, `None`	required	The side of the first line of the range for a multi-line comment.
`github.event.comment.subject_type`	`line`, `file`	optional	The level at which the comment is targeted, can be a diff line or a file.
`github.event.comment.updated_at`	string	required
`github.event.comment.url`	string	required	URL for the pull request review comment
`github.event.comment.user`	object or null	required
`github.event.comment.user.avatar_url`	string	optional
`github.event.comment.user.deleted`	boolean	optional
`github.event.comment.user.email`	string or null	optional
`github.event.comment.user.events_url`	string	optional
`github.event.comment.user.followers_url`	string	optional
`github.event.comment.user.following_url`	string	optional
`github.event.comment.user.gists_url`	string	optional
`github.event.comment.user.gravatar_id`	string	optional
`github.event.comment.user.html_url`	string	optional
`github.event.comment.user.id`	integer	required
`github.event.comment.user.login`	string	required
`github.event.comment.user.name`	string	optional
`github.event.comment.user.node_id`	string	optional
`github.event.comment.user.organizations_url`	string	optional
`github.event.comment.user.received_events_url`	string	optional
`github.event.comment.user.repos_url`	string	optional
`github.event.comment.user.site_admin`	boolean	optional
`github.event.comment.user.starred_url`	string	optional
`github.event.comment.user.subscriptions_url`	string	optional
`github.event.comment.user.type`	`Bot`, `User`, `Organization`	optional
`github.event.comment.user.url`	string	optional
`github.event.enterprise`	object	optional	An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured on an enterprise account or an organization that’s part of an enterprise account. For more information, see “About enterprise accounts."
`github.event.installation`	object	optional	The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App. For more information, see “Using webhooks with GitHub Apps."
`github.event.organization`	object	optional	A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.
`github.event.pull_request`	object	required
`github.event.pull_request._links`	object	required
`github.event.pull_request._links.comments`	object	required
`github.event.pull_request._links.comments.href`	string	required
`github.event.pull_request._links.commits`	object	required
`github.event.pull_request._links.commits.href`	string	required
`github.event.pull_request._links.html`	object	required
`github.event.pull_request._links.html.href`	string	required
`github.event.pull_request._links.issue`	object	required
`github.event.pull_request._links.issue.href`	string	required
`github.event.pull_request._links.review_comment`	object	required
`github.event.pull_request._links.review_comment.href`	string	required
`github.event.pull_request._links.review_comments`	object	required
`github.event.pull_request._links.review_comments.href`	string	required
`github.event.pull_request._links.self`	object	required
`github.event.pull_request._links.self.href`	string	required
`github.event.pull_request._links.statuses`	object	required
`github.event.pull_request._links.statuses.href`	string	required
`github.event.pull_request.active_lock_reason`	`resolved`, `off-topic`, `too heated`, `spam`, `None`	required
`github.event.pull_request.assignee`	object or null	required
`github.event.pull_request.assignee.avatar_url`	string	optional
`github.event.pull_request.assignee.deleted`	boolean	optional
`github.event.pull_request.assignee.email`	string or null	optional
`github.event.pull_request.assignee.events_url`	string	optional
`github.event.pull_request.assignee.followers_url`	string	optional
`github.event.pull_request.assignee.following_url`	string	optional
`github.event.pull_request.assignee.gists_url`	string	optional
`github.event.pull_request.assignee.gravatar_id`	string	optional
`github.event.pull_request.assignee.html_url`	string	optional
`github.event.pull_request.assignee.id`	integer	required
`github.event.pull_request.assignee.login`	string	required
`github.event.pull_request.assignee.name`	string	optional
`github.event.pull_request.assignee.node_id`	string	optional
`github.event.pull_request.assignee.organizations_url`	string	optional
`github.event.pull_request.assignee.received_events_url`	string	optional
`github.event.pull_request.assignee.repos_url`	string	optional
`github.event.pull_request.assignee.site_admin`	boolean	optional
`github.event.pull_request.assignee.starred_url`	string	optional
`github.event.pull_request.assignee.subscriptions_url`	string	optional
`github.event.pull_request.assignee.url`	string	optional
`github.event.pull_request.assignees`	array of object,nulls	required
`github.event.pull_request.author_association`	`COLLABORATOR`, `CONTRIBUTOR`, `FIRST_TIMER`, `FIRST_TIME_CONTRIBUTOR`, `MANNEQUIN`, `MEMBER`, `NONE`, `OWNER`	required	How the author is associated with the repository.
`github.event.pull_request.auto_merge`	object or null	optional	The status of auto merging a pull request.
`github.event.pull_request.auto_merge.commit_message`	string or null	required	Commit message for the merge commit.
`github.event.pull_request.auto_merge.commit_title`	string or null	required	Title for the merge commit message.
`github.event.pull_request.auto_merge.enabled_by`	object or null	required
`github.event.pull_request.auto_merge.enabled_by.avatar_url`	string	optional
`github.event.pull_request.auto_merge.enabled_by.deleted`	boolean	optional
`github.event.pull_request.auto_merge.enabled_by.email`	string or null	optional
`github.event.pull_request.auto_merge.enabled_by.events_url`	string	optional
`github.event.pull_request.auto_merge.enabled_by.followers_url`	string	optional
`github.event.pull_request.auto_merge.enabled_by.following_url`	string	optional
`github.event.pull_request.auto_merge.enabled_by.gists_url`	string	optional
`github.event.pull_request.auto_merge.enabled_by.gravatar_id`	string	optional
`github.event.pull_request.auto_merge.enabled_by.html_url`	string	optional
`github.event.pull_request.auto_merge.enabled_by.id`	integer	required
`github.event.pull_request.auto_merge.enabled_by.login`	string	required
`github.event.pull_request.auto_merge.enabled_by.name`	string	optional
`github.event.pull_request.auto_merge.enabled_by.node_id`	string	optional
`github.event.pull_request.auto_merge.enabled_by.organizations_url`	string	optional
`github.event.pull_request.auto_merge.enabled_by.received_events_url`	string	optional
`github.event.pull_request.auto_merge.enabled_by.repos_url`	string	optional
`github.event.pull_request.auto_merge.enabled_by.site_admin`	boolean	optional
`github.event.pull_request.auto_merge.enabled_by.starred_url`	string	optional
`github.event.pull_request.auto_merge.enabled_by.subscriptions_url`	string	optional
`github.event.pull_request.auto_merge.enabled_by.type`	`Bot`, `User`, `Organization`	optional
`github.event.pull_request.auto_merge.enabled_by.url`	string	optional
`github.event.pull_request.auto_merge.merge_method`	`merge`, `squash`, `rebase`	required	The merge method to use.
`github.event.pull_request.base`	object	required
`github.event.pull_request.base.label`	string	required
`github.event.pull_request.base.ref`	string	required
`github.event.pull_request.base.repo`	object	required	A git repository
`github.event.pull_request.base.repo.allow_auto_merge`	boolean	optional	Whether to allow auto-merge for pull requests.
`github.event.pull_request.base.repo.allow_forking`	boolean	optional	Whether to allow private forks
`github.event.pull_request.base.repo.allow_merge_commit`	boolean	optional	Whether to allow merge commits for pull requests.
`github.event.pull_request.base.repo.allow_rebase_merge`	boolean	optional	Whether to allow rebase merges for pull requests.
`github.event.pull_request.base.repo.allow_squash_merge`	boolean	optional	Whether to allow squash merges for pull requests.
`github.event.pull_request.base.repo.allow_update_branch`	boolean	optional
`github.event.pull_request.base.repo.archive_url`	string	required
`github.event.pull_request.base.repo.archived`	boolean	required	Whether the repository is archived.
`github.event.pull_request.base.repo.assignees_url`	string	required
`github.event.pull_request.base.repo.blobs_url`	string	required
`github.event.pull_request.base.repo.branches_url`	string	required
`github.event.pull_request.base.repo.clone_url`	string	required
`github.event.pull_request.base.repo.collaborators_url`	string	required
`github.event.pull_request.base.repo.comments_url`	string	required
`github.event.pull_request.base.repo.commits_url`	string	required
`github.event.pull_request.base.repo.compare_url`	string	required
`github.event.pull_request.base.repo.contents_url`	string	required
`github.event.pull_request.base.repo.contributors_url`	string	required
`github.event.pull_request.base.repo.created_at`	integer or string	required
`github.event.pull_request.base.repo.default_branch`	string	required	The default branch of the repository.
`github.event.pull_request.base.repo.delete_branch_on_merge`	boolean	optional	Whether to delete head branches when pull requests are merged
`github.event.pull_request.base.repo.deployments_url`	string	required
`github.event.pull_request.base.repo.description`	string or null	required
`github.event.pull_request.base.repo.disabled`	boolean	optional	Returns whether or not this repository is disabled.
`github.event.pull_request.base.repo.downloads_url`	string	required
`github.event.pull_request.base.repo.events_url`	string	required
`github.event.pull_request.base.repo.fork`	boolean	required
`github.event.pull_request.base.repo.forks`	integer	required
`github.event.pull_request.base.repo.forks_count`	integer	required
`github.event.pull_request.base.repo.forks_url`	string	required
`github.event.pull_request.base.repo.full_name`	string	required
`github.event.pull_request.base.repo.git_commits_url`	string	required
`github.event.pull_request.base.repo.git_refs_url`	string	required
`github.event.pull_request.base.repo.git_tags_url`	string	required
`github.event.pull_request.base.repo.git_url`	string	required
`github.event.pull_request.base.repo.has_downloads`	boolean	required	Whether downloads are enabled.
`github.event.pull_request.base.repo.has_issues`	boolean	required	Whether issues are enabled.
`github.event.pull_request.base.repo.has_pages`	boolean	required
`github.event.pull_request.base.repo.has_projects`	boolean	required	Whether projects are enabled.
`github.event.pull_request.base.repo.has_wiki`	boolean	required	Whether the wiki is enabled.
`github.event.pull_request.base.repo.has_discussions`	boolean	required	Whether discussions are enabled.
`github.event.pull_request.base.repo.homepage`	string or null	required
`github.event.pull_request.base.repo.hooks_url`	string	required
`github.event.pull_request.base.repo.html_url`	string	required
`github.event.pull_request.base.repo.id`	integer	required	Unique identifier of the repository
`github.event.pull_request.base.repo.is_template`	boolean	optional
`github.event.pull_request.base.repo.issue_comment_url`	string	required
`github.event.pull_request.base.repo.issue_events_url`	string	required
`github.event.pull_request.base.repo.issues_url`	string	required
`github.event.pull_request.base.repo.keys_url`	string	required
`github.event.pull_request.base.repo.labels_url`	string	required
`github.event.pull_request.base.repo.language`	string or null	required
`github.event.pull_request.base.repo.languages_url`	string	required
`github.event.pull_request.base.repo.license`	object or null	required
`github.event.pull_request.base.repo.license.key`	string	required
`github.event.pull_request.base.repo.license.name`	string	required
`github.event.pull_request.base.repo.license.node_id`	string	required
`github.event.pull_request.base.repo.license.spdx_id`	string	required
`github.event.pull_request.base.repo.license.url`	string or null	required
`github.event.pull_request.base.repo.master_branch`	string	optional
`github.event.pull_request.base.repo.merge_commit_message`	`PR_BODY`, `PR_TITLE`, `BLANK`	optional	The default value for a merge commit message. `PR_TITLE` - default to the pull request’s title. `PR_BODY` - default to the pull request’s body. `BLANK` - default to a blank commit message.
`github.event.pull_request.base.repo.merge_commit_title`	`PR_TITLE`, `MERGE_MESSAGE`	optional	The default value for a merge commit title. `PR_TITLE` - default to the pull request’s title. `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
`github.event.pull_request.base.repo.merges_url`	string	required
`github.event.pull_request.base.repo.milestones_url`	string	required
`github.event.pull_request.base.repo.mirror_url`	string or null	required
`github.event.pull_request.base.repo.name`	string	required	The name of the repository.
`github.event.pull_request.base.repo.node_id`	string	required
`github.event.pull_request.base.repo.notifications_url`	string	required
`github.event.pull_request.base.repo.open_issues`	integer	required
`github.event.pull_request.base.repo.open_issues_count`	integer	required
`github.event.pull_request.base.repo.organization`	string	optional
`github.event.pull_request.base.repo.owner`	object or null	required
`github.event.pull_request.base.repo.owner.avatar_url`	string	optional
`github.event.pull_request.base.repo.owner.deleted`	boolean	optional
`github.event.pull_request.base.repo.owner.email`	string or null	optional
`github.event.pull_request.base.repo.owner.events_url`	string	optional
`github.event.pull_request.base.repo.owner.followers_url`	string	optional
`github.event.pull_request.base.repo.owner.following_url`	string	optional
`github.event.pull_request.base.repo.owner.gists_url`	string	optional
`github.event.pull_request.base.repo.owner.gravatar_id`	string	optional
`github.event.pull_request.base.repo.owner.html_url`	string	optional
`github.event.pull_request.base.repo.owner.id`	integer	required
`github.event.pull_request.base.repo.owner.login`	string	required
`github.event.pull_request.base.repo.owner.name`	string	optional
`github.event.pull_request.base.repo.owner.node_id`	string	optional
`github.event.pull_request.base.repo.owner.organizations_url`	string	optional
`github.event.pull_request.base.repo.owner.received_events_url`	string	optional
`github.event.pull_request.base.repo.owner.repos_url`	string	optional
`github.event.pull_request.base.repo.owner.site_admin`	boolean	optional
`github.event.pull_request.base.repo.owner.starred_url`	string	optional
`github.event.pull_request.base.repo.owner.subscriptions_url`	string	optional
`github.event.pull_request.base.repo.owner.type`	`Bot`, `User`, `Organization`	optional
`github.event.pull_request.base.repo.owner.url`	string	optional
`github.event.pull_request.base.repo.permissions`	object	optional
`github.event.pull_request.base.repo.permissions.admin`	boolean	required
`github.event.pull_request.base.repo.permissions.maintain`	boolean	optional
`github.event.pull_request.base.repo.permissions.pull`	boolean	required
`github.event.pull_request.base.repo.permissions.push`	boolean	required
`github.event.pull_request.base.repo.permissions.triage`	boolean	optional
`github.event.pull_request.base.repo.private`	boolean	required	Whether the repository is private or public.
`github.event.pull_request.base.repo.public`	boolean	optional
`github.event.pull_request.base.repo.pulls_url`	string	required
`github.event.pull_request.base.repo.pushed_at`	null or integer or string	required
`github.event.pull_request.base.repo.releases_url`	string	required
`github.event.pull_request.base.repo.role_name`	string or null	optional
`github.event.pull_request.base.repo.size`	integer	required
`github.event.pull_request.base.repo.squash_merge_commit_message`	`PR_BODY`, `COMMIT_MESSAGES`, `BLANK`	optional	The default value for a squash merge commit message: `PR_BODY` - default to the pull request’s body. `COMMIT_MESSAGES` - default to the branch’s commit messages. `BLANK` - default to a blank commit message.
`github.event.pull_request.base.repo.squash_merge_commit_title`	`PR_TITLE`, `COMMIT_OR_PR_TITLE`	optional	The default value for a squash merge commit title: `PR_TITLE` - default to the pull request’s title. `COMMIT_OR_PR_TITLE` - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
`github.event.pull_request.base.repo.ssh_url`	string	required
`github.event.pull_request.base.repo.stargazers`	integer	optional
`github.event.pull_request.base.repo.stargazers_count`	integer	required
`github.event.pull_request.base.repo.stargazers_url`	string	required
`github.event.pull_request.base.repo.statuses_url`	string	required
`github.event.pull_request.base.repo.subscribers_url`	string	required
`github.event.pull_request.base.repo.subscription_url`	string	required
`github.event.pull_request.base.repo.svn_url`	string	required
`github.event.pull_request.base.repo.tags_url`	string	required
`github.event.pull_request.base.repo.teams_url`	string	required
`github.event.pull_request.base.repo.topics`	array of strings	required
`github.event.pull_request.base.repo.trees_url`	string	required
`github.event.pull_request.base.repo.updated_at`	string	required
`github.event.pull_request.base.repo.url`	string	required
`github.event.pull_request.base.repo.use_squash_pr_title_as_default`	boolean	optional	Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
`github.event.pull_request.base.repo.visibility`	`public`, `private`, `internal`	required
`github.event.pull_request.base.repo.watchers`	integer	required
`github.event.pull_request.base.repo.watchers_count`	integer	required
`github.event.pull_request.base.repo.web_commit_signoff_required`	boolean	optional	Whether to require contributors to sign off on web-based commits
`github.event.pull_request.base.sha`	string	required
`github.event.pull_request.base.user`	object or null	required
`github.event.pull_request.base.user.avatar_url`	string	optional
`github.event.pull_request.base.user.deleted`	boolean	optional
`github.event.pull_request.base.user.email`	string or null	optional
`github.event.pull_request.base.user.events_url`	string	optional
`github.event.pull_request.base.user.followers_url`	string	optional
`github.event.pull_request.base.user.following_url`	string	optional
`github.event.pull_request.base.user.gists_url`	string	optional
`github.event.pull_request.base.user.gravatar_id`	string	optional
`github.event.pull_request.base.user.html_url`	string	optional
`github.event.pull_request.base.user.id`	integer	required
`github.event.pull_request.base.user.login`	string	required
`github.event.pull_request.base.user.name`	string	optional
`github.event.pull_request.base.user.node_id`	string	optional
`github.event.pull_request.base.user.organizations_url`	string	optional
`github.event.pull_request.base.user.received_events_url`	string	optional
`github.event.pull_request.base.user.repos_url`	string	optional
`github.event.pull_request.base.user.site_admin`	boolean	optional
`github.event.pull_request.base.user.starred_url`	string	optional
`github.event.pull_request.base.user.subscriptions_url`	string	optional
`github.event.pull_request.base.user.type`	`Bot`, `User`, `Organization`	optional
`github.event.pull_request.base.user.url`	string	optional
`github.event.pull_request.body`	string or null	required
`github.event.pull_request.closed_at`	string or null	required
`github.event.pull_request.comments_url`	string	required
`github.event.pull_request.commits_url`	string	required
`github.event.pull_request.created_at`	string	required
`github.event.pull_request.diff_url`	string	required
`github.event.pull_request.draft`	boolean	optional
`github.event.pull_request.head`	object	required
`github.event.pull_request.head.label`	string	required
`github.event.pull_request.head.ref`	string	required
`github.event.pull_request.head.repo`	object or null	required	A git repository
`github.event.pull_request.head.repo.allow_auto_merge`	boolean	optional	Whether to allow auto-merge for pull requests.
`github.event.pull_request.head.repo.allow_forking`	boolean	optional	Whether to allow private forks
`github.event.pull_request.head.repo.allow_merge_commit`	boolean	optional	Whether to allow merge commits for pull requests.
`github.event.pull_request.head.repo.allow_rebase_merge`	boolean	optional	Whether to allow rebase merges for pull requests.
`github.event.pull_request.head.repo.allow_squash_merge`	boolean	optional	Whether to allow squash merges for pull requests.
`github.event.pull_request.head.repo.allow_update_branch`	boolean	optional
`github.event.pull_request.head.repo.archive_url`	string	required
`github.event.pull_request.head.repo.archived`	boolean	required	Whether the repository is archived.
`github.event.pull_request.head.repo.assignees_url`	string	required
`github.event.pull_request.head.repo.blobs_url`	string	required
`github.event.pull_request.head.repo.branches_url`	string	required
`github.event.pull_request.head.repo.clone_url`	string	required
`github.event.pull_request.head.repo.collaborators_url`	string	required
`github.event.pull_request.head.repo.comments_url`	string	required
`github.event.pull_request.head.repo.commits_url`	string	required
`github.event.pull_request.head.repo.compare_url`	string	required
`github.event.pull_request.head.repo.contents_url`	string	required
`github.event.pull_request.head.repo.contributors_url`	string	required
`github.event.pull_request.head.repo.created_at`	integer or string	required
`github.event.pull_request.head.repo.default_branch`	string	required	The default branch of the repository.
`github.event.pull_request.head.repo.delete_branch_on_merge`	boolean	optional	Whether to delete head branches when pull requests are merged
`github.event.pull_request.head.repo.deployments_url`	string	required
`github.event.pull_request.head.repo.description`	string or null	required
`github.event.pull_request.head.repo.disabled`	boolean	optional	Returns whether or not this repository is disabled.
`github.event.pull_request.head.repo.downloads_url`	string	required
`github.event.pull_request.head.repo.events_url`	string	required
`github.event.pull_request.head.repo.fork`	boolean	required
`github.event.pull_request.head.repo.forks`	integer	required
`github.event.pull_request.head.repo.forks_count`	integer	required
`github.event.pull_request.head.repo.forks_url`	string	required
`github.event.pull_request.head.repo.full_name`	string	required
`github.event.pull_request.head.repo.git_commits_url`	string	required
`github.event.pull_request.head.repo.git_refs_url`	string	required
`github.event.pull_request.head.repo.git_tags_url`	string	required
`github.event.pull_request.head.repo.git_url`	string	required
`github.event.pull_request.head.repo.has_downloads`	boolean	required	Whether downloads are enabled.
`github.event.pull_request.head.repo.has_issues`	boolean	required	Whether issues are enabled.
`github.event.pull_request.head.repo.has_pages`	boolean	required
`github.event.pull_request.head.repo.has_projects`	boolean	required	Whether projects are enabled.
`github.event.pull_request.head.repo.has_wiki`	boolean	required	Whether the wiki is enabled.
`github.event.pull_request.head.repo.homepage`	string or null	required
`github.event.pull_request.head.repo.hooks_url`	string	required
`github.event.pull_request.head.repo.html_url`	string	required
`github.event.pull_request.head.repo.id`	integer	required	Unique identifier of the repository
`github.event.pull_request.head.repo.is_template`	boolean	optional
`github.event.pull_request.head.repo.issue_comment_url`	string	required
`github.event.pull_request.head.repo.issue_events_url`	string	required
`github.event.pull_request.head.repo.issues_url`	string	required
`github.event.pull_request.head.repo.keys_url`	string	required
`github.event.pull_request.head.repo.labels_url`	string	required
`github.event.pull_request.head.repo.language`	string or null	required
`github.event.pull_request.head.repo.languages_url`	string	required
`github.event.pull_request.head.repo.license`	object or null	required
`github.event.pull_request.head.repo.license.key`	string	required
`github.event.pull_request.head.repo.license.name`	string	required
`github.event.pull_request.head.repo.license.node_id`	string	required
`github.event.pull_request.head.repo.license.spdx_id`	string	required
`github.event.pull_request.head.repo.license.url`	string or null	required
`github.event.pull_request.head.repo.master_branch`	string	optional
`github.event.pull_request.head.repo.merge_commit_message`	`PR_BODY`, `PR_TITLE`, `BLANK`	optional	The default value for a merge commit message. `PR_TITLE` - default to the pull request’s title. `PR_BODY` - default to the pull request’s body. `BLANK` - default to a blank commit message.
`github.event.pull_request.head.repo.merge_commit_title`	`PR_TITLE`, `MERGE_MESSAGE`	optional	The default value for a merge commit title. `PR_TITLE` - default to the pull request’s title. `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
`github.event.pull_request.head.repo.merges_url`	string	required
`github.event.pull_request.head.repo.milestones_url`	string	required
`github.event.pull_request.head.repo.mirror_url`	string or null	required
`github.event.pull_request.head.repo.name`	string	required	The name of the repository.
`github.event.pull_request.head.repo.node_id`	string	required
`github.event.pull_request.head.repo.notifications_url`	string	required
`github.event.pull_request.head.repo.open_issues`	integer	required
`github.event.pull_request.head.repo.open_issues_count`	integer	required
`github.event.pull_request.head.repo.organization`	string	optional
`github.event.pull_request.head.repo.owner`	object or null	required
`github.event.pull_request.head.repo.owner.avatar_url`	string	optional
`github.event.pull_request.head.repo.owner.deleted`	boolean	optional
`github.event.pull_request.head.repo.owner.email`	string or null	optional
`github.event.pull_request.head.repo.owner.events_url`	string	optional
`github.event.pull_request.head.repo.owner.followers_url`	string	optional
`github.event.pull_request.head.repo.owner.following_url`	string	optional
`github.event.pull_request.head.repo.owner.gists_url`	string	optional
`github.event.pull_request.head.repo.owner.gravatar_id`	string	optional
`github.event.pull_request.head.repo.owner.html_url`	string	optional
`github.event.pull_request.head.repo.owner.id`	integer	required
`github.event.pull_request.head.repo.owner.login`	string	required
`github.event.pull_request.head.repo.owner.name`	string	optional
`github.event.pull_request.head.repo.owner.node_id`	string	optional
`github.event.pull_request.head.repo.owner.organizations_url`	string	optional
`github.event.pull_request.head.repo.owner.received_events_url`	string	optional
`github.event.pull_request.head.repo.owner.repos_url`	string	optional
`github.event.pull_request.head.repo.owner.site_admin`	boolean	optional
`github.event.pull_request.head.repo.owner.starred_url`	string	optional
`github.event.pull_request.head.repo.owner.subscriptions_url`	string	optional
`github.event.pull_request.head.repo.owner.type`	`Bot`, `User`, `Organization`	optional
`github.event.pull_request.head.repo.owner.url`	string	optional
`github.event.pull_request.head.repo.permissions`	object	optional
`github.event.pull_request.head.repo.permissions.admin`	boolean	required
`github.event.pull_request.head.repo.permissions.maintain`	boolean	optional
`github.event.pull_request.head.repo.permissions.pull`	boolean	required
`github.event.pull_request.head.repo.permissions.push`	boolean	required
`github.event.pull_request.head.repo.permissions.triage`	boolean	optional
`github.event.pull_request.head.repo.private`	boolean	required	Whether the repository is private or public.
`github.event.pull_request.head.repo.public`	boolean	optional
`github.event.pull_request.head.repo.pulls_url`	string	required
`github.event.pull_request.head.repo.pushed_at`	null or integer or string	required
`github.event.pull_request.head.repo.releases_url`	string	required
`github.event.pull_request.head.repo.role_name`	string or null	optional
`github.event.pull_request.head.repo.size`	integer	required
`github.event.pull_request.head.repo.squash_merge_commit_message`	`PR_BODY`, `COMMIT_MESSAGES`, `BLANK`	optional	The default value for a squash merge commit message: `PR_BODY` - default to the pull request’s body. `COMMIT_MESSAGES` - default to the branch’s commit messages. `BLANK` - default to a blank commit message.
`github.event.pull_request.head.repo.squash_merge_commit_title`	`PR_TITLE`, `COMMIT_OR_PR_TITLE`	optional	The default value for a squash merge commit title: `PR_TITLE` - default to the pull request’s title. `COMMIT_OR_PR_TITLE` - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
`github.event.pull_request.head.repo.ssh_url`	string	required
`github.event.pull_request.head.repo.stargazers`	integer	optional
`github.event.pull_request.head.repo.stargazers_count`	integer	required
`github.event.pull_request.head.repo.stargazers_url`	string	required
`github.event.pull_request.head.repo.statuses_url`	string	required
`github.event.pull_request.head.repo.subscribers_url`	string	required
`github.event.pull_request.head.repo.subscription_url`	string	required
`github.event.pull_request.head.repo.svn_url`	string	required
`github.event.pull_request.head.repo.tags_url`	string	required
`github.event.pull_request.head.repo.teams_url`	string	required
`github.event.pull_request.head.repo.topics`	array of strings	required
`github.event.pull_request.head.repo.trees_url`	string	required
`github.event.pull_request.head.repo.updated_at`	string	required
`github.event.pull_request.head.repo.url`	string	required
`github.event.pull_request.head.repo.use_squash_pr_title_as_default`	boolean	optional	Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
`github.event.pull_request.head.repo.visibility`	`public`, `private`, `internal`	required
`github.event.pull_request.head.repo.watchers`	integer	required
`github.event.pull_request.head.repo.watchers_count`	integer	required
`github.event.pull_request.head.repo.web_commit_signoff_required`	boolean	optional	Whether to require contributors to sign off on web-based commits
`github.event.pull_request.head.sha`	string	required
`github.event.pull_request.head.user`	object or null	required
`github.event.pull_request.head.user.avatar_url`	string	optional
`github.event.pull_request.head.user.deleted`	boolean	optional
`github.event.pull_request.head.user.email`	string or null	optional
`github.event.pull_request.head.user.events_url`	string	optional
`github.event.pull_request.head.user.followers_url`	string	optional
`github.event.pull_request.head.user.following_url`	string	optional
`github.event.pull_request.head.user.gists_url`	string	optional
`github.event.pull_request.head.user.gravatar_id`	string	optional
`github.event.pull_request.head.user.html_url`	string	optional
`github.event.pull_request.head.user.id`	integer	required
`github.event.pull_request.head.user.login`	string	required
`github.event.pull_request.head.user.name`	string	optional
`github.event.pull_request.head.user.node_id`	string	optional
`github.event.pull_request.head.user.organizations_url`	string	optional
`github.event.pull_request.head.user.received_events_url`	string	optional
`github.event.pull_request.head.user.repos_url`	string	optional
`github.event.pull_request.head.user.site_admin`	boolean	optional
`github.event.pull_request.head.user.starred_url`	string	optional
`github.event.pull_request.head.user.subscriptions_url`	string	optional
`github.event.pull_request.head.user.type`	`Bot`, `User`, `Organization`	optional
`github.event.pull_request.head.user.url`	string	optional
`github.event.pull_request.html_url`	string	required
`github.event.pull_request.id`	integer	required
`github.event.pull_request.issue_url`	string	required
`github.event.pull_request.labels`	array of objects	required
`github.event.pull_request.labels.color`	string	required	6-character hex code, without the leading #, identifying the color
`github.event.pull_request.labels.default`	boolean	required
`github.event.pull_request.labels.description`	string or null	required
`github.event.pull_request.labels.id`	integer	required
`github.event.pull_request.labels.name`	string	required	The name of the label.
`github.event.pull_request.labels.node_id`	string	required
`github.event.pull_request.labels.url`	string	required	URL for the label
`github.event.pull_request.locked`	boolean	required
`github.event.pull_request.merge_commit_sha`	string or null	required
`github.event.pull_request.merged_at`	string or null	required
`github.event.pull_request.milestone`	object or null	required	A collection of related issues and pull requests.
`github.event.pull_request.milestone.closed_at`	string or null	required
`github.event.pull_request.milestone.closed_issues`	integer	required
`github.event.pull_request.milestone.created_at`	string	required
`github.event.pull_request.milestone.creator`	object or null	required
`github.event.pull_request.milestone.creator.avatar_url`	string	optional
`github.event.pull_request.milestone.creator.deleted`	boolean	optional
`github.event.pull_request.milestone.creator.email`	string or null	optional
`github.event.pull_request.milestone.creator.events_url`	string	optional
`github.event.pull_request.milestone.creator.followers_url`	string	optional
`github.event.pull_request.milestone.creator.following_url`	string	optional
`github.event.pull_request.milestone.creator.gists_url`	string	optional
`github.event.pull_request.milestone.creator.gravatar_id`	string	optional
`github.event.pull_request.milestone.creator.html_url`	string	optional
`github.event.pull_request.milestone.creator.id`	integer	required
`github.event.pull_request.milestone.creator.login`	string	required
`github.event.pull_request.milestone.creator.name`	string	optional
`github.event.pull_request.milestone.creator.node_id`	string	optional
`github.event.pull_request.milestone.creator.organizations_url`	string	optional
`github.event.pull_request.milestone.creator.received_events_url`	string	optional
`github.event.pull_request.milestone.creator.repos_url`	string	optional
`github.event.pull_request.milestone.creator.site_admin`	boolean	optional
`github.event.pull_request.milestone.creator.starred_url`	string	optional
`github.event.pull_request.milestone.creator.subscriptions_url`	string	optional
`github.event.pull_request.milestone.creator.url`	string	optional
`github.event.pull_request.milestone.description`	string or null	required
`github.event.pull_request.milestone.due_on`	string or null	required
`github.event.pull_request.milestone.html_url`	string	required
`github.event.pull_request.milestone.id`	integer	required
`github.event.pull_request.milestone.labels_url`	string	required
`github.event.pull_request.milestone.node_id`	string	required
`github.event.pull_request.milestone.number`	integer	required	The number of the milestone.
`github.event.pull_request.milestone.open_issues`	integer	required
`github.event.pull_request.milestone.state`	`open`, `closed`	required	The state of the milestone.
`github.event.pull_request.milestone.title`	string	required	The title of the milestone.
`github.event.pull_request.milestone.updated_at`	string	required
`github.event.pull_request.milestone.url`	string	required
`github.event.pull_request.node_id`	string	required
`github.event.pull_request.number`	integer	required
`github.event.pull_request.patch_url`	string	required
`github.event.pull_request.requested_reviewers`	array	required
`github.event.pull_request.requested_teams`	array of objects	required
`github.event.pull_request.requested_teams.deleted`	boolean	optional
`github.event.pull_request.requested_teams.description`	string or null	optional	Description of the team
`github.event.pull_request.requested_teams.html_url`	string	optional
`github.event.pull_request.requested_teams.id`	integer	required	Unique identifier of the team
`github.event.pull_request.requested_teams.members_url`	string	optional
`github.event.pull_request.requested_teams.name`	string	required	Name of the team
`github.event.pull_request.requested_teams.node_id`	string	optional
`github.event.pull_request.requested_teams.parent`	object or null	optional
`github.event.pull_request.requested_teams.parent.description`	string or null	required	Description of the team
`github.event.pull_request.requested_teams.parent.html_url`	string	required
`github.event.pull_request.requested_teams.parent.id`	integer	required	Unique identifier of the team
`github.event.pull_request.requested_teams.parent.members_url`	string	required
`github.event.pull_request.requested_teams.parent.name`	string	required	Name of the team
`github.event.pull_request.requested_teams.parent.node_id`	string	required
`github.event.pull_request.requested_teams.parent.permission`	string	required	Permission that the team will have for its repositories
`github.event.pull_request.requested_teams.parent.privacy`	`open`, `closed`, `secret`	required
`github.event.pull_request.requested_teams.parent.repositories_url`	string	required
`github.event.pull_request.requested_teams.parent.slug`	string	required
`github.event.pull_request.requested_teams.parent.url`	string	required	URL for the team
`github.event.pull_request.requested_teams.permission`	string	optional	Permission that the team will have for its repositories
`github.event.pull_request.requested_teams.privacy`	`open`, `closed`, `secret`	optional
`github.event.pull_request.requested_teams.repositories_url`	string	optional
`github.event.pull_request.requested_teams.slug`	string	optional
`github.event.pull_request.requested_teams.url`	string	optional	URL for the team
`github.event.pull_request.review_comment_url`	string	required
`github.event.pull_request.review_comments_url`	string	required
`github.event.pull_request.state`	`open`, `closed`	required
`github.event.pull_request.statuses_url`	string	required
`github.event.pull_request.title`	string	required
`github.event.pull_request.updated_at`	string	required
`github.event.pull_request.url`	string	required
`github.event.pull_request.user`	object or null	required
`github.event.pull_request.user.avatar_url`	string	optional
`github.event.pull_request.user.deleted`	boolean	optional
`github.event.pull_request.user.email`	string or null	optional
`github.event.pull_request.user.events_url`	string	optional
`github.event.pull_request.user.followers_url`	string	optional
`github.event.pull_request.user.following_url`	string	optional
`github.event.pull_request.user.gists_url`	string	optional
`github.event.pull_request.user.gravatar_id`	string	optional
`github.event.pull_request.user.html_url`	string	optional
`github.event.pull_request.user.id`	integer	required
`github.event.pull_request.user.login`	string	required
`github.event.pull_request.user.name`	string	optional
`github.event.pull_request.user.node_id`	string	optional
`github.event.pull_request.user.organizations_url`	string	optional
`github.event.pull_request.user.received_events_url`	string	optional
`github.event.pull_request.user.repos_url`	string	optional
`github.event.pull_request.user.site_admin`	boolean	optional
`github.event.pull_request.user.starred_url`	string	optional
`github.event.pull_request.user.subscriptions_url`	string	optional
`github.event.pull_request.user.type`	`Bot`, `User`, `Organization`, `Mannequin`	optional
`github.event.pull_request.user.url`	string	optional
`github.event.repository`	object	required	The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository.
`github.event.sender`	object	required	The GitHub user that triggered the event. This property is included in every webhook payload.

`created` #

This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "Commenting on a pull request." For information about the APIs to manage pull request review comments, see the GraphQL API documentation or "Pull request review comments" in the REST API documentation.

For activity related to pull request reviews, pull request comments, or pull request review threads, use the pull_request_review, issue_comment, or pull_request_review_thread events instead.

To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.

field	type	required	description
`github.event.action`	`created`	required
`github.event.comment.original_line`	integer or null	required	The line of the blob to which the comment applies. The last line of the range for a multi-line comment
`github.event.pull_request.assignee.type`	`Bot`, `User`, `Organization`, `Mannequin`	optional
`github.event.pull_request.head.repo.has_discussions`	boolean	optional	Whether discussions are enabled.
`github.event.pull_request.milestone.creator.type`	`Bot`, `User`, `Organization`, `Mannequin`	optional

`deleted` #

For activity related to pull request reviews, pull request comments, or pull request review threads, use the pull_request_review, issue_comment, or pull_request_review_thread events instead.

To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.

field	type	required	description
`github.event.action`	`deleted`	required
`github.event.comment.original_line`	integer	required	The line of the blob to which the comment applies. The last line of the range for a multi-line comment
`github.event.pull_request.assignee.type`	`Bot`, `User`, `Organization`	optional
`github.event.pull_request.head.repo.has_discussions`	boolean	required	Whether discussions are enabled.
`github.event.pull_request.milestone.creator.type`	`Bot`, `User`, `Organization`	optional

`edited` #

For activity related to pull request reviews, pull request comments, or pull request review threads, use the pull_request_review, issue_comment, or pull_request_review_thread events instead.

To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.

field	type	required	description
`github.event.action`	`edited`	required
`github.event.changes`	object	required	The changes to the comment.
`github.event.changes.body`	object	optional
`github.event.changes.body.from`	string	required	The previous version of the body.
`github.event.comment.original_line`	integer	required	The line of the blob to which the comment applies. The last line of the range for a multi-line comment
`github.event.pull_request.assignee.type`	`Bot`, `User`, `Organization`	optional
`github.event.pull_request.head.repo.has_discussions`	boolean	required	Whether discussions are enabled.
`github.event.pull_request.milestone.creator.type`	`Bot`, `User`, `Organization`, `Mannequin`	optional

Github Event pull_request_review_comment #

Github Action Trigger #

Workflows in forked repositories #

Pull request events for forked repositories #

Event Payload #

Common Fields #

created #

deleted #

edited #

Github Event `pull_request_review_comment` #

`created` #

`deleted` #

`edited` #