This page was generated based on Github’s Documentation. See our welcome page for context and details.
Github Event pull_request
#
Github Action Trigger #
Webhook event payload | Activity types | GITHUB_SHA | GITHUB_REF |
---|---|---|---|
pull_request | - assigned - unassigned - labeled - unlabeled - opened - edited - closed - reopened - synchronize - converted_to_draft - locked - unlocked - enqueued - dequeued - milestoned - demilestoned - ready_for_review - review_requested - review_request_removed - auto_merge_enabled - auto_merge_disabled | Last merge commit on the GITHUB_REF branch | PR merge branch refs/pull/PULL_REQUEST_NUMBER/merge |
Notes:
More than one activity type triggers this event. For information about each activity type, see “Webhook events and payloads.” By default, a workflow only runs when a
pull_request
event’s activity type isopened
,synchronize
, orreopened
. To trigger workflows by different activity types, use thetypes
keyword. For more information, see “Workflow syntax for GitHub Actions.”Workflows will not run on
pull_request
activity if the pull request has a merge conflict. The merge conflict must be resolved first.Conversely, workflows with the
pull_request_target
event will run even if the pull request has a merge conflict. Before using thepull_request_target
trigger, you should be aware of the security risks. For more information, seepull_request_target
.The
pull_request
webhook event payload is empty for merged pull requests and pull requests that come from forked repositories.The value of
GITHUB_REF
varies for a closed pull request depending on whether the pull request has been merged or not. If a pull request was closed but not merged, it will berefs/pull/PULL_REQUEST_NUMBER/merge
. If a pull request was closed as a result of being merged, it will be the fully qualifiedref
of the branch it was merged into, for example/refs/heads/main
.
Runs your workflow when activity on a pull request in the workflow’s repository occurs. For example, if no activity types are specified, the workflow runs when a pull request is opened or reopened or when the head branch of the pull request is updated. For activity related to pull request reviews, pull request review comments, or pull request comments, use the pull_request_review
, pull_request_review_comment
, or issue_comment
events instead. For information about the pull request APIs, see “Objects” in the GraphQL API documentation or “Pulls” in the REST API documentation.
Note that GITHUB_SHA
for this event is the last merge commit of the pull request merge branch. If you want to get the commit ID for the last commit to the head branch of the pull request, use github.event.pull_request.head.sha
instead.
For example, you can run a workflow when a pull request has been opened or reopened.
on:
pull_request:
types: [opened, reopened]
You can use the event context to further control when jobs in your workflow will run. For example, this workflow will run when a review is requested on a pull request, but the specific_review_requested
job will only run when a review by octo-team
is requested.
on:
pull_request:
types: [review_requested]
jobs:
specific_review_requested:
runs-on: ubuntu-latest
if: ${{ github.event.requested_team.name == 'octo-team'}}
steps:
- run: echo 'A review from octo-team was requested'
Running your pull_request
workflow based on the head or base branch of a pull request
#
You can use the branches
or branches-ignore
filter to configure your workflow to only run on pull requests that target specific branches. For more information, see “Workflow syntax for GitHub Actions.”
For example, this workflow will run when someone opens a pull request that targets a branch whose name starts with releases/
:
on:
pull_request:
types:
- opened
branches:
- 'releases/**'
Note: If you use both the branches
filter and the paths
filter, the workflow will only run when both filters are satisfied. For example, the following workflow will only run when a pull request that includes a change to a JavaScript (.js
) file is opened on a branch whose name starts with releases/
:
on:
pull_request:
types:
- opened
branches:
- 'releases/**'
paths:
- '**.js'
To run a job based on the pull request’s head branch name (as opposed to the pull request’s base branch name), use the github.head_ref
context in a conditional. For example, this workflow will run whenever a pull request is opened, but the run_if
job will only execute if the head of the pull request is a branch whose name starts with releases/
:
on:
pull_request:
types:
- opened
jobs:
run_if:
if: startsWith(github.head_ref, 'releases/')
runs-on: ubuntu-latest
steps:
- run: echo "The head of this PR starts with 'releases/'"
Running your pull_request
workflow based on files changed in a pull request
#
You can also configure your workflow to run when a pull request changes specific files. For more information, see “Workflow syntax for GitHub Actions.”
For example, this workflow will run when a pull request includes a change to a JavaScript file (.js
):
on:
pull_request:
paths:
- '**.js'
Note: If you use both the branches
filter and the paths
filter, the workflow will only run when both filters are satisfied. For example, the following workflow will only run when a pull request that includes a change to a JavaScript (.js
) file is opened on a branch whose name starts with releases/
:
on:
pull_request:
types:
- opened
branches:
- 'releases/**'
paths:
- '**.js'
Running your pull_request
workflow when a pull request merges
#
When a pull request merges, the pull request is automatically closed. To run a workflow when a pull request merges, use the pull_request
closed
event type along with a conditional that checks the merged
value of the event. For example, the following workflow will run whenever a pull request closes. The if_merged
job will only run if the pull request was also merged.
on:
pull_request:
types:
- closed
jobs:
if_merged:
if: github.event.pull_request.merged == true
runs-on: ubuntu-latest
steps:
- run: |
echo The PR was merged
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 #
Activities: assigned
, auto_merge_disabled
, auto_merge_enabled
, closed
, converted_to_draft
, demilestoned
, dequeued
, edited
, enqueued
, labeled
, locked
, milestoned
, opened
, ready_for_review
, reopened
, review_request_removed
, review_requested
, synchronize
, unassigned
, unlabeled
, unlocked
Common Fields #
These fields are common to every event types available with this trigger.
field | type | required | description |
---|---|---|---|
github.event.enterprise | object | optional | An enterprise on GitHub. Webhook payloads contain the |
github.event.number | integer | required | The pull request number. |
github.event.organization | object | optional | A GitHub organization. Webhook payloads contain the |
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.assignee.email | string or null | optional | |
github.event.pull_request.assignee.id | integer | required | |
github.event.pull_request.assignee.login | string | 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 | required | The status of auto merging a pull request. |
github.event.pull_request.auto_merge.enabled_by.email | string or null | 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.merge_method | merge , squash , rebase | required | The merge method to use. |
github.event.pull_request.base | object | 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_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.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.default_branch | string | required | The default branch of the repository. |
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.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.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.url | string or null | required | |
github.event.pull_request.base.repo.master_branch | string | optional | |
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.owner.id | integer | required | |
github.event.pull_request.base.repo.owner.login | string | required | |
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.pulls_url | string | required | |
github.event.pull_request.base.repo.releases_url | string | required | |
github.event.pull_request.base.repo.size | integer | required | |
github.event.pull_request.base.repo.ssh_url | string | required | |
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.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.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.id | integer | required | |
github.event.pull_request.base.user.login | string | required | |
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.head | object | required | |
github.event.pull_request.head.ref | string | required | |
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.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.default_branch | string | required | The default branch of the repository. |
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.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.has_discussions | boolean | required | Whether discussions are 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.url | string or null | required | |
github.event.pull_request.head.repo.master_branch | string | optional | |
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.owner.id | integer | required | |
github.event.pull_request.head.repo.owner.login | string | required | |
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.pulls_url | string | required | |
github.event.pull_request.head.repo.releases_url | string | required | |
github.event.pull_request.head.repo.size | integer | required | |
github.event.pull_request.head.repo.ssh_url | string | required | |
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.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.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.id | integer | required | |
github.event.pull_request.head.user.login | string | required | |
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.merged_by.email | string or null | optional | |
github.event.pull_request.merged_by.id | integer | required | |
github.event.pull_request.merged_by.login | string | required | |
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.email | string or null | optional | |
github.event.pull_request.milestone.creator.id | integer | required | |
github.event.pull_request.milestone.creator.login | string | required | |
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 | Number uniquely identifying the pull request within its repository. |
github.event.pull_request.patch_url | string | required | |
github.event.pull_request.rebaseable | boolean or null | optional | |
github.event.pull_request.requested_teams.id | integer | required | Unique identifier of the team |
github.event.pull_request.requested_teams.name | string | required | Name of 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 | State of this Pull Request. Either |
github.event.pull_request.statuses_url | string | required | |
github.event.pull_request.title | string | required | The title of the pull request. |
github.event.pull_request.updated_at | string | required | |
github.event.pull_request.url | string | required | |
github.event.pull_request.user.email | string or null | optional | |
github.event.pull_request.user.id | integer | required | |
github.event.pull_request.user.login | string | required | |
github.event.repository | object | required | The repository on GitHub where the event occurred. Webhook payloads contain the |
assigned
#
This event occurs when there is activity on a pull request. For more information, see "About pull requests." For information about the APIs to manage pull requests, see the GraphQL API documentation or "Pulls" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review
, pull_request_review_comment
, 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 | assigned | required | |
github.event.assignee | object or null | required | |
github.event.assignee.avatar_url | string | optional | |
github.event.assignee.deleted | boolean | optional | |
github.event.assignee.email | string or null | optional | |
github.event.assignee.events_url | string | optional | |
github.event.assignee.followers_url | string | optional | |
github.event.assignee.following_url | string | optional | |
github.event.assignee.gists_url | string | optional | |
github.event.assignee.gravatar_id | string | optional | |
github.event.assignee.html_url | string | optional | |
github.event.assignee.id | integer | required | |
github.event.assignee.login | string | required | |
github.event.assignee.name | string | optional | |
github.event.assignee.node_id | string | optional | |
github.event.assignee.organizations_url | string | optional | |
github.event.assignee.received_events_url | string | optional | |
github.event.assignee.repos_url | string | optional | |
github.event.assignee.site_admin | boolean | optional | |
github.event.assignee.starred_url | string | optional | |
github.event.assignee.subscriptions_url | string | optional | |
github.event.assignee.type | Bot , User , Organization | optional | |
github.event.assignee.url | string | optional | |
github.event.installation | object | optional | The GitHub App installation. Webhook payloads contain the |
github.event.pull_request.active_lock_reason | resolved , off-topic , too heated , spam , None | required | |
github.event.pull_request.additions | integer | optional | |
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.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.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.type | Bot , User , Organization , Mannequin | optional | |
github.event.pull_request.assignee.url | string | optional | |
github.event.pull_request.assignees | array of object,nulls | required | |
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.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.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.base.label | string | required | |
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_update_branch | boolean | optional | |
github.event.pull_request.base.repo.created_at | integer or string | required | |
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.disabled | boolean | optional | Returns whether or not this repository is disabled. |
github.event.pull_request.base.repo.license | object or null | required | |
github.event.pull_request.base.repo.license.spdx_id | string | required | |
github.event.pull_request.base.repo.merge_commit_message | PR_BODY , PR_TITLE , BLANK | optional | The default value for a merge commit message.
|
github.event.pull_request.base.repo.merge_commit_title | PR_TITLE , MERGE_MESSAGE | optional | The default value for a merge commit title.
|
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.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.public | boolean | optional | |
github.event.pull_request.base.repo.pushed_at | null or integer or string | required | |
github.event.pull_request.base.repo.role_name | string or null | optional | |
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:
|
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:
|
github.event.pull_request.base.repo.stargazers | integer | optional | |
github.event.pull_request.base.repo.topics | array of strings | 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 |
github.event.pull_request.base.repo.visibility | public , private , internal | 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.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.changed_files | integer | optional | |
github.event.pull_request.comments | integer | optional | |
github.event.pull_request.commits | integer | optional | |
github.event.pull_request.deletions | integer | optional | |
github.event.pull_request.draft | boolean | required | Indicates whether or not the pull request is a draft. |
github.event.pull_request.head.label | string or null | 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_update_branch | boolean | optional | |
github.event.pull_request.head.repo.created_at | integer or string | required | |
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.disabled | boolean | optional | Returns whether or not this repository is disabled. |
github.event.pull_request.head.repo.license.spdx_id | string | required | |
github.event.pull_request.head.repo.merge_commit_message | PR_BODY , PR_TITLE , BLANK | optional | The default value for a merge commit message.
|
github.event.pull_request.head.repo.merge_commit_title | PR_TITLE , MERGE_MESSAGE | optional | The default value for a merge commit title.
|
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.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.public | boolean | optional | |
github.event.pull_request.head.repo.pushed_at | null or integer or string | required | |
github.event.pull_request.head.repo.role_name | string or null | optional | |
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:
|
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:
|
github.event.pull_request.head.repo.stargazers | integer | optional | |
github.event.pull_request.head.repo.topics | array of strings | 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 |
github.event.pull_request.head.repo.visibility | public , private , internal | 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.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.maintainer_can_modify | boolean | optional | Indicates whether maintainers can modify the pull request. |
github.event.pull_request.mergeable | boolean or null | optional | |
github.event.pull_request.mergeable_state | string | optional | |
github.event.pull_request.merged | boolean or null | optional | |
github.event.pull_request.merged_by | object or null | optional | |
github.event.pull_request.merged_by.avatar_url | string | optional | |
github.event.pull_request.merged_by.deleted | boolean | optional | |
github.event.pull_request.merged_by.events_url | string | optional | |
github.event.pull_request.merged_by.followers_url | string | optional | |
github.event.pull_request.merged_by.following_url | string | optional | |
github.event.pull_request.merged_by.gists_url | string | optional | |
github.event.pull_request.merged_by.gravatar_id | string | optional | |
github.event.pull_request.merged_by.html_url | string | optional | |
github.event.pull_request.merged_by.name | string | optional | |
github.event.pull_request.merged_by.node_id | string | optional | |
github.event.pull_request.merged_by.organizations_url | string | optional | |
github.event.pull_request.merged_by.received_events_url | string | optional | |
github.event.pull_request.merged_by.repos_url | string | optional | |
github.event.pull_request.merged_by.site_admin | boolean | optional | |
github.event.pull_request.merged_by.starred_url | string | optional | |
github.event.pull_request.merged_by.subscriptions_url | string | optional | |
github.event.pull_request.merged_by.type | Bot , User , Organization | optional | |
github.event.pull_request.merged_by.url | string | optional | |
github.event.pull_request.milestone | object or null | required | A collection of related issues and pull requests. |
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.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.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.type | Bot , User , Organization , Mannequin | optional | |
github.event.pull_request.milestone.creator.url | string | optional | |
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.members_url | string | optional | |
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_comments | integer | optional | |
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.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.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.sender | object | required | The GitHub user that triggered the event. This property is included in every webhook payload. |
auto_merge_disabled
#
This event occurs when there is activity on a pull request. For more information, see "About pull requests." For information about the APIs to manage pull requests, see the GraphQL API documentation or "Pulls" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review
, pull_request_review_comment
, 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 | auto_merge_disabled | required | |
github.event.installation | object | optional | The GitHub App installation. Webhook payloads contain the |
github.event.pull_request.active_lock_reason | resolved , off-topic , too heated , spam , None | required | |
github.event.pull_request.additions | integer | optional | |
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.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.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.type | Bot , User , Organization | optional | |
github.event.pull_request.assignee.url | string | optional | |
github.event.pull_request.assignees | array of object,nulls | required | |
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.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.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.base.label | string | required | |
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_update_branch | boolean | optional | |
github.event.pull_request.base.repo.created_at | integer or string | required | |
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.disabled | boolean | optional | Returns whether or not this repository is disabled. |
github.event.pull_request.base.repo.license | object or null | required | |
github.event.pull_request.base.repo.license.spdx_id | string | required | |
github.event.pull_request.base.repo.merge_commit_message | PR_BODY , PR_TITLE , BLANK | optional | The default value for a merge commit message.
|
github.event.pull_request.base.repo.merge_commit_title | PR_TITLE , MERGE_MESSAGE | optional | The default value for a merge commit title.
|
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.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.public | boolean | optional | |
github.event.pull_request.base.repo.pushed_at | null or integer or string | required | |
github.event.pull_request.base.repo.role_name | string or null | optional | |
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:
|
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:
|
github.event.pull_request.base.repo.stargazers | integer | optional | |
github.event.pull_request.base.repo.topics | array of strings | 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 |
github.event.pull_request.base.repo.visibility | public , private , internal | 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.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.changed_files | integer | optional | |
github.event.pull_request.comments | integer | optional | |
github.event.pull_request.commits | integer | optional | |
github.event.pull_request.deletions | integer | optional | |
github.event.pull_request.draft | boolean | required | Indicates whether or not the pull request is a draft. |
github.event.pull_request.head.label | string | required | |
github.event.pull_request.head.repo | object | 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_update_branch | boolean | optional | |
github.event.pull_request.head.repo.created_at | integer or string | required | |
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.disabled | boolean | optional | Returns whether or not this repository is disabled. |
github.event.pull_request.head.repo.license.spdx_id | string | required | |
github.event.pull_request.head.repo.merge_commit_message | PR_BODY , PR_TITLE , BLANK | optional | The default value for a merge commit message.
|
github.event.pull_request.head.repo.merge_commit_title | PR_TITLE , MERGE_MESSAGE | optional | The default value for a merge commit title.
|
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.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.public | boolean | optional | |
github.event.pull_request.head.repo.pushed_at | null or integer or string | required | |
github.event.pull_request.head.repo.role_name | string or null | optional | |
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:
|
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:
|
github.event.pull_request.head.repo.stargazers | integer | optional | |
github.event.pull_request.head.repo.topics | array of strings | 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 |
github.event.pull_request.head.repo.visibility | public , private , internal | 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.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.maintainer_can_modify | boolean | optional | Indicates whether maintainers can modify the pull request. |
github.event.pull_request.mergeable | boolean or null | optional | |
github.event.pull_request.mergeable_state | string | optional | |
github.event.pull_request.merged | boolean or null | optional | |
github.event.pull_request.merged_by | object or null | optional | |
github.event.pull_request.merged_by.avatar_url | string | optional | |
github.event.pull_request.merged_by.deleted | boolean | optional | |
github.event.pull_request.merged_by.events_url | string | optional | |
github.event.pull_request.merged_by.followers_url | string | optional | |
github.event.pull_request.merged_by.following_url | string | optional | |
github.event.pull_request.merged_by.gists_url | string | optional | |
github.event.pull_request.merged_by.gravatar_id | string | optional | |
github.event.pull_request.merged_by.html_url | string | optional | |
github.event.pull_request.merged_by.name | string | optional | |
github.event.pull_request.merged_by.node_id | string | optional | |
github.event.pull_request.merged_by.organizations_url | string | optional | |
github.event.pull_request.merged_by.received_events_url | string | optional | |
github.event.pull_request.merged_by.repos_url | string | optional | |
github.event.pull_request.merged_by.site_admin | boolean | optional | |
github.event.pull_request.merged_by.starred_url | string | optional | |
github.event.pull_request.merged_by.subscriptions_url | string | optional | |
github.event.pull_request.merged_by.type | Bot , User , Organization | optional | |
github.event.pull_request.merged_by.url | string | optional | |
github.event.pull_request.milestone | object or null | required | A collection of related issues and pull requests. |
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.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.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.type | Bot , User , Organization | optional | |
github.event.pull_request.milestone.creator.url | string | optional | |
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.members_url | string | optional | |
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_comments | integer | optional | |
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.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.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.reason | string | required | |
github.event.sender | object | required | The GitHub user that triggered the event. This property is included in every webhook payload. |
auto_merge_enabled
#
This event occurs when there is activity on a pull request. For more information, see "About pull requests." For information about the APIs to manage pull requests, see the GraphQL API documentation or "Pulls" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review
, pull_request_review_comment
, 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 | auto_merge_enabled | required | |
github.event.installation | object | optional | The GitHub App installation. Webhook payloads contain the |
github.event.pull_request.active_lock_reason | resolved , off-topic , too heated , spam , None | required | |
github.event.pull_request.additions | integer | optional | |
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.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.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.type | Bot , User , Organization | optional | |
github.event.pull_request.assignee.url | string | optional | |
github.event.pull_request.assignees | array of object,nulls | required | |
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.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.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.base.label | string | required | |
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_update_branch | boolean | optional | |
github.event.pull_request.base.repo.created_at | integer or string | required | |
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.disabled | boolean | optional | Returns whether or not this repository is disabled. |
github.event.pull_request.base.repo.license | object or null | required | |
github.event.pull_request.base.repo.license.spdx_id | string | required | |
github.event.pull_request.base.repo.merge_commit_message | PR_BODY , PR_TITLE , BLANK | optional | The default value for a merge commit message.
|
github.event.pull_request.base.repo.merge_commit_title | PR_TITLE , MERGE_MESSAGE | optional | The default value for a merge commit title.
|
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.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.public | boolean | optional | |
github.event.pull_request.base.repo.pushed_at | null or integer or string | required | |
github.event.pull_request.base.repo.role_name | string or null | optional | |
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:
|
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:
|
github.event.pull_request.base.repo.stargazers | integer | optional | |
github.event.pull_request.base.repo.topics | array of strings | 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 |
github.event.pull_request.base.repo.visibility | public , private , internal | 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.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.changed_files | integer | optional | |
github.event.pull_request.comments | integer | optional | |
github.event.pull_request.commits | integer | optional | |
github.event.pull_request.deletions | integer | optional | |
github.event.pull_request.draft | boolean | required | Indicates whether or not the pull request is a draft. |
github.event.pull_request.head.label | string | required | |
github.event.pull_request.head.repo | object | 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_update_branch | boolean | optional | |
github.event.pull_request.head.repo.created_at | integer or string | required | |
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.disabled | boolean | optional | Returns whether or not this repository is disabled. |
github.event.pull_request.head.repo.license.spdx_id | string | required | |
github.event.pull_request.head.repo.merge_commit_message | PR_BODY , PR_TITLE , BLANK | optional | The default value for a merge commit message.
|
github.event.pull_request.head.repo.merge_commit_title | PR_TITLE , MERGE_MESSAGE | optional | The default value for a merge commit title.
|
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.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.public | boolean | optional | |
github.event.pull_request.head.repo.pushed_at | null or integer or string | required | |
github.event.pull_request.head.repo.role_name | string or null | optional | |
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:
|
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:
|
github.event.pull_request.head.repo.stargazers | integer | optional | |
github.event.pull_request.head.repo.topics | array of strings | 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 |
github.event.pull_request.head.repo.visibility | public , private , internal | 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.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.maintainer_can_modify | boolean | optional | Indicates whether maintainers can modify the pull request. |
github.event.pull_request.mergeable | boolean or null | optional | |
github.event.pull_request.mergeable_state | string | optional | |
github.event.pull_request.merged | boolean or null | optional | |
github.event.pull_request.merged_by | object or null | optional | |
github.event.pull_request.merged_by.avatar_url | string | optional | |
github.event.pull_request.merged_by.deleted | boolean | optional | |
github.event.pull_request.merged_by.events_url | string | optional | |
github.event.pull_request.merged_by.followers_url | string | optional | |
github.event.pull_request.merged_by.following_url | string | optional | |
github.event.pull_request.merged_by.gists_url | string | optional | |
github.event.pull_request.merged_by.gravatar_id | string | optional | |
github.event.pull_request.merged_by.html_url | string | optional | |
github.event.pull_request.merged_by.name | string | optional | |
github.event.pull_request.merged_by.node_id | string | optional | |
github.event.pull_request.merged_by.organizations_url | string | optional | |
github.event.pull_request.merged_by.received_events_url | string | optional | |
github.event.pull_request.merged_by.repos_url | string | optional | |
github.event.pull_request.merged_by.site_admin | boolean | optional | |
github.event.pull_request.merged_by.starred_url | string | optional | |
github.event.pull_request.merged_by.subscriptions_url | string | optional | |
github.event.pull_request.merged_by.type | Bot , User , Organization | optional | |
github.event.pull_request.merged_by.url | string | optional | |
github.event.pull_request.milestone | object or null | required | A collection of related issues and pull requests. |
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.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.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.type | Bot , User , Organization , Mannequin | optional | |
github.event.pull_request.milestone.creator.url | string | optional | |
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.members_url | string | optional | |
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_comments | integer | optional | |
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.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.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.reason | string | optional | |
github.event.sender | object | required | The GitHub user that triggered the event. This property is included in every webhook payload. |
closed
#
This event occurs when there is activity on a pull request. For more information, see "About pull requests." For information about the APIs to manage pull requests, see the GraphQL API documentation or "Pulls" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review
, pull_request_review_comment
, 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 | closed | required | |
github.event.installation | object | optional | The GitHub App installation. Webhook payloads contain the |
github.event.pull_request.user | object | required | A GitHub user. |
github.event.pull_request.user.name | string or null | optional | |
github.event.pull_request.user.node_id | string | required | |
github.event.pull_request.user.avatar_url | string | required | |
github.event.pull_request.user.gravatar_id | string or null | required | |
github.event.pull_request.user.url | string | required | |
github.event.pull_request.user.html_url | string | required | |
github.event.pull_request.user.followers_url | string | required | |
github.event.pull_request.user.following_url | string | required | |
github.event.pull_request.user.gists_url | string | required | |
github.event.pull_request.user.starred_url | string | required | |
github.event.pull_request.user.subscriptions_url | string | required | |
github.event.pull_request.user.organizations_url | string | required | |
github.event.pull_request.user.repos_url | string | required | |
github.event.pull_request.user.events_url | string | required | |
github.event.pull_request.user.received_events_url | string | required | |
github.event.pull_request.user.type | string | required | |
github.event.pull_request.user.site_admin | boolean | required | |
github.event.pull_request.user.starred_at | string | optional | |
github.event.pull_request.milestone | object | required | A collection of related issues and pull requests. |
github.event.pull_request.milestone.creator | object | required | A GitHub user. |
github.event.pull_request.milestone.creator.name | string or null | optional | |
github.event.pull_request.milestone.creator.node_id | string | required | |
github.event.pull_request.milestone.creator.avatar_url | string | required | |
github.event.pull_request.milestone.creator.gravatar_id | string or null | required | |
github.event.pull_request.milestone.creator.url | string | required | |
github.event.pull_request.milestone.creator.html_url | string | required | |
github.event.pull_request.milestone.creator.followers_url | string | required | |
github.event.pull_request.milestone.creator.following_url | string | required | |
github.event.pull_request.milestone.creator.gists_url | string | required | |
github.event.pull_request.milestone.creator.starred_url | string | required | |
github.event.pull_request.milestone.creator.subscriptions_url | string | required | |
github.event.pull_request.milestone.creator.organizations_url | string | required | |
github.event.pull_request.milestone.creator.repos_url | string | required | |
github.event.pull_request.milestone.creator.events_url | string | required | |
github.event.pull_request.milestone.creator.received_events_url | string | required | |
github.event.pull_request.milestone.creator.type | string | required | |
github.event.pull_request.milestone.creator.site_admin | boolean | required | |
github.event.pull_request.milestone.creator.starred_at | string | optional | |
github.event.pull_request.active_lock_reason | string or null | optional | |
github.event.pull_request.assignee | object | required | A GitHub user. |
github.event.pull_request.assignee.name | string or null | optional | |
github.event.pull_request.assignee.node_id | string | required | |
github.event.pull_request.assignee.avatar_url | string | required | |
github.event.pull_request.assignee.gravatar_id | string or null | required | |
github.event.pull_request.assignee.url | string | required | |
github.event.pull_request.assignee.html_url | string | required | |
github.event.pull_request.assignee.followers_url | string | required | |
github.event.pull_request.assignee.following_url | string | required | |
github.event.pull_request.assignee.gists_url | string | required | |
github.event.pull_request.assignee.starred_url | string | required | |
github.event.pull_request.assignee.subscriptions_url | string | required | |
github.event.pull_request.assignee.organizations_url | string | required | |
github.event.pull_request.assignee.repos_url | string | required | |
github.event.pull_request.assignee.events_url | string | required | |
github.event.pull_request.assignee.received_events_url | string | required | |
github.event.pull_request.assignee.type | string | required | |
github.event.pull_request.assignee.site_admin | boolean | required | |
github.event.pull_request.assignee.starred_at | string | optional | |
github.event.pull_request.assignees | array of objects or null | optional | |
github.event.pull_request.assignees.name | string or null | optional | |
github.event.pull_request.assignees.email | string or null | optional | |
github.event.pull_request.assignees.login | string | required | |
github.event.pull_request.assignees.id | integer | required | |
github.event.pull_request.assignees.node_id | string | required | |
github.event.pull_request.assignees.avatar_url | string | required | |
github.event.pull_request.assignees.gravatar_id | string or null | required | |
github.event.pull_request.assignees.url | string | required | |
github.event.pull_request.assignees.html_url | string | required | |
github.event.pull_request.assignees.followers_url | string | required | |
github.event.pull_request.assignees.following_url | string | required | |
github.event.pull_request.assignees.gists_url | string | required | |
github.event.pull_request.assignees.starred_url | string | required | |
github.event.pull_request.assignees.subscriptions_url | string | required | |
github.event.pull_request.assignees.organizations_url | string | required | |
github.event.pull_request.assignees.repos_url | string | required | |
github.event.pull_request.assignees.events_url | string | required | |
github.event.pull_request.assignees.received_events_url | string | required | |
github.event.pull_request.assignees.type | string | required | |
github.event.pull_request.assignees.site_admin | boolean | required | |
github.event.pull_request.assignees.starred_at | string | optional | |
github.event.pull_request.requested_reviewers | array of objects or null | optional | |
github.event.pull_request.requested_reviewers.name | string or null | optional | |
github.event.pull_request.requested_reviewers.email | string or null | optional | |
github.event.pull_request.requested_reviewers.login | string | required | |
github.event.pull_request.requested_reviewers.id | integer | required | |
github.event.pull_request.requested_reviewers.node_id | string | required | |
github.event.pull_request.requested_reviewers.avatar_url | string | required | |
github.event.pull_request.requested_reviewers.gravatar_id | string or null | required | |
github.event.pull_request.requested_reviewers.url | string | required | |
github.event.pull_request.requested_reviewers.html_url | string | required | |
github.event.pull_request.requested_reviewers.followers_url | string | required | |
github.event.pull_request.requested_reviewers.following_url | string | required | |
github.event.pull_request.requested_reviewers.gists_url | string | required | |
github.event.pull_request.requested_reviewers.starred_url | string | required | |
github.event.pull_request.requested_reviewers.subscriptions_url | string | required | |
github.event.pull_request.requested_reviewers.organizations_url | string | required | |
github.event.pull_request.requested_reviewers.repos_url | string | required | |
github.event.pull_request.requested_reviewers.events_url | string | required | |
github.event.pull_request.requested_reviewers.received_events_url | string | required | |
github.event.pull_request.requested_reviewers.type | string | required | |
github.event.pull_request.requested_reviewers.site_admin | boolean | required | |
github.event.pull_request.requested_reviewers.starred_at | string | optional | |
github.event.pull_request.requested_teams | array of objects or null | optional | |
github.event.pull_request.requested_teams.node_id | string | required | |
github.event.pull_request.requested_teams.url | string | required | URL for the team |
github.event.pull_request.requested_teams.members_url | string | required | |
github.event.pull_request.requested_teams.description | string or null | required | Description of the team |
github.event.pull_request.requested_teams.permission | string | required | Permission that the team will have for its repositories |
github.event.pull_request.requested_teams.privacy | string | optional | The level of privacy this team should have |
github.event.pull_request.requested_teams.notification_setting | string | optional | The notification setting the team has set |
github.event.pull_request.requested_teams.html_url | string | required | |
github.event.pull_request.requested_teams.repositories_url | string | required | |
github.event.pull_request.requested_teams.slug | string | required | |
github.event.pull_request.requested_teams.ldap_dn | string | optional | Distinguished Name (DN) that team maps to within LDAP environment |
github.event.pull_request.head.label | string | required | |
github.event.pull_request.head.repo | object or null | required | |
github.event.pull_request.head.repo.owner | object | required | |
github.event.pull_request.head.repo.owner.avatar_url | string | required | |
github.event.pull_request.head.repo.owner.events_url | string | required | |
github.event.pull_request.head.repo.owner.followers_url | string | required | |
github.event.pull_request.head.repo.owner.following_url | string | required | |
github.event.pull_request.head.repo.owner.gists_url | string | required | |
github.event.pull_request.head.repo.owner.gravatar_id | string or null | required | |
github.event.pull_request.head.repo.owner.html_url | string | required | |
github.event.pull_request.head.repo.owner.node_id | string | required | |
github.event.pull_request.head.repo.owner.organizations_url | string | required | |
github.event.pull_request.head.repo.owner.received_events_url | string | required | |
github.event.pull_request.head.repo.owner.repos_url | string | required | |
github.event.pull_request.head.repo.owner.site_admin | boolean | required | |
github.event.pull_request.head.repo.owner.starred_url | string | required | |
github.event.pull_request.head.repo.owner.subscriptions_url | string | required | |
github.event.pull_request.head.repo.owner.type | string | required | |
github.event.pull_request.head.repo.owner.url | string | required | |
github.event.pull_request.head.repo.disabled | boolean | required | |
github.event.pull_request.head.repo.visibility | string | optional | The repository visibility: public, private, or internal. |
github.event.pull_request.head.repo.temp_clone_token | string | optional | |
github.event.pull_request.head.repo.license.spdx_id | string or null | required | |
github.event.pull_request.head.repo.pushed_at | string | required | |
github.event.pull_request.head.repo.topics | array of strings | optional | |
github.event.pull_request.head.repo.created_at | string | required | |
github.event.pull_request.head.user | object | required | |
github.event.pull_request.head.user.avatar_url | string | required | |
github.event.pull_request.head.user.events_url | string | required | |
github.event.pull_request.head.user.followers_url | string | required | |
github.event.pull_request.head.user.following_url | string | required | |
github.event.pull_request.head.user.gists_url | string | required | |
github.event.pull_request.head.user.gravatar_id | string or null | required | |
github.event.pull_request.head.user.html_url | string | required | |
github.event.pull_request.head.user.node_id | string | required | |
github.event.pull_request.head.user.organizations_url | string | required | |
github.event.pull_request.head.user.received_events_url | string | required | |
github.event.pull_request.head.user.repos_url | string | required | |
github.event.pull_request.head.user.site_admin | boolean | required | |
github.event.pull_request.head.user.starred_url | string | required | |
github.event.pull_request.head.user.subscriptions_url | string | required | |
github.event.pull_request.head.user.type | string | required | |
github.event.pull_request.head.user.url | string | required | |
github.event.pull_request.base.label | string | required | |
github.event.pull_request.base.repo.owner | object | required | |
github.event.pull_request.base.repo.owner.avatar_url | string | required | |
github.event.pull_request.base.repo.owner.events_url | string | required | |
github.event.pull_request.base.repo.owner.followers_url | string | required | |
github.event.pull_request.base.repo.owner.following_url | string | required | |
github.event.pull_request.base.repo.owner.gists_url | string | required | |
github.event.pull_request.base.repo.owner.gravatar_id | string or null | required | |
github.event.pull_request.base.repo.owner.html_url | string | required | |
github.event.pull_request.base.repo.owner.node_id | string | required | |
github.event.pull_request.base.repo.owner.organizations_url | string | required | |
github.event.pull_request.base.repo.owner.received_events_url | string | required | |
github.event.pull_request.base.repo.owner.repos_url | string | required | |
github.event.pull_request.base.repo.owner.site_admin | boolean | required | |
github.event.pull_request.base.repo.owner.starred_url | string | required | |
github.event.pull_request.base.repo.owner.subscriptions_url | string | required | |
github.event.pull_request.base.repo.owner.type | string | required | |
github.event.pull_request.base.repo.owner.url | string | required | |
github.event.pull_request.base.repo.disabled | boolean | required | |
github.event.pull_request.base.repo.visibility | string | optional | The repository visibility: public, private, or internal. |
github.event.pull_request.base.repo.temp_clone_token | string | optional | |
github.event.pull_request.base.repo.license | object | required | License Simple |
github.event.pull_request.base.repo.license.spdx_id | string or null | required | |
github.event.pull_request.base.repo.license.html_url | string | optional | |
github.event.pull_request.base.repo.pushed_at | string | required | |
github.event.pull_request.base.repo.topics | array of strings | optional | |
github.event.pull_request.base.repo.created_at | string | required | |
github.event.pull_request.base.user | object | required | |
github.event.pull_request.base.user.avatar_url | string | required | |
github.event.pull_request.base.user.events_url | string | required | |
github.event.pull_request.base.user.followers_url | string | required | |
github.event.pull_request.base.user.following_url | string | required | |
github.event.pull_request.base.user.gists_url | string | required | |
github.event.pull_request.base.user.gravatar_id | string or null | required | |
github.event.pull_request.base.user.html_url | string | required | |
github.event.pull_request.base.user.node_id | string | required | |
github.event.pull_request.base.user.organizations_url | string | required | |
github.event.pull_request.base.user.received_events_url | string | required | |
github.event.pull_request.base.user.repos_url | string | required | |
github.event.pull_request.base.user.site_admin | boolean | required | |
github.event.pull_request.base.user.starred_url | string | required | |
github.event.pull_request.base.user.subscriptions_url | string | required | |
github.event.pull_request.base.user.type | string | required | |
github.event.pull_request.base.user.url | string | required | |
github.event.pull_request.auto_merge.enabled_by | object | required | A GitHub user. |
github.event.pull_request.auto_merge.enabled_by.name | string or null | optional | |
github.event.pull_request.auto_merge.enabled_by.node_id | string | required | |
github.event.pull_request.auto_merge.enabled_by.avatar_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.gravatar_id | string or null | required | |
github.event.pull_request.auto_merge.enabled_by.url | string | required | |
github.event.pull_request.auto_merge.enabled_by.html_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.followers_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.following_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.gists_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.starred_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.subscriptions_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.organizations_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.repos_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.events_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.received_events_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.type | string | required | |
github.event.pull_request.auto_merge.enabled_by.site_admin | boolean | required | |
github.event.pull_request.auto_merge.enabled_by.starred_at | string | optional | |
github.event.pull_request.auto_merge.commit_title | string | required | Title for the merge commit message. |
github.event.pull_request.auto_merge.commit_message | string | required | Commit message for the merge commit. |
github.event.pull_request.draft | boolean | optional | Indicates whether or not the pull request is a draft. |
github.event.pull_request.merged | boolean | required | |
github.event.pull_request.mergeable | boolean or null | required | |
github.event.pull_request.mergeable_state | string | required | |
github.event.pull_request.merged_by | object | required | A GitHub user. |
github.event.pull_request.merged_by.name | string or null | optional | |
github.event.pull_request.merged_by.node_id | string | required | |
github.event.pull_request.merged_by.avatar_url | string | required | |
github.event.pull_request.merged_by.gravatar_id | string or null | required | |
github.event.pull_request.merged_by.url | string | required | |
github.event.pull_request.merged_by.html_url | string | required | |
github.event.pull_request.merged_by.followers_url | string | required | |
github.event.pull_request.merged_by.following_url | string | required | |
github.event.pull_request.merged_by.gists_url | string | required | |
github.event.pull_request.merged_by.starred_url | string | required | |
github.event.pull_request.merged_by.subscriptions_url | string | required | |
github.event.pull_request.merged_by.organizations_url | string | required | |
github.event.pull_request.merged_by.repos_url | string | required | |
github.event.pull_request.merged_by.events_url | string | required | |
github.event.pull_request.merged_by.received_events_url | string | required | |
github.event.pull_request.merged_by.type | string | required | |
github.event.pull_request.merged_by.site_admin | boolean | required | |
github.event.pull_request.merged_by.starred_at | string | optional | |
github.event.pull_request.comments | integer | required | |
github.event.pull_request.review_comments | integer | required | |
github.event.pull_request.maintainer_can_modify | boolean | required | Indicates whether maintainers can modify the pull request. |
github.event.pull_request.commits | integer | required | |
github.event.pull_request.additions | integer | required | |
github.event.pull_request.deletions | integer | required | |
github.event.pull_request.changed_files | integer | required | |
github.event.pull_request.allow_auto_merge | boolean | optional | Whether to allow auto-merge for pull requests. |
github.event.pull_request.allow_update_branch | boolean | optional | Whether to allow updating the pull request’s branch. |
github.event.pull_request.delete_branch_on_merge | boolean | optional | Whether to delete head branches when pull requests are merged. |
github.event.pull_request.merge_commit_message | PR_BODY , PR_TITLE , BLANK | optional | The default value for a merge commit message.
|
github.event.pull_request.merge_commit_title | PR_TITLE , MERGE_MESSAGE | optional | The default value for a merge commit title.
|
github.event.pull_request.squash_merge_commit_message | PR_BODY , COMMIT_MESSAGES , BLANK | optional | The default value for a squash merge commit message:
|
github.event.pull_request.squash_merge_commit_title | PR_TITLE , COMMIT_OR_PR_TITLE | optional | The default value for a squash merge commit title:
|
github.event.pull_request.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 |
github.event.sender | object | required | The GitHub user that triggered the event. This property is included in every webhook payload. |
converted_to_draft
#
This event occurs when there is activity on a pull request. For more information, see "About pull requests." For information about the APIs to manage pull requests, see the GraphQL API documentation or "Pulls" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review
, pull_request_review_comment
, 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 | converted_to_draft | required | |
github.event.installation | object | optional | The GitHub App installation. Webhook payloads contain the |
github.event.pull_request.user | object | required | A GitHub user. |
github.event.pull_request.user.name | string or null | optional | |
github.event.pull_request.user.node_id | string | required | |
github.event.pull_request.user.avatar_url | string | required | |
github.event.pull_request.user.gravatar_id | string or null | required | |
github.event.pull_request.user.url | string | required | |
github.event.pull_request.user.html_url | string | required | |
github.event.pull_request.user.followers_url | string | required | |
github.event.pull_request.user.following_url | string | required | |
github.event.pull_request.user.gists_url | string | required | |
github.event.pull_request.user.starred_url | string | required | |
github.event.pull_request.user.subscriptions_url | string | required | |
github.event.pull_request.user.organizations_url | string | required | |
github.event.pull_request.user.repos_url | string | required | |
github.event.pull_request.user.events_url | string | required | |
github.event.pull_request.user.received_events_url | string | required | |
github.event.pull_request.user.type | string | required | |
github.event.pull_request.user.site_admin | boolean | required | |
github.event.pull_request.user.starred_at | string | optional | |
github.event.pull_request.milestone | object | required | A collection of related issues and pull requests. |
github.event.pull_request.milestone.creator | object | required | A GitHub user. |
github.event.pull_request.milestone.creator.name | string or null | optional | |
github.event.pull_request.milestone.creator.node_id | string | required | |
github.event.pull_request.milestone.creator.avatar_url | string | required | |
github.event.pull_request.milestone.creator.gravatar_id | string or null | required | |
github.event.pull_request.milestone.creator.url | string | required | |
github.event.pull_request.milestone.creator.html_url | string | required | |
github.event.pull_request.milestone.creator.followers_url | string | required | |
github.event.pull_request.milestone.creator.following_url | string | required | |
github.event.pull_request.milestone.creator.gists_url | string | required | |
github.event.pull_request.milestone.creator.starred_url | string | required | |
github.event.pull_request.milestone.creator.subscriptions_url | string | required | |
github.event.pull_request.milestone.creator.organizations_url | string | required | |
github.event.pull_request.milestone.creator.repos_url | string | required | |
github.event.pull_request.milestone.creator.events_url | string | required | |
github.event.pull_request.milestone.creator.received_events_url | string | required | |
github.event.pull_request.milestone.creator.type | string | required | |
github.event.pull_request.milestone.creator.site_admin | boolean | required | |
github.event.pull_request.milestone.creator.starred_at | string | optional | |
github.event.pull_request.active_lock_reason | string or null | optional | |
github.event.pull_request.assignee | object | required | A GitHub user. |
github.event.pull_request.assignee.name | string or null | optional | |
github.event.pull_request.assignee.node_id | string | required | |
github.event.pull_request.assignee.avatar_url | string | required | |
github.event.pull_request.assignee.gravatar_id | string or null | required | |
github.event.pull_request.assignee.url | string | required | |
github.event.pull_request.assignee.html_url | string | required | |
github.event.pull_request.assignee.followers_url | string | required | |
github.event.pull_request.assignee.following_url | string | required | |
github.event.pull_request.assignee.gists_url | string | required | |
github.event.pull_request.assignee.starred_url | string | required | |
github.event.pull_request.assignee.subscriptions_url | string | required | |
github.event.pull_request.assignee.organizations_url | string | required | |
github.event.pull_request.assignee.repos_url | string | required | |
github.event.pull_request.assignee.events_url | string | required | |
github.event.pull_request.assignee.received_events_url | string | required | |
github.event.pull_request.assignee.type | string | required | |
github.event.pull_request.assignee.site_admin | boolean | required | |
github.event.pull_request.assignee.starred_at | string | optional | |
github.event.pull_request.assignees | array of objects or null | optional | |
github.event.pull_request.assignees.name | string or null | optional | |
github.event.pull_request.assignees.email | string or null | optional | |
github.event.pull_request.assignees.login | string | required | |
github.event.pull_request.assignees.id | integer | required | |
github.event.pull_request.assignees.node_id | string | required | |
github.event.pull_request.assignees.avatar_url | string | required | |
github.event.pull_request.assignees.gravatar_id | string or null | required | |
github.event.pull_request.assignees.url | string | required | |
github.event.pull_request.assignees.html_url | string | required | |
github.event.pull_request.assignees.followers_url | string | required | |
github.event.pull_request.assignees.following_url | string | required | |
github.event.pull_request.assignees.gists_url | string | required | |
github.event.pull_request.assignees.starred_url | string | required | |
github.event.pull_request.assignees.subscriptions_url | string | required | |
github.event.pull_request.assignees.organizations_url | string | required | |
github.event.pull_request.assignees.repos_url | string | required | |
github.event.pull_request.assignees.events_url | string | required | |
github.event.pull_request.assignees.received_events_url | string | required | |
github.event.pull_request.assignees.type | string | required | |
github.event.pull_request.assignees.site_admin | boolean | required | |
github.event.pull_request.assignees.starred_at | string | optional | |
github.event.pull_request.requested_reviewers | array of objects or null | optional | |
github.event.pull_request.requested_reviewers.name | string or null | optional | |
github.event.pull_request.requested_reviewers.email | string or null | optional | |
github.event.pull_request.requested_reviewers.login | string | required | |
github.event.pull_request.requested_reviewers.id | integer | required | |
github.event.pull_request.requested_reviewers.node_id | string | required | |
github.event.pull_request.requested_reviewers.avatar_url | string | required | |
github.event.pull_request.requested_reviewers.gravatar_id | string or null | required | |
github.event.pull_request.requested_reviewers.url | string | required | |
github.event.pull_request.requested_reviewers.html_url | string | required | |
github.event.pull_request.requested_reviewers.followers_url | string | required | |
github.event.pull_request.requested_reviewers.following_url | string | required | |
github.event.pull_request.requested_reviewers.gists_url | string | required | |
github.event.pull_request.requested_reviewers.starred_url | string | required | |
github.event.pull_request.requested_reviewers.subscriptions_url | string | required | |
github.event.pull_request.requested_reviewers.organizations_url | string | required | |
github.event.pull_request.requested_reviewers.repos_url | string | required | |
github.event.pull_request.requested_reviewers.events_url | string | required | |
github.event.pull_request.requested_reviewers.received_events_url | string | required | |
github.event.pull_request.requested_reviewers.type | string | required | |
github.event.pull_request.requested_reviewers.site_admin | boolean | required | |
github.event.pull_request.requested_reviewers.starred_at | string | optional | |
github.event.pull_request.requested_teams | array of objects or null | optional | |
github.event.pull_request.requested_teams.node_id | string | required | |
github.event.pull_request.requested_teams.url | string | required | URL for the team |
github.event.pull_request.requested_teams.members_url | string | required | |
github.event.pull_request.requested_teams.description | string or null | required | Description of the team |
github.event.pull_request.requested_teams.permission | string | required | Permission that the team will have for its repositories |
github.event.pull_request.requested_teams.privacy | string | optional | The level of privacy this team should have |
github.event.pull_request.requested_teams.notification_setting | string | optional | The notification setting the team has set |
github.event.pull_request.requested_teams.html_url | string | required | |
github.event.pull_request.requested_teams.repositories_url | string | required | |
github.event.pull_request.requested_teams.slug | string | required | |
github.event.pull_request.requested_teams.ldap_dn | string | optional | Distinguished Name (DN) that team maps to within LDAP environment |
github.event.pull_request.head.label | string | required | |
github.event.pull_request.head.repo | object or null | required | |
github.event.pull_request.head.repo.owner | object | required | |
github.event.pull_request.head.repo.owner.avatar_url | string | required | |
github.event.pull_request.head.repo.owner.events_url | string | required | |
github.event.pull_request.head.repo.owner.followers_url | string | required | |
github.event.pull_request.head.repo.owner.following_url | string | required | |
github.event.pull_request.head.repo.owner.gists_url | string | required | |
github.event.pull_request.head.repo.owner.gravatar_id | string or null | required | |
github.event.pull_request.head.repo.owner.html_url | string | required | |
github.event.pull_request.head.repo.owner.node_id | string | required | |
github.event.pull_request.head.repo.owner.organizations_url | string | required | |
github.event.pull_request.head.repo.owner.received_events_url | string | required | |
github.event.pull_request.head.repo.owner.repos_url | string | required | |
github.event.pull_request.head.repo.owner.site_admin | boolean | required | |
github.event.pull_request.head.repo.owner.starred_url | string | required | |
github.event.pull_request.head.repo.owner.subscriptions_url | string | required | |
github.event.pull_request.head.repo.owner.type | string | required | |
github.event.pull_request.head.repo.owner.url | string | required | |
github.event.pull_request.head.repo.disabled | boolean | required | |
github.event.pull_request.head.repo.visibility | string | optional | The repository visibility: public, private, or internal. |
github.event.pull_request.head.repo.temp_clone_token | string | optional | |
github.event.pull_request.head.repo.license.spdx_id | string or null | required | |
github.event.pull_request.head.repo.pushed_at | string | required | |
github.event.pull_request.head.repo.topics | array of strings | optional | |
github.event.pull_request.head.repo.created_at | string | required | |
github.event.pull_request.head.user | object | required | |
github.event.pull_request.head.user.avatar_url | string | required | |
github.event.pull_request.head.user.events_url | string | required | |
github.event.pull_request.head.user.followers_url | string | required | |
github.event.pull_request.head.user.following_url | string | required | |
github.event.pull_request.head.user.gists_url | string | required | |
github.event.pull_request.head.user.gravatar_id | string or null | required | |
github.event.pull_request.head.user.html_url | string | required | |
github.event.pull_request.head.user.node_id | string | required | |
github.event.pull_request.head.user.organizations_url | string | required | |
github.event.pull_request.head.user.received_events_url | string | required | |
github.event.pull_request.head.user.repos_url | string | required | |
github.event.pull_request.head.user.site_admin | boolean | required | |
github.event.pull_request.head.user.starred_url | string | required | |
github.event.pull_request.head.user.subscriptions_url | string | required | |
github.event.pull_request.head.user.type | string | required | |
github.event.pull_request.head.user.url | string | required | |
github.event.pull_request.base.label | string | required | |
github.event.pull_request.base.repo.owner | object | required | |
github.event.pull_request.base.repo.owner.avatar_url | string | required | |
github.event.pull_request.base.repo.owner.events_url | string | required | |
github.event.pull_request.base.repo.owner.followers_url | string | required | |
github.event.pull_request.base.repo.owner.following_url | string | required | |
github.event.pull_request.base.repo.owner.gists_url | string | required | |
github.event.pull_request.base.repo.owner.gravatar_id | string or null | required | |
github.event.pull_request.base.repo.owner.html_url | string | required | |
github.event.pull_request.base.repo.owner.node_id | string | required | |
github.event.pull_request.base.repo.owner.organizations_url | string | required | |
github.event.pull_request.base.repo.owner.received_events_url | string | required | |
github.event.pull_request.base.repo.owner.repos_url | string | required | |
github.event.pull_request.base.repo.owner.site_admin | boolean | required | |
github.event.pull_request.base.repo.owner.starred_url | string | required | |
github.event.pull_request.base.repo.owner.subscriptions_url | string | required | |
github.event.pull_request.base.repo.owner.type | string | required | |
github.event.pull_request.base.repo.owner.url | string | required | |
github.event.pull_request.base.repo.disabled | boolean | required | |
github.event.pull_request.base.repo.visibility | string | optional | The repository visibility: public, private, or internal. |
github.event.pull_request.base.repo.temp_clone_token | string | optional | |
github.event.pull_request.base.repo.license | object | required | License Simple |
github.event.pull_request.base.repo.license.spdx_id | string or null | required | |
github.event.pull_request.base.repo.license.html_url | string | optional | |
github.event.pull_request.base.repo.pushed_at | string | required | |
github.event.pull_request.base.repo.topics | array of strings | optional | |
github.event.pull_request.base.repo.created_at | string | required | |
github.event.pull_request.base.user | object | required | |
github.event.pull_request.base.user.avatar_url | string | required | |
github.event.pull_request.base.user.events_url | string | required | |
github.event.pull_request.base.user.followers_url | string | required | |
github.event.pull_request.base.user.following_url | string | required | |
github.event.pull_request.base.user.gists_url | string | required | |
github.event.pull_request.base.user.gravatar_id | string or null | required | |
github.event.pull_request.base.user.html_url | string | required | |
github.event.pull_request.base.user.node_id | string | required | |
github.event.pull_request.base.user.organizations_url | string | required | |
github.event.pull_request.base.user.received_events_url | string | required | |
github.event.pull_request.base.user.repos_url | string | required | |
github.event.pull_request.base.user.site_admin | boolean | required | |
github.event.pull_request.base.user.starred_url | string | required | |
github.event.pull_request.base.user.subscriptions_url | string | required | |
github.event.pull_request.base.user.type | string | required | |
github.event.pull_request.base.user.url | string | required | |
github.event.pull_request.auto_merge.enabled_by | object | required | A GitHub user. |
github.event.pull_request.auto_merge.enabled_by.name | string or null | optional | |
github.event.pull_request.auto_merge.enabled_by.node_id | string | required | |
github.event.pull_request.auto_merge.enabled_by.avatar_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.gravatar_id | string or null | required | |
github.event.pull_request.auto_merge.enabled_by.url | string | required | |
github.event.pull_request.auto_merge.enabled_by.html_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.followers_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.following_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.gists_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.starred_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.subscriptions_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.organizations_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.repos_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.events_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.received_events_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.type | string | required | |
github.event.pull_request.auto_merge.enabled_by.site_admin | boolean | required | |
github.event.pull_request.auto_merge.enabled_by.starred_at | string | optional | |
github.event.pull_request.auto_merge.commit_title | string | required | Title for the merge commit message. |
github.event.pull_request.auto_merge.commit_message | string | required | Commit message for the merge commit. |
github.event.pull_request.draft | boolean | optional | Indicates whether or not the pull request is a draft. |
github.event.pull_request.merged | boolean | required | |
github.event.pull_request.mergeable | boolean or null | required | |
github.event.pull_request.mergeable_state | string | required | |
github.event.pull_request.merged_by | object | required | A GitHub user. |
github.event.pull_request.merged_by.name | string or null | optional | |
github.event.pull_request.merged_by.node_id | string | required | |
github.event.pull_request.merged_by.avatar_url | string | required | |
github.event.pull_request.merged_by.gravatar_id | string or null | required | |
github.event.pull_request.merged_by.url | string | required | |
github.event.pull_request.merged_by.html_url | string | required | |
github.event.pull_request.merged_by.followers_url | string | required | |
github.event.pull_request.merged_by.following_url | string | required | |
github.event.pull_request.merged_by.gists_url | string | required | |
github.event.pull_request.merged_by.starred_url | string | required | |
github.event.pull_request.merged_by.subscriptions_url | string | required | |
github.event.pull_request.merged_by.organizations_url | string | required | |
github.event.pull_request.merged_by.repos_url | string | required | |
github.event.pull_request.merged_by.events_url | string | required | |
github.event.pull_request.merged_by.received_events_url | string | required | |
github.event.pull_request.merged_by.type | string | required | |
github.event.pull_request.merged_by.site_admin | boolean | required | |
github.event.pull_request.merged_by.starred_at | string | optional | |
github.event.pull_request.comments | integer | required | |
github.event.pull_request.review_comments | integer | required | |
github.event.pull_request.maintainer_can_modify | boolean | required | Indicates whether maintainers can modify the pull request. |
github.event.pull_request.commits | integer | required | |
github.event.pull_request.additions | integer | required | |
github.event.pull_request.deletions | integer | required | |
github.event.pull_request.changed_files | integer | required | |
github.event.pull_request.allow_auto_merge | boolean | optional | Whether to allow auto-merge for pull requests. |
github.event.pull_request.allow_update_branch | boolean | optional | Whether to allow updating the pull request’s branch. |
github.event.pull_request.delete_branch_on_merge | boolean | optional | Whether to delete head branches when pull requests are merged. |
github.event.pull_request.merge_commit_message | PR_BODY , PR_TITLE , BLANK | optional | The default value for a merge commit message.
|
github.event.pull_request.merge_commit_title | PR_TITLE , MERGE_MESSAGE | optional | The default value for a merge commit title.
|
github.event.pull_request.squash_merge_commit_message | PR_BODY , COMMIT_MESSAGES , BLANK | optional | The default value for a squash merge commit message:
|
github.event.pull_request.squash_merge_commit_title | PR_TITLE , COMMIT_OR_PR_TITLE | optional | The default value for a squash merge commit title:
|
github.event.pull_request.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 |
github.event.sender | object | required | The GitHub user that triggered the event. This property is included in every webhook payload. |
demilestoned
#
This event occurs when there is activity on a pull request. For more information, see "About pull requests." For information about the APIs to manage pull requests, see the GraphQL API documentation or "Pulls" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review
, pull_request_review_comment
, 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 | demilestoned | required | |
github.event.milestone | object | optional | A collection of related issues and pull requests. |
github.event.milestone.url | string | required | |
github.event.milestone.html_url | string | required | |
github.event.milestone.labels_url | string | required | |
github.event.milestone.id | integer | required | |
github.event.milestone.node_id | string | required | |
github.event.milestone.number | integer | required | The number of the milestone. |
github.event.milestone.state | open , closed | required | The state of the milestone. |
github.event.milestone.title | string | required | The title of the milestone. |
github.event.milestone.description | string or null | required | |
github.event.milestone.creator | object | required | A GitHub user. |
github.event.milestone.creator.name | string or null | optional | |
github.event.milestone.creator.email | string or null | optional | |
github.event.milestone.creator.login | string | required | |
github.event.milestone.creator.id | integer | required | |
github.event.milestone.creator.node_id | string | required | |
github.event.milestone.creator.avatar_url | string | required | |
github.event.milestone.creator.gravatar_id | string or null | required | |
github.event.milestone.creator.url | string | required | |
github.event.milestone.creator.html_url | string | required | |
github.event.milestone.creator.followers_url | string | required | |
github.event.milestone.creator.following_url | string | required | |
github.event.milestone.creator.gists_url | string | required | |
github.event.milestone.creator.starred_url | string | required | |
github.event.milestone.creator.subscriptions_url | string | required | |
github.event.milestone.creator.organizations_url | string | required | |
github.event.milestone.creator.repos_url | string | required | |
github.event.milestone.creator.events_url | string | required | |
github.event.milestone.creator.received_events_url | string | required | |
github.event.milestone.creator.type | string | required | |
github.event.milestone.creator.site_admin | boolean | required | |
github.event.milestone.creator.starred_at | string | optional | |
github.event.milestone.open_issues | integer | required | |
github.event.milestone.closed_issues | integer | required | |
github.event.milestone.created_at | string | required | |
github.event.milestone.updated_at | string | required | |
github.event.milestone.closed_at | string or null | required | |
github.event.milestone.due_on | string or null | required | |
github.event.pull_request.active_lock_reason | resolved , off-topic , too heated , spam , None | required | |
github.event.pull_request.additions | integer | optional | |
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.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.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.type | Bot , User , Organization , Mannequin | optional | |
github.event.pull_request.assignee.url | string | optional | |
github.event.pull_request.assignees | array of object,nulls | required | |
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.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.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.base.label | string | required | |
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_update_branch | boolean | optional | |
github.event.pull_request.base.repo.created_at | integer or string | required | |
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.disabled | boolean | optional | Returns whether or not this repository is disabled. |
github.event.pull_request.base.repo.license | object or null | required | |
github.event.pull_request.base.repo.license.spdx_id | string | required | |
github.event.pull_request.base.repo.merge_commit_message | PR_BODY , PR_TITLE , BLANK | optional | The default value for a merge commit message.
|
github.event.pull_request.base.repo.merge_commit_title | PR_TITLE , MERGE_MESSAGE | optional | The default value for a merge commit title.
|
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.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.public | boolean | optional | |
github.event.pull_request.base.repo.pushed_at | null or integer or string | required | |
github.event.pull_request.base.repo.role_name | string or null | optional | |
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:
|
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:
|
github.event.pull_request.base.repo.stargazers | integer | optional | |
github.event.pull_request.base.repo.topics | array of strings | 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. |
github.event.pull_request.base.repo.visibility | public , private , internal | 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.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.changed_files | integer | optional | |
github.event.pull_request.comments | integer | optional | |
github.event.pull_request.commits | integer | optional | |
github.event.pull_request.deletions | integer | optional | |
github.event.pull_request.draft | boolean | required | Indicates whether or not the pull request is a draft. |
github.event.pull_request.head.label | string | required | |
github.event.pull_request.head.repo | object | 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_update_branch | boolean | optional | |
github.event.pull_request.head.repo.created_at | integer or string | required | |
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.disabled | boolean | optional | Returns whether or not this repository is disabled. |
github.event.pull_request.head.repo.license.spdx_id | string | required | |
github.event.pull_request.head.repo.merge_commit_message | PR_BODY , PR_TITLE , BLANK | optional | The default value for a merge commit message.
|
github.event.pull_request.head.repo.merge_commit_title | PR_TITLE , MERGE_MESSAGE | optional | The default value for a merge commit title.
|
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.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.public | boolean | optional | |
github.event.pull_request.head.repo.pushed_at | null or integer or string | required | |
github.event.pull_request.head.repo.role_name | string or null | optional | |
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:
|
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:
|
github.event.pull_request.head.repo.stargazers | integer | optional | |
github.event.pull_request.head.repo.topics | array of strings | 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. |
github.event.pull_request.head.repo.visibility | public , private , internal | 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.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.maintainer_can_modify | boolean | optional | Indicates whether maintainers can modify the pull request. |
github.event.pull_request.mergeable | boolean or null | optional | |
github.event.pull_request.mergeable_state | string | optional | |
github.event.pull_request.merged | boolean or null | optional | |
github.event.pull_request.merged_by | object or null | optional | |
github.event.pull_request.merged_by.avatar_url | string | optional | |
github.event.pull_request.merged_by.deleted | boolean | optional | |
github.event.pull_request.merged_by.events_url | string | optional | |
github.event.pull_request.merged_by.followers_url | string | optional | |
github.event.pull_request.merged_by.following_url | string | optional | |
github.event.pull_request.merged_by.gists_url | string | optional | |
github.event.pull_request.merged_by.gravatar_id | string | optional | |
github.event.pull_request.merged_by.html_url | string | optional | |
github.event.pull_request.merged_by.name | string | optional | |
github.event.pull_request.merged_by.node_id | string | optional | |
github.event.pull_request.merged_by.organizations_url | string | optional | |
github.event.pull_request.merged_by.received_events_url | string | optional | |
github.event.pull_request.merged_by.repos_url | string | optional | |
github.event.pull_request.merged_by.site_admin | boolean | optional | |
github.event.pull_request.merged_by.starred_url | string | optional | |
github.event.pull_request.merged_by.subscriptions_url | string | optional | |
github.event.pull_request.merged_by.type | Bot , User , Organization , Mannequin | optional | |
github.event.pull_request.merged_by.url | string | optional | |
github.event.pull_request.milestone | object or null | required | A collection of related issues and pull requests. |
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.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.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.type | Bot , User , Organization , Mannequin | optional | |
github.event.pull_request.milestone.creator.url | string | optional | |
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.members_url | string | optional | |
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_comments | integer | optional | |
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.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.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.sender | object | optional | The GitHub user that triggered the event. This property is included in every webhook payload. |
dequeued
#
This event occurs when there is activity on a pull request. For more information, see "About pull requests." For information about the APIs to manage pull requests, see the GraphQL API documentation or "Pulls" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review
, pull_request_review_comment
, 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 | dequeued | required | |
github.event.installation | object | optional | The GitHub App installation. Webhook payloads contain the |
github.event.pull_request.active_lock_reason | resolved , off-topic , too heated , spam , None | required | |
github.event.pull_request.additions | integer | optional | |
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.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.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.type | Bot , User , Organization | optional | |
github.event.pull_request.assignee.url | string | optional | |
github.event.pull_request.assignees | array of object,nulls | required | |
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.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.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.base.label | string | required | |
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_update_branch | boolean | optional | |
github.event.pull_request.base.repo.created_at | integer or string | required | |
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.disabled | boolean | optional | Returns whether or not this repository is disabled. |
github.event.pull_request.base.repo.license | object or null | required | |
github.event.pull_request.base.repo.license.spdx_id | string | required | |
github.event.pull_request.base.repo.merge_commit_message | PR_BODY , PR_TITLE , BLANK | optional | The default value for a merge commit message.
|
github.event.pull_request.base.repo.merge_commit_title | PR_TITLE , MERGE_MESSAGE | optional | The default value for a merge commit title.
|
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.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.public | boolean | optional | |
github.event.pull_request.base.repo.pushed_at | null or integer or string | required | |
github.event.pull_request.base.repo.role_name | string or null | optional | |
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:
|
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:
|
github.event.pull_request.base.repo.stargazers | integer | optional | |
github.event.pull_request.base.repo.topics | array of strings | 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 |
github.event.pull_request.base.repo.visibility | public , private , internal | 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.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.changed_files | integer | optional | |
github.event.pull_request.comments | integer | optional | |
github.event.pull_request.commits | integer | optional | |
github.event.pull_request.deletions | integer | optional | |
github.event.pull_request.draft | boolean | required | Indicates whether or not the pull request is a draft. |
github.event.pull_request.head.label | string | required | |
github.event.pull_request.head.repo | object | 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_update_branch | boolean | optional | |
github.event.pull_request.head.repo.created_at | integer or string | required | |
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.disabled | boolean | optional | Returns whether or not this repository is disabled. |
github.event.pull_request.head.repo.license.spdx_id | string | required | |
github.event.pull_request.head.repo.merge_commit_message | PR_BODY , PR_TITLE , BLANK | optional | The default value for a merge commit message.
|
github.event.pull_request.head.repo.merge_commit_title | PR_TITLE , MERGE_MESSAGE | optional | The default value for a merge commit title.
|
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.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.public | boolean | optional | |
github.event.pull_request.head.repo.pushed_at | null or integer or string | required | |
github.event.pull_request.head.repo.role_name | string or null | optional | |
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:
|
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:
|
github.event.pull_request.head.repo.stargazers | integer | optional | |
github.event.pull_request.head.repo.topics | array of strings | 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 |
github.event.pull_request.head.repo.visibility | public , private , internal | 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.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.maintainer_can_modify | boolean | optional | Indicates whether maintainers can modify the pull request. |
github.event.pull_request.mergeable | boolean or null | optional | |
github.event.pull_request.mergeable_state | string | optional | |
github.event.pull_request.merged | boolean or null | optional | |
github.event.pull_request.merged_by | object or null | optional | |
github.event.pull_request.merged_by.avatar_url | string | optional | |
github.event.pull_request.merged_by.deleted | boolean | optional | |
github.event.pull_request.merged_by.events_url | string | optional | |
github.event.pull_request.merged_by.followers_url | string | optional | |
github.event.pull_request.merged_by.following_url | string | optional | |
github.event.pull_request.merged_by.gists_url | string | optional | |
github.event.pull_request.merged_by.gravatar_id | string | optional | |
github.event.pull_request.merged_by.html_url | string | optional | |
github.event.pull_request.merged_by.name | string | optional | |
github.event.pull_request.merged_by.node_id | string | optional | |
github.event.pull_request.merged_by.organizations_url | string | optional | |
github.event.pull_request.merged_by.received_events_url | string | optional | |
github.event.pull_request.merged_by.repos_url | string | optional | |
github.event.pull_request.merged_by.site_admin | boolean | optional | |
github.event.pull_request.merged_by.starred_url | string | optional | |
github.event.pull_request.merged_by.subscriptions_url | string | optional | |
github.event.pull_request.merged_by.type | Bot , User , Organization | optional | |
github.event.pull_request.merged_by.url | string | optional | |
github.event.pull_request.milestone | object or null | required | A collection of related issues and pull requests. |
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.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.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.type | Bot , User , Organization , Mannequin | optional | |
github.event.pull_request.milestone.creator.url | string | optional | |
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.members_url | string | optional | |
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_comments | integer | optional | |
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.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.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.reason | string | required | |
github.event.sender | object | required | The GitHub user that triggered the event. This property is included in every webhook payload. |
edited
#
This event occurs when there is activity on a pull request. For more information, see "About pull requests." For information about the APIs to manage pull requests, see the GraphQL API documentation or "Pulls" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review
, pull_request_review_comment
, 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 if the action was |
github.event.changes.base | object | optional | |
github.event.changes.base.ref | object | required | |
github.event.changes.base.ref.from | string | required | |
github.event.changes.base.sha | object | required | |
github.event.changes.base.sha.from | string | required | |
github.event.changes.body | object | optional | |
github.event.changes.body.from | string | required | The previous version of the body if the action was |
github.event.changes.title | object | optional | |
github.event.changes.title.from | string | required | The previous version of the title if the action was |
github.event.installation | object | optional | The GitHub App installation. Webhook payloads contain the |
github.event.pull_request.user | object | required | A GitHub user. |
github.event.pull_request.user.name | string or null | optional | |
github.event.pull_request.user.node_id | string | required | |
github.event.pull_request.user.avatar_url | string | required | |
github.event.pull_request.user.gravatar_id | string or null | required | |
github.event.pull_request.user.url | string | required | |
github.event.pull_request.user.html_url | string | required | |
github.event.pull_request.user.followers_url | string | required | |
github.event.pull_request.user.following_url | string | required | |
github.event.pull_request.user.gists_url | string | required | |
github.event.pull_request.user.starred_url | string | required | |
github.event.pull_request.user.subscriptions_url | string | required | |
github.event.pull_request.user.organizations_url | string | required | |
github.event.pull_request.user.repos_url | string | required | |
github.event.pull_request.user.events_url | string | required | |
github.event.pull_request.user.received_events_url | string | required | |
github.event.pull_request.user.type | string | required | |
github.event.pull_request.user.site_admin | boolean | required | |
github.event.pull_request.user.starred_at | string | optional | |
github.event.pull_request.milestone | object | required | A collection of related issues and pull requests. |
github.event.pull_request.milestone.creator | object | required | A GitHub user. |
github.event.pull_request.milestone.creator.name | string or null | optional | |
github.event.pull_request.milestone.creator.node_id | string | required | |
github.event.pull_request.milestone.creator.avatar_url | string | required | |
github.event.pull_request.milestone.creator.gravatar_id | string or null | required | |
github.event.pull_request.milestone.creator.url | string | required | |
github.event.pull_request.milestone.creator.html_url | string | required | |
github.event.pull_request.milestone.creator.followers_url | string | required | |
github.event.pull_request.milestone.creator.following_url | string | required | |
github.event.pull_request.milestone.creator.gists_url | string | required | |
github.event.pull_request.milestone.creator.starred_url | string | required | |
github.event.pull_request.milestone.creator.subscriptions_url | string | required | |
github.event.pull_request.milestone.creator.organizations_url | string | required | |
github.event.pull_request.milestone.creator.repos_url | string | required | |
github.event.pull_request.milestone.creator.events_url | string | required | |
github.event.pull_request.milestone.creator.received_events_url | string | required | |
github.event.pull_request.milestone.creator.type | string | required | |
github.event.pull_request.milestone.creator.site_admin | boolean | required | |
github.event.pull_request.milestone.creator.starred_at | string | optional | |
github.event.pull_request.active_lock_reason | string or null | optional | |
github.event.pull_request.assignee | object | required | A GitHub user. |
github.event.pull_request.assignee.name | string or null | optional | |
github.event.pull_request.assignee.node_id | string | required | |
github.event.pull_request.assignee.avatar_url | string | required | |
github.event.pull_request.assignee.gravatar_id | string or null | required | |
github.event.pull_request.assignee.url | string | required | |
github.event.pull_request.assignee.html_url | string | required | |
github.event.pull_request.assignee.followers_url | string | required | |
github.event.pull_request.assignee.following_url | string | required | |
github.event.pull_request.assignee.gists_url | string | required | |
github.event.pull_request.assignee.starred_url | string | required | |
github.event.pull_request.assignee.subscriptions_url | string | required | |
github.event.pull_request.assignee.organizations_url | string | required | |
github.event.pull_request.assignee.repos_url | string | required | |
github.event.pull_request.assignee.events_url | string | required | |
github.event.pull_request.assignee.received_events_url | string | required | |
github.event.pull_request.assignee.type | string | required | |
github.event.pull_request.assignee.site_admin | boolean | required | |
github.event.pull_request.assignee.starred_at | string | optional | |
github.event.pull_request.assignees | array of objects or null | optional | |
github.event.pull_request.assignees.name | string or null | optional | |
github.event.pull_request.assignees.email | string or null | optional | |
github.event.pull_request.assignees.login | string | required | |
github.event.pull_request.assignees.id | integer | required | |
github.event.pull_request.assignees.node_id | string | required | |
github.event.pull_request.assignees.avatar_url | string | required | |
github.event.pull_request.assignees.gravatar_id | string or null | required | |
github.event.pull_request.assignees.url | string | required | |
github.event.pull_request.assignees.html_url | string | required | |
github.event.pull_request.assignees.followers_url | string | required | |
github.event.pull_request.assignees.following_url | string | required | |
github.event.pull_request.assignees.gists_url | string | required | |
github.event.pull_request.assignees.starred_url | string | required | |
github.event.pull_request.assignees.subscriptions_url | string | required | |
github.event.pull_request.assignees.organizations_url | string | required | |
github.event.pull_request.assignees.repos_url | string | required | |
github.event.pull_request.assignees.events_url | string | required | |
github.event.pull_request.assignees.received_events_url | string | required | |
github.event.pull_request.assignees.type | string | required | |
github.event.pull_request.assignees.site_admin | boolean | required | |
github.event.pull_request.assignees.starred_at | string | optional | |
github.event.pull_request.requested_reviewers | array of objects or null | optional | |
github.event.pull_request.requested_reviewers.name | string or null | optional | |
github.event.pull_request.requested_reviewers.email | string or null | optional | |
github.event.pull_request.requested_reviewers.login | string | required | |
github.event.pull_request.requested_reviewers.id | integer | required | |
github.event.pull_request.requested_reviewers.node_id | string | required | |
github.event.pull_request.requested_reviewers.avatar_url | string | required | |
github.event.pull_request.requested_reviewers.gravatar_id | string or null | required | |
github.event.pull_request.requested_reviewers.url | string | required | |
github.event.pull_request.requested_reviewers.html_url | string | required | |
github.event.pull_request.requested_reviewers.followers_url | string | required | |
github.event.pull_request.requested_reviewers.following_url | string | required | |
github.event.pull_request.requested_reviewers.gists_url | string | required | |
github.event.pull_request.requested_reviewers.starred_url | string | required | |
github.event.pull_request.requested_reviewers.subscriptions_url | string | required | |
github.event.pull_request.requested_reviewers.organizations_url | string | required | |
github.event.pull_request.requested_reviewers.repos_url | string | required | |
github.event.pull_request.requested_reviewers.events_url | string | required | |
github.event.pull_request.requested_reviewers.received_events_url | string | required | |
github.event.pull_request.requested_reviewers.type | string | required | |
github.event.pull_request.requested_reviewers.site_admin | boolean | required | |
github.event.pull_request.requested_reviewers.starred_at | string | optional | |
github.event.pull_request.requested_teams | array of objects or null | optional | |
github.event.pull_request.requested_teams.node_id | string | required | |
github.event.pull_request.requested_teams.url | string | required | URL for the team |
github.event.pull_request.requested_teams.members_url | string | required | |
github.event.pull_request.requested_teams.description | string or null | required | Description of the team |
github.event.pull_request.requested_teams.permission | string | required | Permission that the team will have for its repositories |
github.event.pull_request.requested_teams.privacy | string | optional | The level of privacy this team should have |
github.event.pull_request.requested_teams.notification_setting | string | optional | The notification setting the team has set |
github.event.pull_request.requested_teams.html_url | string | required | |
github.event.pull_request.requested_teams.repositories_url | string | required | |
github.event.pull_request.requested_teams.slug | string | required | |
github.event.pull_request.requested_teams.ldap_dn | string | optional | Distinguished Name (DN) that team maps to within LDAP environment |
github.event.pull_request.head.label | string | required | |
github.event.pull_request.head.repo | object or null | required | |
github.event.pull_request.head.repo.owner | object | required | |
github.event.pull_request.head.repo.owner.avatar_url | string | required | |
github.event.pull_request.head.repo.owner.events_url | string | required | |
github.event.pull_request.head.repo.owner.followers_url | string | required | |
github.event.pull_request.head.repo.owner.following_url | string | required | |
github.event.pull_request.head.repo.owner.gists_url | string | required | |
github.event.pull_request.head.repo.owner.gravatar_id | string or null | required | |
github.event.pull_request.head.repo.owner.html_url | string | required | |
github.event.pull_request.head.repo.owner.node_id | string | required | |
github.event.pull_request.head.repo.owner.organizations_url | string | required | |
github.event.pull_request.head.repo.owner.received_events_url | string | required | |
github.event.pull_request.head.repo.owner.repos_url | string | required | |
github.event.pull_request.head.repo.owner.site_admin | boolean | required | |
github.event.pull_request.head.repo.owner.starred_url | string | required | |
github.event.pull_request.head.repo.owner.subscriptions_url | string | required | |
github.event.pull_request.head.repo.owner.type | string | required | |
github.event.pull_request.head.repo.owner.url | string | required | |
github.event.pull_request.head.repo.disabled | boolean | required | |
github.event.pull_request.head.repo.visibility | string | optional | The repository visibility: public, private, or internal. |
github.event.pull_request.head.repo.temp_clone_token | string | optional | |
github.event.pull_request.head.repo.license.spdx_id | string or null | required | |
github.event.pull_request.head.repo.pushed_at | string | required | |
github.event.pull_request.head.repo.topics | array of strings | optional | |
github.event.pull_request.head.repo.created_at | string | required | |
github.event.pull_request.head.user | object | required | |
github.event.pull_request.head.user.avatar_url | string | required | |
github.event.pull_request.head.user.events_url | string | required | |
github.event.pull_request.head.user.followers_url | string | required | |
github.event.pull_request.head.user.following_url | string | required | |
github.event.pull_request.head.user.gists_url | string | required | |
github.event.pull_request.head.user.gravatar_id | string or null | required | |
github.event.pull_request.head.user.html_url | string | required | |
github.event.pull_request.head.user.node_id | string | required | |
github.event.pull_request.head.user.organizations_url | string | required | |
github.event.pull_request.head.user.received_events_url | string | required | |
github.event.pull_request.head.user.repos_url | string | required | |
github.event.pull_request.head.user.site_admin | boolean | required | |
github.event.pull_request.head.user.starred_url | string | required | |
github.event.pull_request.head.user.subscriptions_url | string | required | |
github.event.pull_request.head.user.type | string | required | |
github.event.pull_request.head.user.url | string | required | |
github.event.pull_request.base.label | string | required | |
github.event.pull_request.base.repo.owner | object | required | |
github.event.pull_request.base.repo.owner.avatar_url | string | required | |
github.event.pull_request.base.repo.owner.events_url | string | required | |
github.event.pull_request.base.repo.owner.followers_url | string | required | |
github.event.pull_request.base.repo.owner.following_url | string | required | |
github.event.pull_request.base.repo.owner.gists_url | string | required | |
github.event.pull_request.base.repo.owner.gravatar_id | string or null | required | |
github.event.pull_request.base.repo.owner.html_url | string | required | |
github.event.pull_request.base.repo.owner.node_id | string | required | |
github.event.pull_request.base.repo.owner.organizations_url | string | required | |
github.event.pull_request.base.repo.owner.received_events_url | string | required | |
github.event.pull_request.base.repo.owner.repos_url | string | required | |
github.event.pull_request.base.repo.owner.site_admin | boolean | required | |
github.event.pull_request.base.repo.owner.starred_url | string | required | |
github.event.pull_request.base.repo.owner.subscriptions_url | string | required | |
github.event.pull_request.base.repo.owner.type | string | required | |
github.event.pull_request.base.repo.owner.url | string | required | |
github.event.pull_request.base.repo.disabled | boolean | required | |
github.event.pull_request.base.repo.visibility | string | optional | The repository visibility: public, private, or internal. |
github.event.pull_request.base.repo.temp_clone_token | string | optional | |
github.event.pull_request.base.repo.license | object | required | License Simple |
github.event.pull_request.base.repo.license.spdx_id | string or null | required | |
github.event.pull_request.base.repo.license.html_url | string | optional | |
github.event.pull_request.base.repo.pushed_at | string | required | |
github.event.pull_request.base.repo.topics | array of strings | optional | |
github.event.pull_request.base.repo.created_at | string | required | |
github.event.pull_request.base.user | object | required | |
github.event.pull_request.base.user.avatar_url | string | required | |
github.event.pull_request.base.user.events_url | string | required | |
github.event.pull_request.base.user.followers_url | string | required | |
github.event.pull_request.base.user.following_url | string | required | |
github.event.pull_request.base.user.gists_url | string | required | |
github.event.pull_request.base.user.gravatar_id | string or null | required | |
github.event.pull_request.base.user.html_url | string | required | |
github.event.pull_request.base.user.node_id | string | required | |
github.event.pull_request.base.user.organizations_url | string | required | |
github.event.pull_request.base.user.received_events_url | string | required | |
github.event.pull_request.base.user.repos_url | string | required | |
github.event.pull_request.base.user.site_admin | boolean | required | |
github.event.pull_request.base.user.starred_url | string | required | |
github.event.pull_request.base.user.subscriptions_url | string | required | |
github.event.pull_request.base.user.type | string | required | |
github.event.pull_request.base.user.url | string | required | |
github.event.pull_request.auto_merge.enabled_by | object | required | A GitHub user. |
github.event.pull_request.auto_merge.enabled_by.name | string or null | optional | |
github.event.pull_request.auto_merge.enabled_by.node_id | string | required | |
github.event.pull_request.auto_merge.enabled_by.avatar_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.gravatar_id | string or null | required | |
github.event.pull_request.auto_merge.enabled_by.url | string | required | |
github.event.pull_request.auto_merge.enabled_by.html_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.followers_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.following_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.gists_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.starred_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.subscriptions_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.organizations_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.repos_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.events_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.received_events_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.type | string | required | |
github.event.pull_request.auto_merge.enabled_by.site_admin | boolean | required | |
github.event.pull_request.auto_merge.enabled_by.starred_at | string | optional | |
github.event.pull_request.auto_merge.commit_title | string | required | Title for the merge commit message. |
github.event.pull_request.auto_merge.commit_message | string | required | Commit message for the merge commit. |
github.event.pull_request.draft | boolean | optional | Indicates whether or not the pull request is a draft. |
github.event.pull_request.merged | boolean | required | |
github.event.pull_request.mergeable | boolean or null | required | |
github.event.pull_request.mergeable_state | string | required | |
github.event.pull_request.merged_by | object | required | A GitHub user. |
github.event.pull_request.merged_by.name | string or null | optional | |
github.event.pull_request.merged_by.node_id | string | required | |
github.event.pull_request.merged_by.avatar_url | string | required | |
github.event.pull_request.merged_by.gravatar_id | string or null | required | |
github.event.pull_request.merged_by.url | string | required | |
github.event.pull_request.merged_by.html_url | string | required | |
github.event.pull_request.merged_by.followers_url | string | required | |
github.event.pull_request.merged_by.following_url | string | required | |
github.event.pull_request.merged_by.gists_url | string | required | |
github.event.pull_request.merged_by.starred_url | string | required | |
github.event.pull_request.merged_by.subscriptions_url | string | required | |
github.event.pull_request.merged_by.organizations_url | string | required | |
github.event.pull_request.merged_by.repos_url | string | required | |
github.event.pull_request.merged_by.events_url | string | required | |
github.event.pull_request.merged_by.received_events_url | string | required | |
github.event.pull_request.merged_by.type | string | required | |
github.event.pull_request.merged_by.site_admin | boolean | required | |
github.event.pull_request.merged_by.starred_at | string | optional | |
github.event.pull_request.comments | integer | required | |
github.event.pull_request.review_comments | integer | required | |
github.event.pull_request.maintainer_can_modify | boolean | required | Indicates whether maintainers can modify the pull request. |
github.event.pull_request.commits | integer | required | |
github.event.pull_request.additions | integer | required | |
github.event.pull_request.deletions | integer | required | |
github.event.pull_request.changed_files | integer | required | |
github.event.pull_request.allow_auto_merge | boolean | optional | Whether to allow auto-merge for pull requests. |
github.event.pull_request.allow_update_branch | boolean | optional | Whether to allow updating the pull request’s branch. |
github.event.pull_request.delete_branch_on_merge | boolean | optional | Whether to delete head branches when pull requests are merged. |
github.event.pull_request.merge_commit_message | PR_BODY , PR_TITLE , BLANK | optional | The default value for a merge commit message.
|
github.event.pull_request.merge_commit_title | PR_TITLE , MERGE_MESSAGE | optional | The default value for a merge commit title.
|
github.event.pull_request.squash_merge_commit_message | PR_BODY , COMMIT_MESSAGES , BLANK | optional | The default value for a squash merge commit message:
|
github.event.pull_request.squash_merge_commit_title | PR_TITLE , COMMIT_OR_PR_TITLE | optional | The default value for a squash merge commit title:
|
github.event.pull_request.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 |
github.event.sender | object | optional | The GitHub user that triggered the event. This property is included in every webhook payload. |
enqueued
#
This event occurs when there is activity on a pull request. For more information, see "About pull requests." For information about the APIs to manage pull requests, see the GraphQL API documentation or "Pulls" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review
, pull_request_review_comment
, 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 | enqueued | required | |
github.event.installation | object | optional | The GitHub App installation. Webhook payloads contain the |
github.event.pull_request.active_lock_reason | resolved , off-topic , too heated , spam , None | required | |
github.event.pull_request.additions | integer | optional | |
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.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.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.type | Bot , User , Organization | optional | |
github.event.pull_request.assignee.url | string | optional | |
github.event.pull_request.assignees | array of object,nulls | required | |
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.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.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.base.label | string | required | |
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_update_branch | boolean | optional | |
github.event.pull_request.base.repo.created_at | integer or string | required | |
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.disabled | boolean | optional | Returns whether or not this repository is disabled. |
github.event.pull_request.base.repo.license | object or null | required | |
github.event.pull_request.base.repo.license.spdx_id | string | required | |
github.event.pull_request.base.repo.merge_commit_message | PR_BODY , PR_TITLE , BLANK | optional | The default value for a merge commit message.
|
github.event.pull_request.base.repo.merge_commit_title | PR_TITLE , MERGE_MESSAGE | optional | The default value for a merge commit title.
|
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.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.public | boolean | optional | |
github.event.pull_request.base.repo.pushed_at | null or integer or string | required | |
github.event.pull_request.base.repo.role_name | string or null | optional | |
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:
|
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:
|
github.event.pull_request.base.repo.stargazers | integer | optional | |
github.event.pull_request.base.repo.topics | array of strings | 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 |
github.event.pull_request.base.repo.visibility | public , private , internal | 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.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.changed_files | integer | optional | |
github.event.pull_request.comments | integer | optional | |
github.event.pull_request.commits | integer | optional | |
github.event.pull_request.deletions | integer | optional | |
github.event.pull_request.draft | boolean | required | Indicates whether or not the pull request is a draft. |
github.event.pull_request.head.label | string | required | |
github.event.pull_request.head.repo | object | 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_update_branch | boolean | optional | |
github.event.pull_request.head.repo.created_at | integer or string | required | |
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.disabled | boolean | optional | Returns whether or not this repository is disabled. |
github.event.pull_request.head.repo.license.spdx_id | string | required | |
github.event.pull_request.head.repo.merge_commit_message | PR_BODY , PR_TITLE , BLANK | optional | The default value for a merge commit message.
|
github.event.pull_request.head.repo.merge_commit_title | PR_TITLE , MERGE_MESSAGE | optional | The default value for a merge commit title.
|
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.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.public | boolean | optional | |
github.event.pull_request.head.repo.pushed_at | null or integer or string | required | |
github.event.pull_request.head.repo.role_name | string or null | optional | |
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:
|
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:
|
github.event.pull_request.head.repo.stargazers | integer | optional | |
github.event.pull_request.head.repo.topics | array of strings | 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 |
github.event.pull_request.head.repo.visibility | public , private , internal | 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.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.maintainer_can_modify | boolean | optional | Indicates whether maintainers can modify the pull request. |
github.event.pull_request.mergeable | boolean or null | optional | |
github.event.pull_request.mergeable_state | string | optional | |
github.event.pull_request.merged | boolean or null | optional | |
github.event.pull_request.merged_by | object or null | optional | |
github.event.pull_request.merged_by.avatar_url | string | optional | |
github.event.pull_request.merged_by.deleted | boolean | optional | |
github.event.pull_request.merged_by.events_url | string | optional | |
github.event.pull_request.merged_by.followers_url | string | optional | |
github.event.pull_request.merged_by.following_url | string | optional | |
github.event.pull_request.merged_by.gists_url | string | optional | |
github.event.pull_request.merged_by.gravatar_id | string | optional | |
github.event.pull_request.merged_by.html_url | string | optional | |
github.event.pull_request.merged_by.name | string | optional | |
github.event.pull_request.merged_by.node_id | string | optional | |
github.event.pull_request.merged_by.organizations_url | string | optional | |
github.event.pull_request.merged_by.received_events_url | string | optional | |
github.event.pull_request.merged_by.repos_url | string | optional | |
github.event.pull_request.merged_by.site_admin | boolean | optional | |
github.event.pull_request.merged_by.starred_url | string | optional | |
github.event.pull_request.merged_by.subscriptions_url | string | optional | |
github.event.pull_request.merged_by.type | Bot , User , Organization | optional | |
github.event.pull_request.merged_by.url | string | optional | |
github.event.pull_request.milestone | object or null | required | A collection of related issues and pull requests. |
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.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.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.type | Bot , User , Organization , Mannequin | optional | |
github.event.pull_request.milestone.creator.url | string | optional | |
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.members_url | string | optional | |
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_comments | integer | optional | |
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.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.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.sender | object | required | The GitHub user that triggered the event. This property is included in every webhook payload. |
labeled
#
This event occurs when there is activity on a pull request. For more information, see "About pull requests." For information about the APIs to manage pull requests, see the GraphQL API documentation or "Pulls" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review
, pull_request_review_comment
, 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 | labeled | required | |
github.event.installation | object | optional | The GitHub App installation. Webhook payloads contain the |
github.event.label | object | optional | |
github.event.label.color | string | required | 6-character hex code, without the leading #, identifying the color |
github.event.label.default | boolean | required | |
github.event.label.description | string or null | required | |
github.event.label.id | integer | required | |
github.event.label.name | string | required | The name of the label. |
github.event.label.node_id | string | required | |
github.event.label.url | string | required | URL for the label |
github.event.pull_request.active_lock_reason | resolved , off-topic , too heated , spam , None | required | |
github.event.pull_request.additions | integer | optional | |
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.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.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.type | Bot , User , Organization , Mannequin | optional | |
github.event.pull_request.assignee.url | string | optional | |
github.event.pull_request.assignees | array of object,nulls | required | |
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.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.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.base.label | string | required | |
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_update_branch | boolean | optional | |
github.event.pull_request.base.repo.created_at | integer or string | required | |
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.disabled | boolean | optional | Returns whether or not this repository is disabled. |
github.event.pull_request.base.repo.license | object or null | required | |
github.event.pull_request.base.repo.license.spdx_id | string | required | |
github.event.pull_request.base.repo.merge_commit_message | PR_BODY , PR_TITLE , BLANK | optional | The default value for a merge commit message.
|
github.event.pull_request.base.repo.merge_commit_title | PR_TITLE , MERGE_MESSAGE | optional | The default value for a merge commit title.
|
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.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.public | boolean | optional | |
github.event.pull_request.base.repo.pushed_at | null or integer or string | required | |
github.event.pull_request.base.repo.role_name | string or null | optional | |
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:
|
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:
|
github.event.pull_request.base.repo.stargazers | integer | optional | |
github.event.pull_request.base.repo.topics | array of strings | 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 |
github.event.pull_request.base.repo.visibility | public , private , internal | 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.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.changed_files | integer | optional | |
github.event.pull_request.comments | integer | optional | |
github.event.pull_request.commits | integer | optional | |
github.event.pull_request.deletions | integer | optional | |
github.event.pull_request.draft | boolean | required | Indicates whether or not the pull request is a draft. |
github.event.pull_request.head.label | string or null | 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_update_branch | boolean | optional | |
github.event.pull_request.head.repo.created_at | integer or string | required | |
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.disabled | boolean | optional | Returns whether or not this repository is disabled. |
github.event.pull_request.head.repo.license.spdx_id | string | required | |
github.event.pull_request.head.repo.merge_commit_message | PR_BODY , PR_TITLE , BLANK | optional | The default value for a merge commit message.
|
github.event.pull_request.head.repo.merge_commit_title | PR_TITLE , MERGE_MESSAGE | optional | The default value for a merge commit title.
|
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.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.public | boolean | optional | |
github.event.pull_request.head.repo.pushed_at | null or integer or string | required | |
github.event.pull_request.head.repo.role_name | string or null | optional | |
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:
|
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:
|
github.event.pull_request.head.repo.stargazers | integer | optional | |
github.event.pull_request.head.repo.topics | array of strings | 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 |
github.event.pull_request.head.repo.visibility | public , private , internal | 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.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.maintainer_can_modify | boolean | optional | Indicates whether maintainers can modify the pull request. |
github.event.pull_request.mergeable | boolean or null | optional | |
github.event.pull_request.mergeable_state | string | optional | |
github.event.pull_request.merged | boolean or null | optional | |
github.event.pull_request.merged_by | object or null | optional | |
github.event.pull_request.merged_by.avatar_url | string | optional | |
github.event.pull_request.merged_by.deleted | boolean | optional | |
github.event.pull_request.merged_by.events_url | string | optional | |
github.event.pull_request.merged_by.followers_url | string | optional | |
github.event.pull_request.merged_by.following_url | string | optional | |
github.event.pull_request.merged_by.gists_url | string | optional | |
github.event.pull_request.merged_by.gravatar_id | string | optional | |
github.event.pull_request.merged_by.html_url | string | optional | |
github.event.pull_request.merged_by.name | string | optional | |
github.event.pull_request.merged_by.node_id | string | optional | |
github.event.pull_request.merged_by.organizations_url | string | optional | |
github.event.pull_request.merged_by.received_events_url | string | optional | |
github.event.pull_request.merged_by.repos_url | string | optional | |
github.event.pull_request.merged_by.site_admin | boolean | optional | |
github.event.pull_request.merged_by.starred_url | string | optional | |
github.event.pull_request.merged_by.subscriptions_url | string | optional | |
github.event.pull_request.merged_by.type | Bot , User , Organization , Mannequin | optional | |
github.event.pull_request.merged_by.url | string | optional | |
github.event.pull_request.milestone | object or null | required | A collection of related issues and pull requests. |
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.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.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.type | Bot , User , Organization , Mannequin | optional | |
github.event.pull_request.milestone.creator.url | string | optional | |
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.members_url | string | optional | |
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_comments | integer | optional | |
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.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.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.sender | object | required | The GitHub user that triggered the event. This property is included in every webhook payload. |
locked
#
This event occurs when there is activity on a pull request. For more information, see "About pull requests." For information about the APIs to manage pull requests, see the GraphQL API documentation or "Pulls" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review
, pull_request_review_comment
, 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 | locked | required | |
github.event.installation | object | optional | The GitHub App installation. Webhook payloads contain the |
github.event.pull_request.active_lock_reason | resolved , off-topic , too heated , spam , None | required | |
github.event.pull_request.additions | integer | optional | |
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.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.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.type | Bot , User , Organization | optional | |
github.event.pull_request.assignee.url | string | optional | |
github.event.pull_request.assignees | array of object,nulls | required | |
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.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.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.base.label | string | required | |
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_update_branch | boolean | optional | |
github.event.pull_request.base.repo.created_at | integer or string | required | |
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.disabled | boolean | optional | Returns whether or not this repository is disabled. |
github.event.pull_request.base.repo.license | object or null | required | |
github.event.pull_request.base.repo.license.spdx_id | string | required | |
github.event.pull_request.base.repo.merge_commit_message | PR_BODY , PR_TITLE , BLANK | optional | The default value for a merge commit message.
|
github.event.pull_request.base.repo.merge_commit_title | PR_TITLE , MERGE_MESSAGE | optional | The default value for a merge commit title.
|
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.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.public | boolean | optional | |
github.event.pull_request.base.repo.pushed_at | null or integer or string | required | |
github.event.pull_request.base.repo.role_name | string or null | optional | |
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:
|
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:
|
github.event.pull_request.base.repo.stargazers | integer | optional | |
github.event.pull_request.base.repo.topics | array of strings | 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 |
github.event.pull_request.base.repo.visibility | public , private , internal | 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.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.changed_files | integer | optional | |
github.event.pull_request.comments | integer | optional | |
github.event.pull_request.commits | integer | optional | |
github.event.pull_request.deletions | integer | optional | |
github.event.pull_request.draft | boolean | required | Indicates whether or not the pull request is a draft. |
github.event.pull_request.head.label | string or null | 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_update_branch | boolean | optional | |
github.event.pull_request.head.repo.created_at | integer or string | required | |
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.disabled | boolean | optional | Returns whether or not this repository is disabled. |
github.event.pull_request.head.repo.license.spdx_id | string | required | |
github.event.pull_request.head.repo.merge_commit_message | PR_BODY , PR_TITLE , BLANK | optional | The default value for a merge commit message.
|
github.event.pull_request.head.repo.merge_commit_title | PR_TITLE , MERGE_MESSAGE | optional | The default value for a merge commit title.
|
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.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.public | boolean | optional | |
github.event.pull_request.head.repo.pushed_at | null or integer or string | required | |
github.event.pull_request.head.repo.role_name | string or null | optional | |
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:
|
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:
|
github.event.pull_request.head.repo.stargazers | integer | optional | |
github.event.pull_request.head.repo.topics | array of strings | 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 |
github.event.pull_request.head.repo.visibility | public , private , internal | 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.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.maintainer_can_modify | boolean | optional | Indicates whether maintainers can modify the pull request. |
github.event.pull_request.mergeable | boolean or null | optional | |
github.event.pull_request.mergeable_state | string | optional | |
github.event.pull_request.merged | boolean or null | optional | |
github.event.pull_request.merged_by | object or null | optional | |
github.event.pull_request.merged_by.avatar_url | string | optional | |
github.event.pull_request.merged_by.deleted | boolean | optional | |
github.event.pull_request.merged_by.events_url | string | optional | |
github.event.pull_request.merged_by.followers_url | string | optional | |
github.event.pull_request.merged_by.following_url | string | optional | |
github.event.pull_request.merged_by.gists_url | string | optional | |
github.event.pull_request.merged_by.gravatar_id | string | optional | |
github.event.pull_request.merged_by.html_url | string | optional | |
github.event.pull_request.merged_by.name | string | optional | |
github.event.pull_request.merged_by.node_id | string | optional | |
github.event.pull_request.merged_by.organizations_url | string | optional | |
github.event.pull_request.merged_by.received_events_url | string | optional | |
github.event.pull_request.merged_by.repos_url | string | optional | |
github.event.pull_request.merged_by.site_admin | boolean | optional | |
github.event.pull_request.merged_by.starred_url | string | optional | |
github.event.pull_request.merged_by.subscriptions_url | string | optional | |
github.event.pull_request.merged_by.type | Bot , User , Organization , Mannequin | optional | |
github.event.pull_request.merged_by.url | string | optional | |
github.event.pull_request.milestone | object or null | required | A collection of related issues and pull requests. |
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.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.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.type | Bot , User , Organization | optional | |
github.event.pull_request.milestone.creator.url | string | optional | |
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.members_url | string | optional | |
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_comments | integer | optional | |
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.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.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.sender | object | required | The GitHub user that triggered the event. This property is included in every webhook payload. |
milestoned
#
This event occurs when there is activity on a pull request. For more information, see "About pull requests." For information about the APIs to manage pull requests, see the GraphQL API documentation or "Pulls" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review
, pull_request_review_comment
, 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 | milestoned | required | |
github.event.milestone | object | optional | A collection of related issues and pull requests. |
github.event.milestone.url | string | required | |
github.event.milestone.html_url | string | required | |
github.event.milestone.labels_url | string | required | |
github.event.milestone.id | integer | required | |
github.event.milestone.node_id | string | required | |
github.event.milestone.number | integer | required | The number of the milestone. |
github.event.milestone.state | open , closed | required | The state of the milestone. |
github.event.milestone.title | string | required | The title of the milestone. |
github.event.milestone.description | string or null | required | |
github.event.milestone.creator | object | required | A GitHub user. |
github.event.milestone.creator.name | string or null | optional | |
github.event.milestone.creator.email | string or null | optional | |
github.event.milestone.creator.login | string | required | |
github.event.milestone.creator.id | integer | required | |
github.event.milestone.creator.node_id | string | required | |
github.event.milestone.creator.avatar_url | string | required | |
github.event.milestone.creator.gravatar_id | string or null | required | |
github.event.milestone.creator.url | string | required | |
github.event.milestone.creator.html_url | string | required | |
github.event.milestone.creator.followers_url | string | required | |
github.event.milestone.creator.following_url | string | required | |
github.event.milestone.creator.gists_url | string | required | |
github.event.milestone.creator.starred_url | string | required | |
github.event.milestone.creator.subscriptions_url | string | required | |
github.event.milestone.creator.organizations_url | string | required | |
github.event.milestone.creator.repos_url | string | required | |
github.event.milestone.creator.events_url | string | required | |
github.event.milestone.creator.received_events_url | string | required | |
github.event.milestone.creator.type | string | required | |
github.event.milestone.creator.site_admin | boolean | required | |
github.event.milestone.creator.starred_at | string | optional | |
github.event.milestone.open_issues | integer | required | |
github.event.milestone.closed_issues | integer | required | |
github.event.milestone.created_at | string | required | |
github.event.milestone.updated_at | string | required | |
github.event.milestone.closed_at | string or null | required | |
github.event.milestone.due_on | string or null | required | |
github.event.pull_request.active_lock_reason | resolved , off-topic , too heated , spam , None | required | |
github.event.pull_request.additions | integer | optional | |
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.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.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.type | Bot , User , Organization , Mannequin | optional | |
github.event.pull_request.assignee.url | string | optional | |
github.event.pull_request.assignees | array of object,nulls | required | |
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.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.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.base.label | string | required | |
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_update_branch | boolean | optional | |
github.event.pull_request.base.repo.created_at | integer or string | required | |
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.disabled | boolean | optional | Returns whether or not this repository is disabled. |
github.event.pull_request.base.repo.license | object or null | required | |
github.event.pull_request.base.repo.license.spdx_id | string | required | |
github.event.pull_request.base.repo.merge_commit_message | PR_BODY , PR_TITLE , BLANK | optional | The default value for a merge commit message.
|
github.event.pull_request.base.repo.merge_commit_title | PR_TITLE , MERGE_MESSAGE | optional | The default value for a merge commit title.
|
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.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.public | boolean | optional | |
github.event.pull_request.base.repo.pushed_at | null or integer or string | required | |
github.event.pull_request.base.repo.role_name | string or null | optional | |
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:
|
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:
|
github.event.pull_request.base.repo.stargazers | integer | optional | |
github.event.pull_request.base.repo.topics | array of strings | 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. |
github.event.pull_request.base.repo.visibility | public , private , internal | 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.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.changed_files | integer | optional | |
github.event.pull_request.comments | integer | optional | |
github.event.pull_request.commits | integer | optional | |
github.event.pull_request.deletions | integer | optional | |
github.event.pull_request.draft | boolean | required | Indicates whether or not the pull request is a draft. |
github.event.pull_request.head.label | string | required | |
github.event.pull_request.head.repo | object | 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_update_branch | boolean | optional | |
github.event.pull_request.head.repo.created_at | integer or string | required | |
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.disabled | boolean | optional | Returns whether or not this repository is disabled. |
github.event.pull_request.head.repo.license.spdx_id | string | required | |
github.event.pull_request.head.repo.merge_commit_message | PR_BODY , PR_TITLE , BLANK | optional | The default value for a merge commit message.
|
github.event.pull_request.head.repo.merge_commit_title | PR_TITLE , MERGE_MESSAGE | optional | The default value for a merge commit title.
|
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.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.public | boolean | optional | |
github.event.pull_request.head.repo.pushed_at | null or integer or string | required | |
github.event.pull_request.head.repo.role_name | string or null | optional | |
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:
|
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:
|
github.event.pull_request.head.repo.stargazers | integer | optional | |
github.event.pull_request.head.repo.topics | array of strings | 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. |
github.event.pull_request.head.repo.visibility | public , private , internal | 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.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.maintainer_can_modify | boolean | optional | Indicates whether maintainers can modify the pull request. |
github.event.pull_request.mergeable | boolean or null | optional | |
github.event.pull_request.mergeable_state | string | optional | |
github.event.pull_request.merged | boolean or null | optional | |
github.event.pull_request.merged_by | object or null | optional | |
github.event.pull_request.merged_by.avatar_url | string | optional | |
github.event.pull_request.merged_by.deleted | boolean | optional | |
github.event.pull_request.merged_by.events_url | string | optional | |
github.event.pull_request.merged_by.followers_url | string | optional | |
github.event.pull_request.merged_by.following_url | string | optional | |
github.event.pull_request.merged_by.gists_url | string | optional | |
github.event.pull_request.merged_by.gravatar_id | string | optional | |
github.event.pull_request.merged_by.html_url | string | optional | |
github.event.pull_request.merged_by.name | string | optional | |
github.event.pull_request.merged_by.node_id | string | optional | |
github.event.pull_request.merged_by.organizations_url | string | optional | |
github.event.pull_request.merged_by.received_events_url | string | optional | |
github.event.pull_request.merged_by.repos_url | string | optional | |
github.event.pull_request.merged_by.site_admin | boolean | optional | |
github.event.pull_request.merged_by.starred_url | string | optional | |
github.event.pull_request.merged_by.subscriptions_url | string | optional | |
github.event.pull_request.merged_by.type | Bot , User , Organization , Mannequin | optional | |
github.event.pull_request.merged_by.url | string | optional | |
github.event.pull_request.milestone | object or null | required | A collection of related issues and pull requests. |
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.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.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.type | Bot , User , Organization , Mannequin | optional | |
github.event.pull_request.milestone.creator.url | string | optional | |
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.members_url | string | optional | |
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_comments | integer | optional | |
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.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.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.sender | object | optional | The GitHub user that triggered the event. This property is included in every webhook payload. |
opened
#
This event occurs when there is activity on a pull request. For more information, see "About pull requests." For information about the APIs to manage pull requests, see the GraphQL API documentation or "Pulls" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review
, pull_request_review_comment
, 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 | opened | required | |
github.event.installation | object | optional | The GitHub App installation. Webhook payloads contain the |
github.event.pull_request.user | object | required | A GitHub user. |
github.event.pull_request.user.name | string or null | optional | |
github.event.pull_request.user.node_id | string | required | |
github.event.pull_request.user.avatar_url | string | required | |
github.event.pull_request.user.gravatar_id | string or null | required | |
github.event.pull_request.user.url | string | required | |
github.event.pull_request.user.html_url | string | required | |
github.event.pull_request.user.followers_url | string | required | |
github.event.pull_request.user.following_url | string | required | |
github.event.pull_request.user.gists_url | string | required | |
github.event.pull_request.user.starred_url | string | required | |
github.event.pull_request.user.subscriptions_url | string | required | |
github.event.pull_request.user.organizations_url | string | required | |
github.event.pull_request.user.repos_url | string | required | |
github.event.pull_request.user.events_url | string | required | |
github.event.pull_request.user.received_events_url | string | required | |
github.event.pull_request.user.type | string | required | |
github.event.pull_request.user.site_admin | boolean | required | |
github.event.pull_request.user.starred_at | string | optional | |
github.event.pull_request.milestone | object | required | A collection of related issues and pull requests. |
github.event.pull_request.milestone.creator | object | required | A GitHub user. |
github.event.pull_request.milestone.creator.name | string or null | optional | |
github.event.pull_request.milestone.creator.node_id | string | required | |
github.event.pull_request.milestone.creator.avatar_url | string | required | |
github.event.pull_request.milestone.creator.gravatar_id | string or null | required | |
github.event.pull_request.milestone.creator.url | string | required | |
github.event.pull_request.milestone.creator.html_url | string | required | |
github.event.pull_request.milestone.creator.followers_url | string | required | |
github.event.pull_request.milestone.creator.following_url | string | required | |
github.event.pull_request.milestone.creator.gists_url | string | required | |
github.event.pull_request.milestone.creator.starred_url | string | required | |
github.event.pull_request.milestone.creator.subscriptions_url | string | required | |
github.event.pull_request.milestone.creator.organizations_url | string | required | |
github.event.pull_request.milestone.creator.repos_url | string | required | |
github.event.pull_request.milestone.creator.events_url | string | required | |
github.event.pull_request.milestone.creator.received_events_url | string | required | |
github.event.pull_request.milestone.creator.type | string | required | |
github.event.pull_request.milestone.creator.site_admin | boolean | required | |
github.event.pull_request.milestone.creator.starred_at | string | optional | |
github.event.pull_request.active_lock_reason | string or null | optional | |
github.event.pull_request.assignee | object | required | A GitHub user. |
github.event.pull_request.assignee.name | string or null | optional | |
github.event.pull_request.assignee.node_id | string | required | |
github.event.pull_request.assignee.avatar_url | string | required | |
github.event.pull_request.assignee.gravatar_id | string or null | required | |
github.event.pull_request.assignee.url | string | required | |
github.event.pull_request.assignee.html_url | string | required | |
github.event.pull_request.assignee.followers_url | string | required | |
github.event.pull_request.assignee.following_url | string | required | |
github.event.pull_request.assignee.gists_url | string | required | |
github.event.pull_request.assignee.starred_url | string | required | |
github.event.pull_request.assignee.subscriptions_url | string | required | |
github.event.pull_request.assignee.organizations_url | string | required | |
github.event.pull_request.assignee.repos_url | string | required | |
github.event.pull_request.assignee.events_url | string | required | |
github.event.pull_request.assignee.received_events_url | string | required | |
github.event.pull_request.assignee.type | string | required | |
github.event.pull_request.assignee.site_admin | boolean | required | |
github.event.pull_request.assignee.starred_at | string | optional | |
github.event.pull_request.assignees | array of objects or null | optional | |
github.event.pull_request.assignees.name | string or null | optional | |
github.event.pull_request.assignees.email | string or null | optional | |
github.event.pull_request.assignees.login | string | required | |
github.event.pull_request.assignees.id | integer | required | |
github.event.pull_request.assignees.node_id | string | required | |
github.event.pull_request.assignees.avatar_url | string | required | |
github.event.pull_request.assignees.gravatar_id | string or null | required | |
github.event.pull_request.assignees.url | string | required | |
github.event.pull_request.assignees.html_url | string | required | |
github.event.pull_request.assignees.followers_url | string | required | |
github.event.pull_request.assignees.following_url | string | required | |
github.event.pull_request.assignees.gists_url | string | required | |
github.event.pull_request.assignees.starred_url | string | required | |
github.event.pull_request.assignees.subscriptions_url | string | required | |
github.event.pull_request.assignees.organizations_url | string | required | |
github.event.pull_request.assignees.repos_url | string | required | |
github.event.pull_request.assignees.events_url | string | required | |
github.event.pull_request.assignees.received_events_url | string | required | |
github.event.pull_request.assignees.type | string | required | |
github.event.pull_request.assignees.site_admin | boolean | required | |
github.event.pull_request.assignees.starred_at | string | optional | |
github.event.pull_request.requested_reviewers | array of objects or null | optional | |
github.event.pull_request.requested_reviewers.name | string or null | optional | |
github.event.pull_request.requested_reviewers.email | string or null | optional | |
github.event.pull_request.requested_reviewers.login | string | required | |
github.event.pull_request.requested_reviewers.id | integer | required | |
github.event.pull_request.requested_reviewers.node_id | string | required | |
github.event.pull_request.requested_reviewers.avatar_url | string | required | |
github.event.pull_request.requested_reviewers.gravatar_id | string or null | required | |
github.event.pull_request.requested_reviewers.url | string | required | |
github.event.pull_request.requested_reviewers.html_url | string | required | |
github.event.pull_request.requested_reviewers.followers_url | string | required | |
github.event.pull_request.requested_reviewers.following_url | string | required | |
github.event.pull_request.requested_reviewers.gists_url | string | required | |
github.event.pull_request.requested_reviewers.starred_url | string | required | |
github.event.pull_request.requested_reviewers.subscriptions_url | string | required | |
github.event.pull_request.requested_reviewers.organizations_url | string | required | |
github.event.pull_request.requested_reviewers.repos_url | string | required | |
github.event.pull_request.requested_reviewers.events_url | string | required | |
github.event.pull_request.requested_reviewers.received_events_url | string | required | |
github.event.pull_request.requested_reviewers.type | string | required | |
github.event.pull_request.requested_reviewers.site_admin | boolean | required | |
github.event.pull_request.requested_reviewers.starred_at | string | optional | |
github.event.pull_request.requested_teams | array of objects or null | optional | |
github.event.pull_request.requested_teams.node_id | string | required | |
github.event.pull_request.requested_teams.url | string | required | URL for the team |
github.event.pull_request.requested_teams.members_url | string | required | |
github.event.pull_request.requested_teams.description | string or null | required | Description of the team |
github.event.pull_request.requested_teams.permission | string | required | Permission that the team will have for its repositories |
github.event.pull_request.requested_teams.privacy | string | optional | The level of privacy this team should have |
github.event.pull_request.requested_teams.notification_setting | string | optional | The notification setting the team has set |
github.event.pull_request.requested_teams.html_url | string | required | |
github.event.pull_request.requested_teams.repositories_url | string | required | |
github.event.pull_request.requested_teams.slug | string | required | |
github.event.pull_request.requested_teams.ldap_dn | string | optional | Distinguished Name (DN) that team maps to within LDAP environment |
github.event.pull_request.head.label | string | required | |
github.event.pull_request.head.repo | object or null | required | |
github.event.pull_request.head.repo.owner | object | required | |
github.event.pull_request.head.repo.owner.avatar_url | string | required | |
github.event.pull_request.head.repo.owner.events_url | string | required | |
github.event.pull_request.head.repo.owner.followers_url | string | required | |
github.event.pull_request.head.repo.owner.following_url | string | required | |
github.event.pull_request.head.repo.owner.gists_url | string | required | |
github.event.pull_request.head.repo.owner.gravatar_id | string or null | required | |
github.event.pull_request.head.repo.owner.html_url | string | required | |
github.event.pull_request.head.repo.owner.node_id | string | required | |
github.event.pull_request.head.repo.owner.organizations_url | string | required | |
github.event.pull_request.head.repo.owner.received_events_url | string | required | |
github.event.pull_request.head.repo.owner.repos_url | string | required | |
github.event.pull_request.head.repo.owner.site_admin | boolean | required | |
github.event.pull_request.head.repo.owner.starred_url | string | required | |
github.event.pull_request.head.repo.owner.subscriptions_url | string | required | |
github.event.pull_request.head.repo.owner.type | string | required | |
github.event.pull_request.head.repo.owner.url | string | required | |
github.event.pull_request.head.repo.disabled | boolean | required | |
github.event.pull_request.head.repo.visibility | string | optional | The repository visibility: public, private, or internal. |
github.event.pull_request.head.repo.temp_clone_token | string | optional | |
github.event.pull_request.head.repo.license.spdx_id | string or null | required | |
github.event.pull_request.head.repo.pushed_at | string | required | |
github.event.pull_request.head.repo.topics | array of strings | optional | |
github.event.pull_request.head.repo.created_at | string | required | |
github.event.pull_request.head.user | object | required | |
github.event.pull_request.head.user.avatar_url | string | required | |
github.event.pull_request.head.user.events_url | string | required | |
github.event.pull_request.head.user.followers_url | string | required | |
github.event.pull_request.head.user.following_url | string | required | |
github.event.pull_request.head.user.gists_url | string | required | |
github.event.pull_request.head.user.gravatar_id | string or null | required | |
github.event.pull_request.head.user.html_url | string | required | |
github.event.pull_request.head.user.node_id | string | required | |
github.event.pull_request.head.user.organizations_url | string | required | |
github.event.pull_request.head.user.received_events_url | string | required | |
github.event.pull_request.head.user.repos_url | string | required | |
github.event.pull_request.head.user.site_admin | boolean | required | |
github.event.pull_request.head.user.starred_url | string | required | |
github.event.pull_request.head.user.subscriptions_url | string | required | |
github.event.pull_request.head.user.type | string | required | |
github.event.pull_request.head.user.url | string | required | |
github.event.pull_request.base.label | string | required | |
github.event.pull_request.base.repo.owner | object | required | |
github.event.pull_request.base.repo.owner.avatar_url | string | required | |
github.event.pull_request.base.repo.owner.events_url | string | required | |
github.event.pull_request.base.repo.owner.followers_url | string | required | |
github.event.pull_request.base.repo.owner.following_url | string | required | |
github.event.pull_request.base.repo.owner.gists_url | string | required | |
github.event.pull_request.base.repo.owner.gravatar_id | string or null | required | |
github.event.pull_request.base.repo.owner.html_url | string | required | |
github.event.pull_request.base.repo.owner.node_id | string | required | |
github.event.pull_request.base.repo.owner.organizations_url | string | required | |
github.event.pull_request.base.repo.owner.received_events_url | string | required | |
github.event.pull_request.base.repo.owner.repos_url | string | required | |
github.event.pull_request.base.repo.owner.site_admin | boolean | required | |
github.event.pull_request.base.repo.owner.starred_url | string | required | |
github.event.pull_request.base.repo.owner.subscriptions_url | string | required | |
github.event.pull_request.base.repo.owner.type | string | required | |
github.event.pull_request.base.repo.owner.url | string | required | |
github.event.pull_request.base.repo.disabled | boolean | required | |
github.event.pull_request.base.repo.visibility | string | optional | The repository visibility: public, private, or internal. |
github.event.pull_request.base.repo.temp_clone_token | string | optional | |
github.event.pull_request.base.repo.license | object | required | License Simple |
github.event.pull_request.base.repo.license.spdx_id | string or null | required | |
github.event.pull_request.base.repo.license.html_url | string | optional | |
github.event.pull_request.base.repo.pushed_at | string | required | |
github.event.pull_request.base.repo.topics | array of strings | optional | |
github.event.pull_request.base.repo.created_at | string | required | |
github.event.pull_request.base.user | object | required | |
github.event.pull_request.base.user.avatar_url | string | required | |
github.event.pull_request.base.user.events_url | string | required | |
github.event.pull_request.base.user.followers_url | string | required | |
github.event.pull_request.base.user.following_url | string | required | |
github.event.pull_request.base.user.gists_url | string | required | |
github.event.pull_request.base.user.gravatar_id | string or null | required | |
github.event.pull_request.base.user.html_url | string | required | |
github.event.pull_request.base.user.node_id | string | required | |
github.event.pull_request.base.user.organizations_url | string | required | |
github.event.pull_request.base.user.received_events_url | string | required | |
github.event.pull_request.base.user.repos_url | string | required | |
github.event.pull_request.base.user.site_admin | boolean | required | |
github.event.pull_request.base.user.starred_url | string | required | |
github.event.pull_request.base.user.subscriptions_url | string | required | |
github.event.pull_request.base.user.type | string | required | |
github.event.pull_request.base.user.url | string | required | |
github.event.pull_request.auto_merge.enabled_by | object | required | A GitHub user. |
github.event.pull_request.auto_merge.enabled_by.name | string or null | optional | |
github.event.pull_request.auto_merge.enabled_by.node_id | string | required | |
github.event.pull_request.auto_merge.enabled_by.avatar_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.gravatar_id | string or null | required | |
github.event.pull_request.auto_merge.enabled_by.url | string | required | |
github.event.pull_request.auto_merge.enabled_by.html_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.followers_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.following_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.gists_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.starred_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.subscriptions_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.organizations_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.repos_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.events_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.received_events_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.type | string | required | |
github.event.pull_request.auto_merge.enabled_by.site_admin | boolean | required | |
github.event.pull_request.auto_merge.enabled_by.starred_at | string | optional | |
github.event.pull_request.auto_merge.commit_title | string | required | Title for the merge commit message. |
github.event.pull_request.auto_merge.commit_message | string | required | Commit message for the merge commit. |
github.event.pull_request.draft | boolean | optional | Indicates whether or not the pull request is a draft. |
github.event.pull_request.merged | boolean | required | |
github.event.pull_request.mergeable | boolean or null | required | |
github.event.pull_request.mergeable_state | string | required | |
github.event.pull_request.merged_by | object | required | A GitHub user. |
github.event.pull_request.merged_by.name | string or null | optional | |
github.event.pull_request.merged_by.node_id | string | required | |
github.event.pull_request.merged_by.avatar_url | string | required | |
github.event.pull_request.merged_by.gravatar_id | string or null | required | |
github.event.pull_request.merged_by.url | string | required | |
github.event.pull_request.merged_by.html_url | string | required | |
github.event.pull_request.merged_by.followers_url | string | required | |
github.event.pull_request.merged_by.following_url | string | required | |
github.event.pull_request.merged_by.gists_url | string | required | |
github.event.pull_request.merged_by.starred_url | string | required | |
github.event.pull_request.merged_by.subscriptions_url | string | required | |
github.event.pull_request.merged_by.organizations_url | string | required | |
github.event.pull_request.merged_by.repos_url | string | required | |
github.event.pull_request.merged_by.events_url | string | required | |
github.event.pull_request.merged_by.received_events_url | string | required | |
github.event.pull_request.merged_by.type | string | required | |
github.event.pull_request.merged_by.site_admin | boolean | required | |
github.event.pull_request.merged_by.starred_at | string | optional | |
github.event.pull_request.comments | integer | required | |
github.event.pull_request.review_comments | integer | required | |
github.event.pull_request.maintainer_can_modify | boolean | required | Indicates whether maintainers can modify the pull request. |
github.event.pull_request.commits | integer | required | |
github.event.pull_request.additions | integer | required | |
github.event.pull_request.deletions | integer | required | |
github.event.pull_request.changed_files | integer | required | |
github.event.pull_request.allow_auto_merge | boolean | optional | Whether to allow auto-merge for pull requests. |
github.event.pull_request.allow_update_branch | boolean | optional | Whether to allow updating the pull request’s branch. |
github.event.pull_request.delete_branch_on_merge | boolean | optional | Whether to delete head branches when pull requests are merged. |
github.event.pull_request.merge_commit_message | PR_BODY , PR_TITLE , BLANK | optional | The default value for a merge commit message.
|
github.event.pull_request.merge_commit_title | PR_TITLE , MERGE_MESSAGE | optional | The default value for a merge commit title.
|
github.event.pull_request.squash_merge_commit_message | PR_BODY , COMMIT_MESSAGES , BLANK | optional | The default value for a squash merge commit message:
|
github.event.pull_request.squash_merge_commit_title | PR_TITLE , COMMIT_OR_PR_TITLE | optional | The default value for a squash merge commit title:
|
github.event.pull_request.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 |
github.event.sender | object | required | The GitHub user that triggered the event. This property is included in every webhook payload. |
ready_for_review
#
This event occurs when there is activity on a pull request. For more information, see "About pull requests." For information about the APIs to manage pull requests, see the GraphQL API documentation or "Pulls" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review
, pull_request_review_comment
, 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 | ready_for_review | required | |
github.event.installation | object | optional | The GitHub App installation. Webhook payloads contain the |
github.event.pull_request.user | object | required | A GitHub user. |
github.event.pull_request.user.name | string or null | optional | |
github.event.pull_request.user.node_id | string | required | |
github.event.pull_request.user.avatar_url | string | required | |
github.event.pull_request.user.gravatar_id | string or null | required | |
github.event.pull_request.user.url | string | required | |
github.event.pull_request.user.html_url | string | required | |
github.event.pull_request.user.followers_url | string | required | |
github.event.pull_request.user.following_url | string | required | |
github.event.pull_request.user.gists_url | string | required | |
github.event.pull_request.user.starred_url | string | required | |
github.event.pull_request.user.subscriptions_url | string | required | |
github.event.pull_request.user.organizations_url | string | required | |
github.event.pull_request.user.repos_url | string | required | |
github.event.pull_request.user.events_url | string | required | |
github.event.pull_request.user.received_events_url | string | required | |
github.event.pull_request.user.type | string | required | |
github.event.pull_request.user.site_admin | boolean | required | |
github.event.pull_request.user.starred_at | string | optional | |
github.event.pull_request.milestone | object | required | A collection of related issues and pull requests. |
github.event.pull_request.milestone.creator | object | required | A GitHub user. |
github.event.pull_request.milestone.creator.name | string or null | optional | |
github.event.pull_request.milestone.creator.node_id | string | required | |
github.event.pull_request.milestone.creator.avatar_url | string | required | |
github.event.pull_request.milestone.creator.gravatar_id | string or null | required | |
github.event.pull_request.milestone.creator.url | string | required | |
github.event.pull_request.milestone.creator.html_url | string | required | |
github.event.pull_request.milestone.creator.followers_url | string | required | |
github.event.pull_request.milestone.creator.following_url | string | required | |
github.event.pull_request.milestone.creator.gists_url | string | required | |
github.event.pull_request.milestone.creator.starred_url | string | required | |
github.event.pull_request.milestone.creator.subscriptions_url | string | required | |
github.event.pull_request.milestone.creator.organizations_url | string | required | |
github.event.pull_request.milestone.creator.repos_url | string | required | |
github.event.pull_request.milestone.creator.events_url | string | required | |
github.event.pull_request.milestone.creator.received_events_url | string | required | |
github.event.pull_request.milestone.creator.type | string | required | |
github.event.pull_request.milestone.creator.site_admin | boolean | required | |
github.event.pull_request.milestone.creator.starred_at | string | optional | |
github.event.pull_request.active_lock_reason | string or null | optional | |
github.event.pull_request.assignee | object | required | A GitHub user. |
github.event.pull_request.assignee.name | string or null | optional | |
github.event.pull_request.assignee.node_id | string | required | |
github.event.pull_request.assignee.avatar_url | string | required | |
github.event.pull_request.assignee.gravatar_id | string or null | required | |
github.event.pull_request.assignee.url | string | required | |
github.event.pull_request.assignee.html_url | string | required | |
github.event.pull_request.assignee.followers_url | string | required | |
github.event.pull_request.assignee.following_url | string | required | |
github.event.pull_request.assignee.gists_url | string | required | |
github.event.pull_request.assignee.starred_url | string | required | |
github.event.pull_request.assignee.subscriptions_url | string | required | |
github.event.pull_request.assignee.organizations_url | string | required | |
github.event.pull_request.assignee.repos_url | string | required | |
github.event.pull_request.assignee.events_url | string | required | |
github.event.pull_request.assignee.received_events_url | string | required | |
github.event.pull_request.assignee.type | string | required | |
github.event.pull_request.assignee.site_admin | boolean | required | |
github.event.pull_request.assignee.starred_at | string | optional | |
github.event.pull_request.assignees | array of objects or null | optional | |
github.event.pull_request.assignees.name | string or null | optional | |
github.event.pull_request.assignees.email | string or null | optional | |
github.event.pull_request.assignees.login | string | required | |
github.event.pull_request.assignees.id | integer | required | |
github.event.pull_request.assignees.node_id | string | required | |
github.event.pull_request.assignees.avatar_url | string | required | |
github.event.pull_request.assignees.gravatar_id | string or null | required | |
github.event.pull_request.assignees.url | string | required | |
github.event.pull_request.assignees.html_url | string | required | |
github.event.pull_request.assignees.followers_url | string | required | |
github.event.pull_request.assignees.following_url | string | required | |
github.event.pull_request.assignees.gists_url | string | required | |
github.event.pull_request.assignees.starred_url | string | required | |
github.event.pull_request.assignees.subscriptions_url | string | required | |
github.event.pull_request.assignees.organizations_url | string | required | |
github.event.pull_request.assignees.repos_url | string | required | |
github.event.pull_request.assignees.events_url | string | required | |
github.event.pull_request.assignees.received_events_url | string | required | |
github.event.pull_request.assignees.type | string | required | |
github.event.pull_request.assignees.site_admin | boolean | required | |
github.event.pull_request.assignees.starred_at | string | optional | |
github.event.pull_request.requested_reviewers | array of objects or null | optional | |
github.event.pull_request.requested_reviewers.name | string or null | optional | |
github.event.pull_request.requested_reviewers.email | string or null | optional | |
github.event.pull_request.requested_reviewers.login | string | required | |
github.event.pull_request.requested_reviewers.id | integer | required | |
github.event.pull_request.requested_reviewers.node_id | string | required | |
github.event.pull_request.requested_reviewers.avatar_url | string | required | |
github.event.pull_request.requested_reviewers.gravatar_id | string or null | required | |
github.event.pull_request.requested_reviewers.url | string | required | |
github.event.pull_request.requested_reviewers.html_url | string | required | |
github.event.pull_request.requested_reviewers.followers_url | string | required | |
github.event.pull_request.requested_reviewers.following_url | string | required | |
github.event.pull_request.requested_reviewers.gists_url | string | required | |
github.event.pull_request.requested_reviewers.starred_url | string | required | |
github.event.pull_request.requested_reviewers.subscriptions_url | string | required | |
github.event.pull_request.requested_reviewers.organizations_url | string | required | |
github.event.pull_request.requested_reviewers.repos_url | string | required | |
github.event.pull_request.requested_reviewers.events_url | string | required | |
github.event.pull_request.requested_reviewers.received_events_url | string | required | |
github.event.pull_request.requested_reviewers.type | string | required | |
github.event.pull_request.requested_reviewers.site_admin | boolean | required | |
github.event.pull_request.requested_reviewers.starred_at | string | optional | |
github.event.pull_request.requested_teams | array of objects or null | optional | |
github.event.pull_request.requested_teams.node_id | string | required | |
github.event.pull_request.requested_teams.url | string | required | URL for the team |
github.event.pull_request.requested_teams.members_url | string | required | |
github.event.pull_request.requested_teams.description | string or null | required | Description of the team |
github.event.pull_request.requested_teams.permission | string | required | Permission that the team will have for its repositories |
github.event.pull_request.requested_teams.privacy | string | optional | The level of privacy this team should have |
github.event.pull_request.requested_teams.notification_setting | string | optional | The notification setting the team has set |
github.event.pull_request.requested_teams.html_url | string | required | |
github.event.pull_request.requested_teams.repositories_url | string | required | |
github.event.pull_request.requested_teams.slug | string | required | |
github.event.pull_request.requested_teams.ldap_dn | string | optional | Distinguished Name (DN) that team maps to within LDAP environment |
github.event.pull_request.head.label | string | required | |
github.event.pull_request.head.repo | object or null | required | |
github.event.pull_request.head.repo.owner | object | required | |
github.event.pull_request.head.repo.owner.avatar_url | string | required | |
github.event.pull_request.head.repo.owner.events_url | string | required | |
github.event.pull_request.head.repo.owner.followers_url | string | required | |
github.event.pull_request.head.repo.owner.following_url | string | required | |
github.event.pull_request.head.repo.owner.gists_url | string | required | |
github.event.pull_request.head.repo.owner.gravatar_id | string or null | required | |
github.event.pull_request.head.repo.owner.html_url | string | required | |
github.event.pull_request.head.repo.owner.node_id | string | required | |
github.event.pull_request.head.repo.owner.organizations_url | string | required | |
github.event.pull_request.head.repo.owner.received_events_url | string | required | |
github.event.pull_request.head.repo.owner.repos_url | string | required | |
github.event.pull_request.head.repo.owner.site_admin | boolean | required | |
github.event.pull_request.head.repo.owner.starred_url | string | required | |
github.event.pull_request.head.repo.owner.subscriptions_url | string | required | |
github.event.pull_request.head.repo.owner.type | string | required | |
github.event.pull_request.head.repo.owner.url | string | required | |
github.event.pull_request.head.repo.disabled | boolean | required | |
github.event.pull_request.head.repo.visibility | string | optional | The repository visibility: public, private, or internal. |
github.event.pull_request.head.repo.temp_clone_token | string | optional | |
github.event.pull_request.head.repo.license.spdx_id | string or null | required | |
github.event.pull_request.head.repo.pushed_at | string | required | |
github.event.pull_request.head.repo.topics | array of strings | optional | |
github.event.pull_request.head.repo.created_at | string | required | |
github.event.pull_request.head.user | object | required | |
github.event.pull_request.head.user.avatar_url | string | required | |
github.event.pull_request.head.user.events_url | string | required | |
github.event.pull_request.head.user.followers_url | string | required | |
github.event.pull_request.head.user.following_url | string | required | |
github.event.pull_request.head.user.gists_url | string | required | |
github.event.pull_request.head.user.gravatar_id | string or null | required | |
github.event.pull_request.head.user.html_url | string | required | |
github.event.pull_request.head.user.node_id | string | required | |
github.event.pull_request.head.user.organizations_url | string | required | |
github.event.pull_request.head.user.received_events_url | string | required | |
github.event.pull_request.head.user.repos_url | string | required | |
github.event.pull_request.head.user.site_admin | boolean | required | |
github.event.pull_request.head.user.starred_url | string | required | |
github.event.pull_request.head.user.subscriptions_url | string | required | |
github.event.pull_request.head.user.type | string | required | |
github.event.pull_request.head.user.url | string | required | |
github.event.pull_request.base.label | string | required | |
github.event.pull_request.base.repo.owner | object | required | |
github.event.pull_request.base.repo.owner.avatar_url | string | required | |
github.event.pull_request.base.repo.owner.events_url | string | required | |
github.event.pull_request.base.repo.owner.followers_url | string | required | |
github.event.pull_request.base.repo.owner.following_url | string | required | |
github.event.pull_request.base.repo.owner.gists_url | string | required | |
github.event.pull_request.base.repo.owner.gravatar_id | string or null | required | |
github.event.pull_request.base.repo.owner.html_url | string | required | |
github.event.pull_request.base.repo.owner.node_id | string | required | |
github.event.pull_request.base.repo.owner.organizations_url | string | required | |
github.event.pull_request.base.repo.owner.received_events_url | string | required | |
github.event.pull_request.base.repo.owner.repos_url | string | required | |
github.event.pull_request.base.repo.owner.site_admin | boolean | required | |
github.event.pull_request.base.repo.owner.starred_url | string | required | |
github.event.pull_request.base.repo.owner.subscriptions_url | string | required | |
github.event.pull_request.base.repo.owner.type | string | required | |
github.event.pull_request.base.repo.owner.url | string | required | |
github.event.pull_request.base.repo.disabled | boolean | required | |
github.event.pull_request.base.repo.visibility | string | optional | The repository visibility: public, private, or internal. |
github.event.pull_request.base.repo.temp_clone_token | string | optional | |
github.event.pull_request.base.repo.license | object | required | License Simple |
github.event.pull_request.base.repo.license.spdx_id | string or null | required | |
github.event.pull_request.base.repo.license.html_url | string | optional | |
github.event.pull_request.base.repo.pushed_at | string | required | |
github.event.pull_request.base.repo.topics | array of strings | optional | |
github.event.pull_request.base.repo.created_at | string | required | |
github.event.pull_request.base.user | object | required | |
github.event.pull_request.base.user.avatar_url | string | required | |
github.event.pull_request.base.user.events_url | string | required | |
github.event.pull_request.base.user.followers_url | string | required | |
github.event.pull_request.base.user.following_url | string | required | |
github.event.pull_request.base.user.gists_url | string | required | |
github.event.pull_request.base.user.gravatar_id | string or null | required | |
github.event.pull_request.base.user.html_url | string | required | |
github.event.pull_request.base.user.node_id | string | required | |
github.event.pull_request.base.user.organizations_url | string | required | |
github.event.pull_request.base.user.received_events_url | string | required | |
github.event.pull_request.base.user.repos_url | string | required | |
github.event.pull_request.base.user.site_admin | boolean | required | |
github.event.pull_request.base.user.starred_url | string | required | |
github.event.pull_request.base.user.subscriptions_url | string | required | |
github.event.pull_request.base.user.type | string | required | |
github.event.pull_request.base.user.url | string | required | |
github.event.pull_request.auto_merge.enabled_by | object | required | A GitHub user. |
github.event.pull_request.auto_merge.enabled_by.name | string or null | optional | |
github.event.pull_request.auto_merge.enabled_by.node_id | string | required | |
github.event.pull_request.auto_merge.enabled_by.avatar_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.gravatar_id | string or null | required | |
github.event.pull_request.auto_merge.enabled_by.url | string | required | |
github.event.pull_request.auto_merge.enabled_by.html_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.followers_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.following_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.gists_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.starred_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.subscriptions_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.organizations_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.repos_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.events_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.received_events_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.type | string | required | |
github.event.pull_request.auto_merge.enabled_by.site_admin | boolean | required | |
github.event.pull_request.auto_merge.enabled_by.starred_at | string | optional | |
github.event.pull_request.auto_merge.commit_title | string | required | Title for the merge commit message. |
github.event.pull_request.auto_merge.commit_message | string | required | Commit message for the merge commit. |
github.event.pull_request.draft | boolean | optional | Indicates whether or not the pull request is a draft. |
github.event.pull_request.merged | boolean | required | |
github.event.pull_request.mergeable | boolean or null | required | |
github.event.pull_request.mergeable_state | string | required | |
github.event.pull_request.merged_by | object | required | A GitHub user. |
github.event.pull_request.merged_by.name | string or null | optional | |
github.event.pull_request.merged_by.node_id | string | required | |
github.event.pull_request.merged_by.avatar_url | string | required | |
github.event.pull_request.merged_by.gravatar_id | string or null | required | |
github.event.pull_request.merged_by.url | string | required | |
github.event.pull_request.merged_by.html_url | string | required | |
github.event.pull_request.merged_by.followers_url | string | required | |
github.event.pull_request.merged_by.following_url | string | required | |
github.event.pull_request.merged_by.gists_url | string | required | |
github.event.pull_request.merged_by.starred_url | string | required | |
github.event.pull_request.merged_by.subscriptions_url | string | required | |
github.event.pull_request.merged_by.organizations_url | string | required | |
github.event.pull_request.merged_by.repos_url | string | required | |
github.event.pull_request.merged_by.events_url | string | required | |
github.event.pull_request.merged_by.received_events_url | string | required | |
github.event.pull_request.merged_by.type | string | required | |
github.event.pull_request.merged_by.site_admin | boolean | required | |
github.event.pull_request.merged_by.starred_at | string | optional | |
github.event.pull_request.comments | integer | required | |
github.event.pull_request.review_comments | integer | required | |
github.event.pull_request.maintainer_can_modify | boolean | required | Indicates whether maintainers can modify the pull request. |
github.event.pull_request.commits | integer | required | |
github.event.pull_request.additions | integer | required | |
github.event.pull_request.deletions | integer | required | |
github.event.pull_request.changed_files | integer | required | |
github.event.pull_request.allow_auto_merge | boolean | optional | Whether to allow auto-merge for pull requests. |
github.event.pull_request.allow_update_branch | boolean | optional | Whether to allow updating the pull request’s branch. |
github.event.pull_request.delete_branch_on_merge | boolean | optional | Whether to delete head branches when pull requests are merged. |
github.event.pull_request.merge_commit_message | PR_BODY , PR_TITLE , BLANK | optional | The default value for a merge commit message.
|
github.event.pull_request.merge_commit_title | PR_TITLE , MERGE_MESSAGE | optional | The default value for a merge commit title.
|
github.event.pull_request.squash_merge_commit_message | PR_BODY , COMMIT_MESSAGES , BLANK | optional | The default value for a squash merge commit message:
|
github.event.pull_request.squash_merge_commit_title | PR_TITLE , COMMIT_OR_PR_TITLE | optional | The default value for a squash merge commit title:
|
github.event.pull_request.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 |
github.event.sender | object | required | The GitHub user that triggered the event. This property is included in every webhook payload. |
reopened
#
This event occurs when there is activity on a pull request. For more information, see "About pull requests." For information about the APIs to manage pull requests, see the GraphQL API documentation or "Pulls" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review
, pull_request_review_comment
, 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 | reopened | required | |
github.event.installation | object | optional | The GitHub App installation. Webhook payloads contain the |
github.event.pull_request.user | object | required | A GitHub user. |
github.event.pull_request.user.name | string or null | optional | |
github.event.pull_request.user.node_id | string | required | |
github.event.pull_request.user.avatar_url | string | required | |
github.event.pull_request.user.gravatar_id | string or null | required | |
github.event.pull_request.user.url | string | required | |
github.event.pull_request.user.html_url | string | required | |
github.event.pull_request.user.followers_url | string | required | |
github.event.pull_request.user.following_url | string | required | |
github.event.pull_request.user.gists_url | string | required | |
github.event.pull_request.user.starred_url | string | required | |
github.event.pull_request.user.subscriptions_url | string | required | |
github.event.pull_request.user.organizations_url | string | required | |
github.event.pull_request.user.repos_url | string | required | |
github.event.pull_request.user.events_url | string | required | |
github.event.pull_request.user.received_events_url | string | required | |
github.event.pull_request.user.type | string | required | |
github.event.pull_request.user.site_admin | boolean | required | |
github.event.pull_request.user.starred_at | string | optional | |
github.event.pull_request.milestone | object | required | A collection of related issues and pull requests. |
github.event.pull_request.milestone.creator | object | required | A GitHub user. |
github.event.pull_request.milestone.creator.name | string or null | optional | |
github.event.pull_request.milestone.creator.node_id | string | required | |
github.event.pull_request.milestone.creator.avatar_url | string | required | |
github.event.pull_request.milestone.creator.gravatar_id | string or null | required | |
github.event.pull_request.milestone.creator.url | string | required | |
github.event.pull_request.milestone.creator.html_url | string | required | |
github.event.pull_request.milestone.creator.followers_url | string | required | |
github.event.pull_request.milestone.creator.following_url | string | required | |
github.event.pull_request.milestone.creator.gists_url | string | required | |
github.event.pull_request.milestone.creator.starred_url | string | required | |
github.event.pull_request.milestone.creator.subscriptions_url | string | required | |
github.event.pull_request.milestone.creator.organizations_url | string | required | |
github.event.pull_request.milestone.creator.repos_url | string | required | |
github.event.pull_request.milestone.creator.events_url | string | required | |
github.event.pull_request.milestone.creator.received_events_url | string | required | |
github.event.pull_request.milestone.creator.type | string | required | |
github.event.pull_request.milestone.creator.site_admin | boolean | required | |
github.event.pull_request.milestone.creator.starred_at | string | optional | |
github.event.pull_request.active_lock_reason | string or null | optional | |
github.event.pull_request.assignee | object | required | A GitHub user. |
github.event.pull_request.assignee.name | string or null | optional | |
github.event.pull_request.assignee.node_id | string | required | |
github.event.pull_request.assignee.avatar_url | string | required | |
github.event.pull_request.assignee.gravatar_id | string or null | required | |
github.event.pull_request.assignee.url | string | required | |
github.event.pull_request.assignee.html_url | string | required | |
github.event.pull_request.assignee.followers_url | string | required | |
github.event.pull_request.assignee.following_url | string | required | |
github.event.pull_request.assignee.gists_url | string | required | |
github.event.pull_request.assignee.starred_url | string | required | |
github.event.pull_request.assignee.subscriptions_url | string | required | |
github.event.pull_request.assignee.organizations_url | string | required | |
github.event.pull_request.assignee.repos_url | string | required | |
github.event.pull_request.assignee.events_url | string | required | |
github.event.pull_request.assignee.received_events_url | string | required | |
github.event.pull_request.assignee.type | string | required | |
github.event.pull_request.assignee.site_admin | boolean | required | |
github.event.pull_request.assignee.starred_at | string | optional | |
github.event.pull_request.assignees | array of objects or null | optional | |
github.event.pull_request.assignees.name | string or null | optional | |
github.event.pull_request.assignees.email | string or null | optional | |
github.event.pull_request.assignees.login | string | required | |
github.event.pull_request.assignees.id | integer | required | |
github.event.pull_request.assignees.node_id | string | required | |
github.event.pull_request.assignees.avatar_url | string | required | |
github.event.pull_request.assignees.gravatar_id | string or null | required | |
github.event.pull_request.assignees.url | string | required | |
github.event.pull_request.assignees.html_url | string | required | |
github.event.pull_request.assignees.followers_url | string | required | |
github.event.pull_request.assignees.following_url | string | required | |
github.event.pull_request.assignees.gists_url | string | required | |
github.event.pull_request.assignees.starred_url | string | required | |
github.event.pull_request.assignees.subscriptions_url | string | required | |
github.event.pull_request.assignees.organizations_url | string | required | |
github.event.pull_request.assignees.repos_url | string | required | |
github.event.pull_request.assignees.events_url | string | required | |
github.event.pull_request.assignees.received_events_url | string | required | |
github.event.pull_request.assignees.type | string | required | |
github.event.pull_request.assignees.site_admin | boolean | required | |
github.event.pull_request.assignees.starred_at | string | optional | |
github.event.pull_request.requested_reviewers | array of objects or null | optional | |
github.event.pull_request.requested_reviewers.name | string or null | optional | |
github.event.pull_request.requested_reviewers.email | string or null | optional | |
github.event.pull_request.requested_reviewers.login | string | required | |
github.event.pull_request.requested_reviewers.id | integer | required | |
github.event.pull_request.requested_reviewers.node_id | string | required | |
github.event.pull_request.requested_reviewers.avatar_url | string | required | |
github.event.pull_request.requested_reviewers.gravatar_id | string or null | required | |
github.event.pull_request.requested_reviewers.url | string | required | |
github.event.pull_request.requested_reviewers.html_url | string | required | |
github.event.pull_request.requested_reviewers.followers_url | string | required | |
github.event.pull_request.requested_reviewers.following_url | string | required | |
github.event.pull_request.requested_reviewers.gists_url | string | required | |
github.event.pull_request.requested_reviewers.starred_url | string | required | |
github.event.pull_request.requested_reviewers.subscriptions_url | string | required | |
github.event.pull_request.requested_reviewers.organizations_url | string | required | |
github.event.pull_request.requested_reviewers.repos_url | string | required | |
github.event.pull_request.requested_reviewers.events_url | string | required | |
github.event.pull_request.requested_reviewers.received_events_url | string | required | |
github.event.pull_request.requested_reviewers.type | string | required | |
github.event.pull_request.requested_reviewers.site_admin | boolean | required | |
github.event.pull_request.requested_reviewers.starred_at | string | optional | |
github.event.pull_request.requested_teams | array of objects or null | optional | |
github.event.pull_request.requested_teams.node_id | string | required | |
github.event.pull_request.requested_teams.url | string | required | URL for the team |
github.event.pull_request.requested_teams.members_url | string | required | |
github.event.pull_request.requested_teams.description | string or null | required | Description of the team |
github.event.pull_request.requested_teams.permission | string | required | Permission that the team will have for its repositories |
github.event.pull_request.requested_teams.privacy | string | optional | The level of privacy this team should have |
github.event.pull_request.requested_teams.notification_setting | string | optional | The notification setting the team has set |
github.event.pull_request.requested_teams.html_url | string | required | |
github.event.pull_request.requested_teams.repositories_url | string | required | |
github.event.pull_request.requested_teams.slug | string | required | |
github.event.pull_request.requested_teams.ldap_dn | string | optional | Distinguished Name (DN) that team maps to within LDAP environment |
github.event.pull_request.head.label | string | required | |
github.event.pull_request.head.repo | object or null | required | |
github.event.pull_request.head.repo.owner | object | required | |
github.event.pull_request.head.repo.owner.avatar_url | string | required | |
github.event.pull_request.head.repo.owner.events_url | string | required | |
github.event.pull_request.head.repo.owner.followers_url | string | required | |
github.event.pull_request.head.repo.owner.following_url | string | required | |
github.event.pull_request.head.repo.owner.gists_url | string | required | |
github.event.pull_request.head.repo.owner.gravatar_id | string or null | required | |
github.event.pull_request.head.repo.owner.html_url | string | required | |
github.event.pull_request.head.repo.owner.node_id | string | required | |
github.event.pull_request.head.repo.owner.organizations_url | string | required | |
github.event.pull_request.head.repo.owner.received_events_url | string | required | |
github.event.pull_request.head.repo.owner.repos_url | string | required | |
github.event.pull_request.head.repo.owner.site_admin | boolean | required | |
github.event.pull_request.head.repo.owner.starred_url | string | required | |
github.event.pull_request.head.repo.owner.subscriptions_url | string | required | |
github.event.pull_request.head.repo.owner.type | string | required | |
github.event.pull_request.head.repo.owner.url | string | required | |
github.event.pull_request.head.repo.disabled | boolean | required | |
github.event.pull_request.head.repo.visibility | string | optional | The repository visibility: public, private, or internal. |
github.event.pull_request.head.repo.temp_clone_token | string | optional | |
github.event.pull_request.head.repo.license.spdx_id | string or null | required | |
github.event.pull_request.head.repo.pushed_at | string | required | |
github.event.pull_request.head.repo.topics | array of strings | optional | |
github.event.pull_request.head.repo.created_at | string | required | |
github.event.pull_request.head.user | object | required | |
github.event.pull_request.head.user.avatar_url | string | required | |
github.event.pull_request.head.user.events_url | string | required | |
github.event.pull_request.head.user.followers_url | string | required | |
github.event.pull_request.head.user.following_url | string | required | |
github.event.pull_request.head.user.gists_url | string | required | |
github.event.pull_request.head.user.gravatar_id | string or null | required | |
github.event.pull_request.head.user.html_url | string | required | |
github.event.pull_request.head.user.node_id | string | required | |
github.event.pull_request.head.user.organizations_url | string | required | |
github.event.pull_request.head.user.received_events_url | string | required | |
github.event.pull_request.head.user.repos_url | string | required | |
github.event.pull_request.head.user.site_admin | boolean | required | |
github.event.pull_request.head.user.starred_url | string | required | |
github.event.pull_request.head.user.subscriptions_url | string | required | |
github.event.pull_request.head.user.type | string | required | |
github.event.pull_request.head.user.url | string | required | |
github.event.pull_request.base.label | string | required | |
github.event.pull_request.base.repo.owner | object | required | |
github.event.pull_request.base.repo.owner.avatar_url | string | required | |
github.event.pull_request.base.repo.owner.events_url | string | required | |
github.event.pull_request.base.repo.owner.followers_url | string | required | |
github.event.pull_request.base.repo.owner.following_url | string | required | |
github.event.pull_request.base.repo.owner.gists_url | string | required | |
github.event.pull_request.base.repo.owner.gravatar_id | string or null | required | |
github.event.pull_request.base.repo.owner.html_url | string | required | |
github.event.pull_request.base.repo.owner.node_id | string | required | |
github.event.pull_request.base.repo.owner.organizations_url | string | required | |
github.event.pull_request.base.repo.owner.received_events_url | string | required | |
github.event.pull_request.base.repo.owner.repos_url | string | required | |
github.event.pull_request.base.repo.owner.site_admin | boolean | required | |
github.event.pull_request.base.repo.owner.starred_url | string | required | |
github.event.pull_request.base.repo.owner.subscriptions_url | string | required | |
github.event.pull_request.base.repo.owner.type | string | required | |
github.event.pull_request.base.repo.owner.url | string | required | |
github.event.pull_request.base.repo.disabled | boolean | required | |
github.event.pull_request.base.repo.visibility | string | optional | The repository visibility: public, private, or internal. |
github.event.pull_request.base.repo.temp_clone_token | string | optional | |
github.event.pull_request.base.repo.license | object | required | License Simple |
github.event.pull_request.base.repo.license.spdx_id | string or null | required | |
github.event.pull_request.base.repo.license.html_url | string | optional | |
github.event.pull_request.base.repo.pushed_at | string | required | |
github.event.pull_request.base.repo.topics | array of strings | optional | |
github.event.pull_request.base.repo.created_at | string | required | |
github.event.pull_request.base.user | object | required | |
github.event.pull_request.base.user.avatar_url | string | required | |
github.event.pull_request.base.user.events_url | string | required | |
github.event.pull_request.base.user.followers_url | string | required | |
github.event.pull_request.base.user.following_url | string | required | |
github.event.pull_request.base.user.gists_url | string | required | |
github.event.pull_request.base.user.gravatar_id | string or null | required | |
github.event.pull_request.base.user.html_url | string | required | |
github.event.pull_request.base.user.node_id | string | required | |
github.event.pull_request.base.user.organizations_url | string | required | |
github.event.pull_request.base.user.received_events_url | string | required | |
github.event.pull_request.base.user.repos_url | string | required | |
github.event.pull_request.base.user.site_admin | boolean | required | |
github.event.pull_request.base.user.starred_url | string | required | |
github.event.pull_request.base.user.subscriptions_url | string | required | |
github.event.pull_request.base.user.type | string | required | |
github.event.pull_request.base.user.url | string | required | |
github.event.pull_request.auto_merge.enabled_by | object | required | A GitHub user. |
github.event.pull_request.auto_merge.enabled_by.name | string or null | optional | |
github.event.pull_request.auto_merge.enabled_by.node_id | string | required | |
github.event.pull_request.auto_merge.enabled_by.avatar_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.gravatar_id | string or null | required | |
github.event.pull_request.auto_merge.enabled_by.url | string | required | |
github.event.pull_request.auto_merge.enabled_by.html_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.followers_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.following_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.gists_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.starred_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.subscriptions_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.organizations_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.repos_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.events_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.received_events_url | string | required | |
github.event.pull_request.auto_merge.enabled_by.type | string | required | |
github.event.pull_request.auto_merge.enabled_by.site_admin | boolean | required | |
github.event.pull_request.auto_merge.enabled_by.starred_at | string | optional | |
github.event.pull_request.auto_merge.commit_title | string | required | Title for the merge commit message. |
github.event.pull_request.auto_merge.commit_message | string | required | Commit message for the merge commit. |
github.event.pull_request.draft | boolean | optional | Indicates whether or not the pull request is a draft. |
github.event.pull_request.merged | boolean | required | |
github.event.pull_request.mergeable | boolean or null | required | |
github.event.pull_request.mergeable_state | string | required | |
github.event.pull_request.merged_by | object | required | A GitHub user. |
github.event.pull_request.merged_by.name | string or null | optional | |
github.event.pull_request.merged_by.node_id | string | required | |
github.event.pull_request.merged_by.avatar_url | string | required | |
github.event.pull_request.merged_by.gravatar_id | string or null | required | |
github.event.pull_request.merged_by.url | string | required | |
github.event.pull_request.merged_by.html_url | string | required | |
github.event.pull_request.merged_by.followers_url | string | required | |
github.event.pull_request.merged_by.following_url | string | required | |
github.event.pull_request.merged_by.gists_url | string | required | |
github.event.pull_request.merged_by.starred_url | string | required | |
github.event.pull_request.merged_by.subscriptions_url | string | required | |
github.event.pull_request.merged_by.organizations_url | string | required | |
github.event.pull_request.merged_by.repos_url | string | required | |
github.event.pull_request.merged_by.events_url | string | required | |
github.event.pull_request.merged_by.received_events_url | string | required | |
github.event.pull_request.merged_by.type | string | required | |
github.event.pull_request.merged_by.site_admin | boolean | required | |
github.event.pull_request.merged_by.starred_at | string | optional | |
github.event.pull_request.comments | integer | required | |
github.event.pull_request.review_comments | integer | required | |
github.event.pull_request.maintainer_can_modify | boolean | required | Indicates whether maintainers can modify the pull request. |
github.event.pull_request.commits | integer | required | |
github.event.pull_request.additions | integer | required | |
github.event.pull_request.deletions | integer | required | |
github.event.pull_request.changed_files | integer | required | |
github.event.pull_request.allow_auto_merge | boolean | optional | Whether to allow auto-merge for pull requests. |
github.event.pull_request.allow_update_branch | boolean | optional | Whether to allow updating the pull request’s branch. |
github.event.pull_request.delete_branch_on_merge | boolean | optional | Whether to delete head branches when pull requests are merged. |
github.event.pull_request.merge_commit_message | PR_BODY , PR_TITLE , BLANK | optional | The default value for a merge commit message.
|
github.event.pull_request.merge_commit_title | PR_TITLE , MERGE_MESSAGE | optional | The default value for a merge commit title.
|
github.event.pull_request.squash_merge_commit_message | PR_BODY , COMMIT_MESSAGES , BLANK | optional | The default value for a squash merge commit message:
|
github.event.pull_request.squash_merge_commit_title | PR_TITLE , COMMIT_OR_PR_TITLE | optional | The default value for a squash merge commit title:
|
github.event.pull_request.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 |
github.event.sender | object | required | The GitHub user that triggered the event. This property is included in every webhook payload. |
review_request_removed
#
This event occurs when there is activity on a pull request. For more information, see "About pull requests." For information about the APIs to manage pull requests, see the GraphQL API documentation or "Pulls" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review
, pull_request_review_comment
, 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 | review_request_removed | required | |
github.event.installation | object | optional | The GitHub App installation. Webhook payloads contain the |
github.event.pull_request.active_lock_reason | resolved , off-topic , too heated , spam , None | required | |
github.event.pull_request.additions | integer | optional | |
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.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.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.type | Bot , User , Organization | optional | |
github.event.pull_request.assignee.url | string | optional | |
github.event.pull_request.assignees | array of object,nulls | required | |
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.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.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.base.label | string | required | |
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_update_branch | boolean | optional | |
github.event.pull_request.base.repo.created_at | integer or string | required | |
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.disabled | boolean | optional | Returns whether or not this repository is disabled. |
github.event.pull_request.base.repo.license | object or null | required | |
github.event.pull_request.base.repo.license.spdx_id | string | required | |
github.event.pull_request.base.repo.merge_commit_message | PR_BODY , PR_TITLE , BLANK | optional | The default value for a merge commit message.
|
github.event.pull_request.base.repo.merge_commit_title | PR_TITLE , MERGE_MESSAGE | optional | The default value for a merge commit title.
|
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.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.public | boolean | optional | |
github.event.pull_request.base.repo.pushed_at | null or integer or string | required | |
github.event.pull_request.base.repo.role_name | string or null | optional | |
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:
|
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:
|
github.event.pull_request.base.repo.stargazers | integer | optional | |
github.event.pull_request.base.repo.topics | array of strings | 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 |
github.event.pull_request.base.repo.visibility | public , private , internal | 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.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.changed_files | integer | optional | |
github.event.pull_request.comments | integer | optional | |
github.event.pull_request.commits | integer | optional | |
github.event.pull_request.deletions | integer | optional | |
github.event.pull_request.draft | boolean | required | Indicates whether or not the pull request is a draft. |
github.event.pull_request.head.label | string | required | |
github.event.pull_request.head.repo | object | 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_update_branch | boolean | optional | |
github.event.pull_request.head.repo.created_at | integer or string | required | |
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.disabled | boolean | optional | Returns whether or not this repository is disabled. |
github.event.pull_request.head.repo.license.spdx_id | string | required | |
github.event.pull_request.head.repo.merge_commit_message | PR_BODY , PR_TITLE , BLANK | optional | The default value for a merge commit message.
|
github.event.pull_request.head.repo.merge_commit_title | PR_TITLE , MERGE_MESSAGE | optional | The default value for a merge commit title.
|
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.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.public | boolean | optional | |
github.event.pull_request.head.repo.pushed_at | null or integer or string | required | |
github.event.pull_request.head.repo.role_name | string or null | optional | |
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:
|
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:
|
github.event.pull_request.head.repo.stargazers | integer | optional | |
github.event.pull_request.head.repo.topics | array of strings | 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 |
github.event.pull_request.head.repo.visibility | public , private , internal | 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.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.maintainer_can_modify | boolean | optional | Indicates whether maintainers can modify the pull request. |
github.event.pull_request.mergeable | boolean or null | optional | |
github.event.pull_request.mergeable_state | string | optional | |
github.event.pull_request.merged | boolean or null | optional | |
github.event.pull_request.merged_by | object or null | optional | |
github.event.pull_request.merged_by.avatar_url | string | optional | |
github.event.pull_request.merged_by.deleted | boolean | optional | |
github.event.pull_request.merged_by.events_url | string | optional | |
github.event.pull_request.merged_by.followers_url | string | optional | |
github.event.pull_request.merged_by.following_url | string | optional | |
github.event.pull_request.merged_by.gists_url | string | optional | |
github.event.pull_request.merged_by.gravatar_id | string | optional | |
github.event.pull_request.merged_by.html_url | string | optional | |
github.event.pull_request.merged_by.name | string | optional | |
github.event.pull_request.merged_by.node_id | string | optional | |
github.event.pull_request.merged_by.organizations_url | string | optional | |
github.event.pull_request.merged_by.received_events_url | string | optional | |
github.event.pull_request.merged_by.repos_url | string | optional | |
github.event.pull_request.merged_by.site_admin | boolean | optional | |
github.event.pull_request.merged_by.starred_url | string | optional | |
github.event.pull_request.merged_by.subscriptions_url | string | optional | |
github.event.pull_request.merged_by.type | Bot , User , Organization | optional | |
github.event.pull_request.merged_by.url | string | optional | |
github.event.pull_request.milestone | object or null | required | A collection of related issues and pull requests. |
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.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.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.type | Bot , User , Organization | optional | |
github.event.pull_request.milestone.creator.url | string | optional | |
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 | required | Description of the team |
github.event.pull_request.requested_teams.html_url | string | required | |
github.event.pull_request.requested_teams.members_url | string | required | |
github.event.pull_request.requested_teams.node_id | string | required | |
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 | required | Permission that the team will have for its repositories |
github.event.pull_request.requested_teams.privacy | open , closed , secret | required | |
github.event.pull_request.requested_teams.repositories_url | string | required | |
github.event.pull_request.requested_teams.slug | string | required | |
github.event.pull_request.requested_teams.url | string | required | URL for the team |
github.event.pull_request.review_comments | integer | optional | |
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.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.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 | optional | |
github.event.pull_request.user.url | string | optional | |
github.event.requested_reviewer | object or null | required | |
github.event.requested_reviewer.avatar_url | string | optional | |
github.event.requested_reviewer.deleted | boolean | optional | |
github.event.requested_reviewer.email | string or null | optional | |
github.event.requested_reviewer.events_url | string | optional | |
github.event.requested_reviewer.followers_url | string | optional | |
github.event.requested_reviewer.following_url | string | optional | |
github.event.requested_reviewer.gists_url | string | optional | |
github.event.requested_reviewer.gravatar_id | string | optional | |
github.event.requested_reviewer.html_url | string | optional | |
github.event.requested_reviewer.id | integer | required | |
github.event.requested_reviewer.login | string | required | |
github.event.requested_reviewer.name | string | optional | |
github.event.requested_reviewer.node_id | string | optional | |
github.event.requested_reviewer.organizations_url | string | optional | |
github.event.requested_reviewer.received_events_url | string | optional | |
github.event.requested_reviewer.repos_url | string | optional | |
github.event.requested_reviewer.site_admin | boolean | optional | |
github.event.requested_reviewer.starred_url | string | optional | |
github.event.requested_reviewer.subscriptions_url | string | optional | |
github.event.requested_reviewer.type | Bot , User , Organization | optional | |
github.event.requested_reviewer.url | string | optional | |
github.event.sender | object | required | The GitHub user that triggered the event. This property is included in every webhook payload. |
github.event.requested_team | object | required | Groups of organization members that gives permissions on specified repositories. |
github.event.requested_team.deleted | boolean | optional | |
github.event.requested_team.description | string or null | required | Description of the team |
github.event.requested_team.html_url | string | required | |
github.event.requested_team.id | integer | required | Unique identifier of the team |
github.event.requested_team.members_url | string | required | |
github.event.requested_team.name | string | required | Name of the team |
github.event.requested_team.node_id | string | required | |
github.event.requested_team.parent | object or null | optional | |
github.event.requested_team.parent.description | string or null | required | Description of the team |
github.event.requested_team.parent.html_url | string | required | |
github.event.requested_team.parent.id | integer | required | Unique identifier of the team |
github.event.requested_team.parent.members_url | string | required | |
github.event.requested_team.parent.name | string | required | Name of the team |
github.event.requested_team.parent.node_id | string | required | |
github.event.requested_team.parent.permission | string | required | Permission that the team will have for its repositories |
github.event.requested_team.parent.privacy | open , closed , secret | required | |
github.event.requested_team.parent.repositories_url | string | required | |
github.event.requested_team.parent.slug | string | required | |
github.event.requested_team.parent.url | string | required | URL for the team |
github.event.requested_team.permission | string | required | Permission that the team will have for its repositories |
github.event.requested_team.privacy | open , closed , secret | required | |
github.event.requested_team.repositories_url | string | required | |
github.event.requested_team.slug | string | required | |
github.event.requested_team.url | string | required | URL for the team |
review_requested
#
This event occurs when there is activity on a pull request. For more information, see "About pull requests." For information about the APIs to manage pull requests, see the GraphQL API documentation or "Pulls" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review
, pull_request_review_comment
, 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 | review_requested | required | |
github.event.installation | object | optional | The GitHub App installation. Webhook payloads contain the |
github.event.pull_request.active_lock_reason | resolved , off-topic , too heated , spam , None | required | |
github.event.pull_request.additions | integer | optional | |
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.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.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.type | Bot , User , Organization , Mannequin | optional | |
github.event.pull_request.assignee.url | string | optional | |
github.event.pull_request.assignees | array of object,nulls | required | |
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.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.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.base.label | string | required | |
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_update_branch | boolean | optional | |
github.event.pull_request.base.repo.created_at | integer or string | required | |
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.disabled | boolean | optional | Returns whether or not this repository is disabled. |
github.event.pull_request.base.repo.license | object or null | required | |
github.event.pull_request.base.repo.license.spdx_id | string | required | |
github.event.pull_request.base.repo.merge_commit_message | PR_BODY , PR_TITLE , BLANK | optional | The default value for a merge commit message.
|
github.event.pull_request.base.repo.merge_commit_title | PR_TITLE , MERGE_MESSAGE | optional | The default value for a merge commit title.
|
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.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.public | boolean | optional | |
github.event.pull_request.base.repo.pushed_at | null or integer or string | required | |
github.event.pull_request.base.repo.role_name | string or null | optional | |
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:
|
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:
|
github.event.pull_request.base.repo.stargazers | integer | optional | |
github.event.pull_request.base.repo.topics | array of strings | 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 |
github.event.pull_request.base.repo.visibility | public , private , internal | 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.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.changed_files | integer | optional | |
github.event.pull_request.comments | integer | optional | |
github.event.pull_request.commits | integer | optional | |
github.event.pull_request.deletions | integer | optional | |
github.event.pull_request.draft | boolean | required | Indicates whether or not the pull request is a draft. |
github.event.pull_request.head.label | string | required | |
github.event.pull_request.head.repo | object | 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_update_branch | boolean | optional | |
github.event.pull_request.head.repo.created_at | integer or string | required | |
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.disabled | boolean | optional | Returns whether or not this repository is disabled. |
github.event.pull_request.head.repo.license.spdx_id | string | required | |
github.event.pull_request.head.repo.merge_commit_message | PR_BODY , PR_TITLE , BLANK | optional | The default value for a merge commit message.
|
github.event.pull_request.head.repo.merge_commit_title | PR_TITLE , MERGE_MESSAGE | optional | The default value for a merge commit title.
|
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.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.public | boolean | optional | |
github.event.pull_request.head.repo.pushed_at | null or integer or string | required | |
github.event.pull_request.head.repo.role_name | string or null | optional | |
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:
|
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:
|
github.event.pull_request.head.repo.stargazers | integer | optional | |
github.event.pull_request.head.repo.topics | array of strings | 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 |
github.event.pull_request.head.repo.visibility | public , private , internal | 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.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.maintainer_can_modify | boolean | optional | Indicates whether maintainers can modify the pull request. |
github.event.pull_request.mergeable | boolean or null | optional | |
github.event.pull_request.mergeable_state | string | optional | |
github.event.pull_request.merged | boolean or null | optional | |
github.event.pull_request.merged_by | object or null | optional | |
github.event.pull_request.merged_by.avatar_url | string | optional | |
github.event.pull_request.merged_by.deleted | boolean | optional | |
github.event.pull_request.merged_by.events_url | string | optional | |
github.event.pull_request.merged_by.followers_url | string | optional | |
github.event.pull_request.merged_by.following_url | string | optional | |
github.event.pull_request.merged_by.gists_url | string | optional | |
github.event.pull_request.merged_by.gravatar_id | string | optional | |
github.event.pull_request.merged_by.html_url | string | optional | |
github.event.pull_request.merged_by.name | string | optional | |
github.event.pull_request.merged_by.node_id | string | optional | |
github.event.pull_request.merged_by.organizations_url | string | optional | |
github.event.pull_request.merged_by.received_events_url | string | optional | |
github.event.pull_request.merged_by.repos_url | string | optional | |
github.event.pull_request.merged_by.site_admin | boolean | optional | |
github.event.pull_request.merged_by.starred_url | string | optional | |
github.event.pull_request.merged_by.subscriptions_url | string | optional | |
github.event.pull_request.merged_by.type | Bot , User , Organization | optional | |
github.event.pull_request.merged_by.url | string | optional | |
github.event.pull_request.milestone | object or null | required | A collection of related issues and pull requests. |
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.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.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.type | Bot , User , Organization , Mannequin | optional | |
github.event.pull_request.milestone.creator.url | string | optional | |
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.members_url | string | optional | |
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_comments | integer | optional | |
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.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.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.requested_reviewer | object or null | required | |
github.event.requested_reviewer.avatar_url | string | optional | |
github.event.requested_reviewer.deleted | boolean | optional | |
github.event.requested_reviewer.email | string or null | optional | |
github.event.requested_reviewer.events_url | string | optional | |
github.event.requested_reviewer.followers_url | string | optional | |
github.event.requested_reviewer.following_url | string | optional | |
github.event.requested_reviewer.gists_url | string | optional | |
github.event.requested_reviewer.gravatar_id | string | optional | |
github.event.requested_reviewer.html_url | string | optional | |
github.event.requested_reviewer.id | integer | required | |
github.event.requested_reviewer.login | string | required | |
github.event.requested_reviewer.name | string | optional | |
github.event.requested_reviewer.node_id | string | optional | |
github.event.requested_reviewer.organizations_url | string | optional | |
github.event.requested_reviewer.received_events_url | string | optional | |
github.event.requested_reviewer.repos_url | string | optional | |
github.event.requested_reviewer.site_admin | boolean | optional | |
github.event.requested_reviewer.starred_url | string | optional | |
github.event.requested_reviewer.subscriptions_url | string | optional | |
github.event.requested_reviewer.type | Bot , User , Organization , Mannequin | optional | |
github.event.requested_reviewer.url | string | optional | |
github.event.sender | object | required | The GitHub user that triggered the event. This property is included in every webhook payload. |
github.event.requested_team | object | required | Groups of organization members that gives permissions on specified repositories. |
github.event.requested_team.deleted | boolean | optional | |
github.event.requested_team.description | string or null | optional | Description of the team |
github.event.requested_team.html_url | string | optional | |
github.event.requested_team.id | integer | required | Unique identifier of the team |
github.event.requested_team.members_url | string | optional | |
github.event.requested_team.name | string | required | Name of the team |
github.event.requested_team.node_id | string | optional | |
github.event.requested_team.parent | object or null | optional | |
github.event.requested_team.parent.description | string or null | required | Description of the team |
github.event.requested_team.parent.html_url | string | required | |
github.event.requested_team.parent.id | integer | required | Unique identifier of the team |
github.event.requested_team.parent.members_url | string | required | |
github.event.requested_team.parent.name | string | required | Name of the team |
github.event.requested_team.parent.node_id | string | required | |
github.event.requested_team.parent.permission | string | required | Permission that the team will have for its repositories |
github.event.requested_team.parent.privacy | open , closed , secret | required | |
github.event.requested_team.parent.repositories_url | string | required | |
github.event.requested_team.parent.slug | string | required | |
github.event.requested_team.parent.url | string | required | URL for the team |
github.event.requested_team.permission | string | optional | Permission that the team will have for its repositories |
github.event.requested_team.privacy | open , closed , secret | optional | |
github.event.requested_team.repositories_url | string | optional | |
github.event.requested_team.slug | string | optional | |
github.event.requested_team.url | string | optional | URL for the team |
synchronize
#
This event occurs when there is activity on a pull request. For more information, see "About pull requests." For information about the APIs to manage pull requests, see the GraphQL API documentation or "Pulls" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review
, pull_request_review_comment
, 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 | synchronize | required | |
github.event.after | string | required | |
github.event.before | string | required | |
github.event.installation | object | optional | The GitHub App installation. Webhook payloads contain the |
github.event.pull_request.active_lock_reason | resolved , off-topic , too heated , spam , None | required | |
github.event.pull_request.additions | integer | optional | |
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.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.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.type | Bot , User , Organization , Mannequin | optional | |
github.event.pull_request.assignee.url | string | optional | |
github.event.pull_request.assignees | array of object,nulls | required | |
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.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.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.base.label | string | required | |
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_update_branch | boolean | optional | |
github.event.pull_request.base.repo.created_at | integer or string | required | |
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.disabled | boolean | optional | Returns whether or not this repository is disabled. |
github.event.pull_request.base.repo.license | object or null | required | |
github.event.pull_request.base.repo.license.spdx_id | string | required | |
github.event.pull_request.base.repo.merge_commit_message | PR_BODY , PR_TITLE , BLANK | optional | The default value for a merge commit message.
|
github.event.pull_request.base.repo.merge_commit_title | PR_TITLE , MERGE_MESSAGE | optional | The default value for a merge commit title.
|
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.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.public | boolean | optional | |
github.event.pull_request.base.repo.pushed_at | null or integer or string | required | |
github.event.pull_request.base.repo.role_name | string or null | optional | |
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:
|
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:
|
github.event.pull_request.base.repo.stargazers | integer | optional | |
github.event.pull_request.base.repo.topics | array of strings | 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 |
github.event.pull_request.base.repo.visibility | public , private , internal | 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.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.changed_files | integer | optional | |
github.event.pull_request.comments | integer | optional | |
github.event.pull_request.commits | integer | optional | |
github.event.pull_request.deletions | integer | optional | |
github.event.pull_request.draft | boolean | required | Indicates whether or not the pull request is a draft. |
github.event.pull_request.head.label | string | required | |
github.event.pull_request.head.repo | object | 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_update_branch | boolean | optional | |
github.event.pull_request.head.repo.created_at | integer or string | required | |
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.disabled | boolean | optional | Returns whether or not this repository is disabled. |
github.event.pull_request.head.repo.license.spdx_id | string | required | |
github.event.pull_request.head.repo.merge_commit_message | PR_BODY , PR_TITLE , BLANK | optional | The default value for a merge commit message. |
github.event.pull_request.head.repo.merge_commit_title | PR_TITLE , MERGE_MESSAGE | optional | The default value for a merge commit message title. |
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.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.public | boolean | optional | |
github.event.pull_request.head.repo.pushed_at | null or integer or string | required | |
github.event.pull_request.head.repo.role_name | string or null | optional | |
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:
|
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:
|
github.event.pull_request.head.repo.stargazers | integer | optional | |
github.event.pull_request.head.repo.topics | array of strings | 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 |
github.event.pull_request.head.repo.visibility | public , private , internal | 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.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.maintainer_can_modify | boolean | optional | Indicates whether maintainers can modify the pull request. |
github.event.pull_request.mergeable | boolean or null | optional | |
github.event.pull_request.mergeable_state | string | optional | |
github.event.pull_request.merged | boolean or null | optional | |
github.event.pull_request.merged_by | object or null | optional | |
github.event.pull_request.merged_by.avatar_url | string | optional | |
github.event.pull_request.merged_by.deleted | boolean | optional | |
github.event.pull_request.merged_by.events_url | string | optional | |
github.event.pull_request.merged_by.followers_url | string | optional | |
github.event.pull_request.merged_by.following_url | string | optional | |
github.event.pull_request.merged_by.gists_url | string | optional | |
github.event.pull_request.merged_by.gravatar_id | string | optional | |
github.event.pull_request.merged_by.html_url | string | optional | |
github.event.pull_request.merged_by.name | string | optional | |
github.event.pull_request.merged_by.node_id | string | optional | |
github.event.pull_request.merged_by.organizations_url | string | optional | |
github.event.pull_request.merged_by.received_events_url | string | optional | |
github.event.pull_request.merged_by.repos_url | string | optional | |
github.event.pull_request.merged_by.site_admin | boolean | optional | |
github.event.pull_request.merged_by.starred_url | string | optional | |
github.event.pull_request.merged_by.subscriptions_url | string | optional | |
github.event.pull_request.merged_by.type | Bot , User , Organization | optional | |
github.event.pull_request.merged_by.url | string | optional | |
github.event.pull_request.milestone | object or null | required | A collection of related issues and pull requests. |
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.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.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.type | Bot , User , Organization , Mannequin | optional | |
github.event.pull_request.milestone.creator.url | string | optional | |
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.members_url | string | optional | |
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_comments | integer | optional | |
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.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.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.sender | object | required | The GitHub user that triggered the event. This property is included in every webhook payload. |
unassigned
#
This event occurs when there is activity on a pull request. For more information, see "About pull requests." For information about the APIs to manage pull requests, see the GraphQL API documentation or "Pulls" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review
, pull_request_review_comment
, 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 | unassigned | required | |
github.event.assignee | object or null | optional | |
github.event.assignee.avatar_url | string | optional | |
github.event.assignee.deleted | boolean | optional | |
github.event.assignee.email | string or null | optional | |
github.event.assignee.events_url | string | optional | |
github.event.assignee.followers_url | string | optional | |
github.event.assignee.following_url | string | optional | |
github.event.assignee.gists_url | string | optional | |
github.event.assignee.gravatar_id | string | optional | |
github.event.assignee.html_url | string | optional | |
github.event.assignee.id | integer | required | |
github.event.assignee.login | string | required | |
github.event.assignee.name | string | optional | |
github.event.assignee.node_id | string | optional | |
github.event.assignee.organizations_url | string | optional | |
github.event.assignee.received_events_url | string | optional | |
github.event.assignee.repos_url | string | optional | |
github.event.assignee.site_admin | boolean | optional | |
github.event.assignee.starred_url | string | optional | |
github.event.assignee.subscriptions_url | string | optional | |
github.event.assignee.type | Bot , User , Organization , Mannequin | optional | |
github.event.assignee.url | string | optional | |
github.event.installation | object | optional | The GitHub App installation. Webhook payloads contain the |
github.event.pull_request.active_lock_reason | resolved , off-topic , too heated , spam , None | required | |
github.event.pull_request.additions | integer | optional | |
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.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.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.type | Bot , User , Organization , Mannequin | optional | |
github.event.pull_request.assignee.url | string | optional | |
github.event.pull_request.assignees | array of object,nulls | required | |
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.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.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.base.label | string or null | required | |
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_update_branch | boolean | optional | |
github.event.pull_request.base.repo.created_at | integer or string | required | |
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.disabled | boolean | optional | Returns whether or not this repository is disabled. |
github.event.pull_request.base.repo.license | object or null | required | |
github.event.pull_request.base.repo.license.spdx_id | string | required | |
github.event.pull_request.base.repo.merge_commit_message | PR_BODY , PR_TITLE , BLANK | optional | The default value for a merge commit message.
|
github.event.pull_request.base.repo.merge_commit_title | PR_TITLE , MERGE_MESSAGE | optional | The default value for a merge commit title.
|
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.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.public | boolean | optional | |
github.event.pull_request.base.repo.pushed_at | null or integer or string | required | |
github.event.pull_request.base.repo.role_name | string or null | optional | |
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:
|
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:
|
github.event.pull_request.base.repo.stargazers | integer | optional | |
github.event.pull_request.base.repo.topics | array of strings | 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 |
github.event.pull_request.base.repo.visibility | public , private , internal | 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.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.changed_files | integer | optional | |
github.event.pull_request.comments | integer | optional | |
github.event.pull_request.commits | integer | optional | |
github.event.pull_request.deletions | integer | optional | |
github.event.pull_request.draft | boolean | required | Indicates whether or not the pull request is a draft. |
github.event.pull_request.head.label | string or null | 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_update_branch | boolean | optional | |
github.event.pull_request.head.repo.created_at | integer or string | required | |
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.disabled | boolean | optional | Returns whether or not this repository is disabled. |
github.event.pull_request.head.repo.license.spdx_id | string | required | |
github.event.pull_request.head.repo.merge_commit_message | PR_BODY , PR_TITLE , BLANK | optional | The default value for a merge commit message.
|
github.event.pull_request.head.repo.merge_commit_title | PR_TITLE , MERGE_MESSAGE | optional | The default value for a merge commit title.
|
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.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.public | boolean | optional | |
github.event.pull_request.head.repo.pushed_at | null or integer or string | required | |
github.event.pull_request.head.repo.role_name | string or null | optional | |
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:
|
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:
|
github.event.pull_request.head.repo.stargazers | integer | optional | |
github.event.pull_request.head.repo.topics | array of strings | 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 |
github.event.pull_request.head.repo.visibility | public , private , internal | 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.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.maintainer_can_modify | boolean | optional | Indicates whether maintainers can modify the pull request. |
github.event.pull_request.mergeable | boolean or null | optional | |
github.event.pull_request.mergeable_state | string | optional | |
github.event.pull_request.merged | boolean or null | optional | |
github.event.pull_request.merged_by | object or null | optional | |
github.event.pull_request.merged_by.avatar_url | string | optional | |
github.event.pull_request.merged_by.deleted | boolean | optional | |
github.event.pull_request.merged_by.events_url | string | optional | |
github.event.pull_request.merged_by.followers_url | string | optional | |
github.event.pull_request.merged_by.following_url | string | optional | |
github.event.pull_request.merged_by.gists_url | string | optional | |
github.event.pull_request.merged_by.gravatar_id | string | optional | |
github.event.pull_request.merged_by.html_url | string | optional | |
github.event.pull_request.merged_by.name | string | optional | |
github.event.pull_request.merged_by.node_id | string | optional | |
github.event.pull_request.merged_by.organizations_url | string | optional | |
github.event.pull_request.merged_by.received_events_url | string | optional | |
github.event.pull_request.merged_by.repos_url | string | optional | |
github.event.pull_request.merged_by.site_admin | boolean | optional | |
github.event.pull_request.merged_by.starred_url | string | optional | |
github.event.pull_request.merged_by.subscriptions_url | string | optional | |
github.event.pull_request.merged_by.type | Bot , User , Organization , Mannequin | optional | |
github.event.pull_request.merged_by.url | string | optional | |
github.event.pull_request.milestone | object or null | required | A collection of related issues and pull requests. |
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.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.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.type | Bot , User , Organization , Mannequin | optional | |
github.event.pull_request.milestone.creator.url | string | optional | |
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.members_url | string | optional | |
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_comments | integer | optional | |
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.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.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.sender | object | optional | The GitHub user that triggered the event. This property is included in every webhook payload. |
unlabeled
#
This event occurs when there is activity on a pull request. For more information, see "About pull requests." For information about the APIs to manage pull requests, see the GraphQL API documentation or "Pulls" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review
, pull_request_review_comment
, 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 | unlabeled | required | |
github.event.installation | object | optional | The GitHub App installation. Webhook payloads contain the |
github.event.label | object | optional | |
github.event.label.color | string | required | 6-character hex code, without the leading #, identifying the color |
github.event.label.default | boolean | required | |
github.event.label.description | string or null | required | |
github.event.label.id | integer | required | |
github.event.label.name | string | required | The name of the label. |
github.event.label.node_id | string | required | |
github.event.label.url | string | required | URL for the label |
github.event.pull_request.active_lock_reason | resolved , off-topic , too heated , spam , None | required | |
github.event.pull_request.additions | integer | optional | |
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.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.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.type | Bot , User , Organization , Mannequin | optional | |
github.event.pull_request.assignee.url | string | optional | |
github.event.pull_request.assignees | array of object,nulls | required | |
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.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.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.base.label | string | required | |
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_update_branch | boolean | optional | |
github.event.pull_request.base.repo.created_at | integer or string | required | |
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.disabled | boolean | optional | Returns whether or not this repository is disabled. |
github.event.pull_request.base.repo.license | object or null | required | |
github.event.pull_request.base.repo.license.spdx_id | string | required | |
github.event.pull_request.base.repo.merge_commit_message | PR_BODY , PR_TITLE , BLANK | optional | The default value for a merge commit message.
|
github.event.pull_request.base.repo.merge_commit_title | PR_TITLE , MERGE_MESSAGE | optional | The default value for a merge commit title.
|
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.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.public | boolean | optional | |
github.event.pull_request.base.repo.pushed_at | null or integer or string | required | |
github.event.pull_request.base.repo.role_name | string or null | optional | |
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:
|
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:
|
github.event.pull_request.base.repo.stargazers | integer | optional | |
github.event.pull_request.base.repo.topics | array of strings | 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 |
github.event.pull_request.base.repo.visibility | public , private , internal | 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.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.changed_files | integer | optional | |
github.event.pull_request.comments | integer | optional | |
github.event.pull_request.commits | integer | optional | |
github.event.pull_request.deletions | integer | optional | |
github.event.pull_request.draft | boolean | required | Indicates whether or not the pull request is a draft. |
github.event.pull_request.head.label | string or null | 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_update_branch | boolean | optional | |
github.event.pull_request.head.repo.created_at | integer or string | required | |
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.disabled | boolean | optional | Returns whether or not this repository is disabled. |
github.event.pull_request.head.repo.license.spdx_id | string | required | |
github.event.pull_request.head.repo.merge_commit_message | PR_BODY , PR_TITLE , BLANK | optional | The default value for a merge commit message. |
github.event.pull_request.head.repo.merge_commit_title | PR_TITLE , MERGE_MESSAGE | optional | The default value for a merge commit message title. |
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.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.public | boolean | optional | |
github.event.pull_request.head.repo.pushed_at | null or integer or string | required | |
github.event.pull_request.head.repo.role_name | string or null | optional | |
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:
|
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:
|
github.event.pull_request.head.repo.stargazers | integer | optional | |
github.event.pull_request.head.repo.topics | array of strings | 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 |
github.event.pull_request.head.repo.visibility | public , private , internal | 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.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.maintainer_can_modify | boolean | optional | Indicates whether maintainers can modify the pull request. |
github.event.pull_request.mergeable | boolean or null | optional | |
github.event.pull_request.mergeable_state | string | optional | |
github.event.pull_request.merged | boolean or null | optional | |
github.event.pull_request.merged_by | object or null | optional | |
github.event.pull_request.merged_by.avatar_url | string | optional | |
github.event.pull_request.merged_by.deleted | boolean | optional | |
github.event.pull_request.merged_by.events_url | string | optional | |
github.event.pull_request.merged_by.followers_url | string | optional | |
github.event.pull_request.merged_by.following_url | string | optional | |
github.event.pull_request.merged_by.gists_url | string | optional | |
github.event.pull_request.merged_by.gravatar_id | string | optional | |
github.event.pull_request.merged_by.html_url | string | optional | |
github.event.pull_request.merged_by.name | string | optional | |
github.event.pull_request.merged_by.node_id | string | optional | |
github.event.pull_request.merged_by.organizations_url | string | optional | |
github.event.pull_request.merged_by.received_events_url | string | optional | |
github.event.pull_request.merged_by.repos_url | string | optional | |
github.event.pull_request.merged_by.site_admin | boolean | optional | |
github.event.pull_request.merged_by.starred_url | string | optional | |
github.event.pull_request.merged_by.subscriptions_url | string | optional | |
github.event.pull_request.merged_by.type | Bot , User , Organization | optional | |
github.event.pull_request.merged_by.url | string | optional | |
github.event.pull_request.milestone | object or null | required | A collection of related issues and pull requests. |
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.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.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.type | Bot , User , Organization , Mannequin | optional | |
github.event.pull_request.milestone.creator.url | string | optional | |
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.members_url | string | optional | |
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_comments | integer | optional | |
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.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.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.sender | object | required | The GitHub user that triggered the event. This property is included in every webhook payload. |
unlocked
#
This event occurs when there is activity on a pull request. For more information, see "About pull requests." For information about the APIs to manage pull requests, see the GraphQL API documentation or "Pulls" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review
, pull_request_review_comment
, 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 | unlocked | required | |
github.event.installation | object | optional | The GitHub App installation. Webhook payloads contain the |
github.event.pull_request.active_lock_reason | resolved , off-topic , too heated , spam , None | required | |
github.event.pull_request.additions | integer | optional | |
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.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.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.type | Bot , User , Organization | optional | |
github.event.pull_request.assignee.url | string | optional | |
github.event.pull_request.assignees | array of object,nulls | required | |
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 | 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.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.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.base.label | string | required | |
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_update_branch | boolean | optional | |
github.event.pull_request.base.repo.created_at | integer or string | required | |
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.disabled | boolean | optional | Returns whether or not this repository is disabled. |
github.event.pull_request.base.repo.license | object or null | required | |
github.event.pull_request.base.repo.license.spdx_id | string | required | |
github.event.pull_request.base.repo.merge_commit_message | PR_BODY , PR_TITLE , BLANK | optional | The default value for a merge commit message.
|
github.event.pull_request.base.repo.merge_commit_title | PR_TITLE , MERGE_MESSAGE | optional | The default value for a merge commit title.
|
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.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.public | boolean | optional | |
github.event.pull_request.base.repo.pushed_at | null or integer or string | required | |
github.event.pull_request.base.repo.role_name | string or null | optional | |
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:
|
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:
|
github.event.pull_request.base.repo.stargazers | integer | optional | |
github.event.pull_request.base.repo.topics | array of strings | 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 |
github.event.pull_request.base.repo.visibility | public , private , internal | 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.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.changed_files | integer | optional | |
github.event.pull_request.comments | integer | optional | |
github.event.pull_request.commits | integer | optional | |
github.event.pull_request.deletions | integer | optional | |
github.event.pull_request.draft | boolean | required | Indicates whether or not the pull request is a draft. |
github.event.pull_request.head.label | 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_update_branch | boolean | optional | |
github.event.pull_request.head.repo.created_at | integer or string | required | |
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.disabled | boolean | optional | Returns whether or not this repository is disabled. |
github.event.pull_request.head.repo.license.spdx_id | string | required | |
github.event.pull_request.head.repo.merge_commit_message | PR_BODY , PR_TITLE , BLANK | optional | The default value for a merge commit message.
|
github.event.pull_request.head.repo.merge_commit_title | PR_TITLE , MERGE_MESSAGE | optional | The default value for a merge commit title.
|
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.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.public | boolean | optional | |
github.event.pull_request.head.repo.pushed_at | null or integer or string | required | |
github.event.pull_request.head.repo.role_name | string or null | optional | |
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:
|
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:
|
github.event.pull_request.head.repo.stargazers | integer | optional | |
github.event.pull_request.head.repo.topics | array of strings | 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 |
github.event.pull_request.head.repo.visibility | public , private , internal | 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.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.maintainer_can_modify | boolean | optional | Indicates whether maintainers can modify the pull request. |
github.event.pull_request.mergeable | boolean or null | optional | |
github.event.pull_request.mergeable_state | string | optional | |
github.event.pull_request.merged | boolean or null | optional | |
github.event.pull_request.merged_by | object or null | optional | |
github.event.pull_request.merged_by.avatar_url | string | optional | |
github.event.pull_request.merged_by.deleted | boolean | optional | |
github.event.pull_request.merged_by.events_url | string | optional | |
github.event.pull_request.merged_by.followers_url | string | optional | |
github.event.pull_request.merged_by.following_url | string | optional | |
github.event.pull_request.merged_by.gists_url | string | optional | |
github.event.pull_request.merged_by.gravatar_id | string | optional | |
github.event.pull_request.merged_by.html_url | string | optional | |
github.event.pull_request.merged_by.name | string | optional | |
github.event.pull_request.merged_by.node_id | string | optional | |
github.event.pull_request.merged_by.organizations_url | string | optional | |
github.event.pull_request.merged_by.received_events_url | string | optional | |
github.event.pull_request.merged_by.repos_url | string | optional | |
github.event.pull_request.merged_by.site_admin | boolean | optional | |
github.event.pull_request.merged_by.starred_url | string | optional | |
github.event.pull_request.merged_by.subscriptions_url | string | optional | |
github.event.pull_request.merged_by.type | Bot , User , Organization | optional | |
github.event.pull_request.merged_by.url | string | optional | |
github.event.pull_request.milestone | object or null | required | A collection of related issues and pull requests. |
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.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.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.type | Bot , User , Organization | optional | |
github.event.pull_request.milestone.creator.url | string | optional | |
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.members_url | string | optional | |
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_comments | integer | optional | |
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.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.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 | optional | |
github.event.pull_request.user.url | string | optional | |
github.event.sender | object | required | The GitHub user that triggered the event. This property is included in every webhook payload. |
Payload Example:
{ "token": "***", "job": "printJob", "ref": "refs/pull/1/merge", "sha": "21ca0d474ff8bb5aceebcef0cfb3dabc462c06f2", "repository": "ipdxco/ipdx-docs", "repository_owner": "ipdxco", "repository_owner_id": "147632863", "repositoryUrl": "git://github.com/ipdxco/ipdx-docs.git", "run_id": "8266643272", "run_number": "1", "retention_days": "90", "run_attempt": "1", "artifact_cache_size_limit": "10", "repository_visibility": "internal", "repo-self-hosted-runners-disabled": false, "enterprise-managed-business-id": "", "repository_id": "768168564", "actor_id": "1136669", "actor": "laurentsenta", "triggering_actor": "laurentsenta", "workflow": ".github/workflows/on_pull_request.yaml", "head_ref": "fix-payloads", "base_ref": "main", "event_name": "pull_request", "event": { "action": "opened", "enterprise": { "avatar_url": "https://avatars.githubusercontent.com/b/103221?v=4", "created_at": "2023-12-10T20:09:15Z", "description": null, "html_url": "https://github.com/enterprises/ipdx", "id": 103221, "name": "IPDX", "node_id": "E_kgDOAAGTNQ", "slug": "ipdx", "updated_at": "2024-02-20T11:52:59Z", "website_url": null }, "number": 1, "organization": { "avatar_url": "https://avatars.githubusercontent.com/u/147632863?v=4", "description": "Developer Experience Experts For Hire 🌟 ", "events_url": "https://api.github.com/orgs/ipdxco/events", "hooks_url": "https://api.github.com/orgs/ipdxco/hooks", "id": 147632863, "issues_url": "https://api.github.com/orgs/ipdxco/issues", "login": "ipdxco", "members_url": "https://api.github.com/orgs/ipdxco/members{/member}", "node_id": "O_kgDOCMyy3w", "public_members_url": "https://api.github.com/orgs/ipdxco/public_members{/member}", "repos_url": "https://api.github.com/orgs/ipdxco/repos", "url": "https://api.github.com/orgs/ipdxco" }, "pull_request": { "_links": { "comments": { "href": "https://api.github.com/repos/ipdxco/ipdx-docs/issues/1/comments" }, "commits": { "href": "https://api.github.com/repos/ipdxco/ipdx-docs/pulls/1/commits" }, "html": { "href": "https://github.com/ipdxco/ipdx-docs/pull/1" }, "issue": { "href": "https://api.github.com/repos/ipdxco/ipdx-docs/issues/1" }, "review_comment": { "href": "https://api.github.com/repos/ipdxco/ipdx-docs/pulls/comments{/number}" }, "review_comments": { "href": "https://api.github.com/repos/ipdxco/ipdx-docs/pulls/1/comments" }, "self": { "href": "https://api.github.com/repos/ipdxco/ipdx-docs/pulls/1" }, "statuses": { "href": "https://api.github.com/repos/ipdxco/ipdx-docs/statuses/637a4ad5d1c7fc97b3fff4e1d7c087409f452796" } }, "active_lock_reason": null, "additions": 29342, "assignee": null, "assignees": [], "author_association": "CONTRIBUTOR", "auto_merge": null, "base": { "label": "ipdxco:main", "ref": "main", "repo": { "allow_auto_merge": false, "allow_forking": false, "allow_merge_commit": true, "allow_rebase_merge": true, "allow_squash_merge": true, "allow_update_branch": false, "archive_url": "https://api.github.com/repos/ipdxco/ipdx-docs/{archive_format}{/ref}", "archived": false, "assignees_url": "https://api.github.com/repos/ipdxco/ipdx-docs/assignees{/user}", "blobs_url": "https://api.github.com/repos/ipdxco/ipdx-docs/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/ipdxco/ipdx-docs/branches{/branch}", "clone_url": "https://github.com/ipdxco/ipdx-docs.git", "collaborators_url": "https://api.github.com/repos/ipdxco/ipdx-docs/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/ipdxco/ipdx-docs/comments{/number}", "commits_url": "https://api.github.com/repos/ipdxco/ipdx-docs/commits{/sha}", "compare_url": "https://api.github.com/repos/ipdxco/ipdx-docs/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/ipdxco/ipdx-docs/contents/{+path}", "contributors_url": "https://api.github.com/repos/ipdxco/ipdx-docs/contributors", "created_at": "2024-03-06T15:40:55Z", "default_branch": "main", "delete_branch_on_merge": false, "deployments_url": "https://api.github.com/repos/ipdxco/ipdx-docs/deployments", "description": null, "disabled": false, "downloads_url": "https://api.github.com/repos/ipdxco/ipdx-docs/downloads", "events_url": "https://api.github.com/repos/ipdxco/ipdx-docs/events", "fork": false, "forks": 0, "forks_count": 0, "forks_url": "https://api.github.com/repos/ipdxco/ipdx-docs/forks", "full_name": "ipdxco/ipdx-docs", "git_commits_url": "https://api.github.com/repos/ipdxco/ipdx-docs/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/ipdxco/ipdx-docs/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/ipdxco/ipdx-docs/git/tags{/sha}", "git_url": "git://github.com/ipdxco/ipdx-docs.git", "has_discussions": false, "has_downloads": true, "has_issues": true, "has_pages": true, "has_projects": true, "has_wiki": true, "homepage": null, "hooks_url": "https://api.github.com/repos/ipdxco/ipdx-docs/hooks", "html_url": "https://github.com/ipdxco/ipdx-docs", "id": 768168564, "is_template": false, "issue_comment_url": "https://api.github.com/repos/ipdxco/ipdx-docs/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/ipdxco/ipdx-docs/issues/events{/number}", "issues_url": "https://api.github.com/repos/ipdxco/ipdx-docs/issues{/number}", "keys_url": "https://api.github.com/repos/ipdxco/ipdx-docs/keys{/key_id}", "labels_url": "https://api.github.com/repos/ipdxco/ipdx-docs/labels{/name}", "language": "Jupyter Notebook", "languages_url": "https://api.github.com/repos/ipdxco/ipdx-docs/languages", "license": null, "merge_commit_message": "PR_TITLE", "merge_commit_title": "MERGE_MESSAGE", "merges_url": "https://api.github.com/repos/ipdxco/ipdx-docs/merges", "milestones_url": "https://api.github.com/repos/ipdxco/ipdx-docs/milestones{/number}", "mirror_url": null, "name": "ipdx-docs", "node_id": "R_kgDOLclSdA", "notifications_url": "https://api.github.com/repos/ipdxco/ipdx-docs/notifications{?since,all,participating}", "open_issues": 1, "open_issues_count": 1, "owner": { "avatar_url": "https://avatars.githubusercontent.com/u/147632863?v=4", "events_url": "https://api.github.com/users/ipdxco/events{/privacy}", "followers_url": "https://api.github.com/users/ipdxco/followers", "following_url": "https://api.github.com/users/ipdxco/following{/other_user}", "gists_url": "https://api.github.com/users/ipdxco/gists{/gist_id}", "gravatar_id": "", "html_url": "https://github.com/ipdxco", "id": 147632863, "login": "ipdxco", "node_id": "O_kgDOCMyy3w", "organizations_url": "https://api.github.com/users/ipdxco/orgs", "received_events_url": "https://api.github.com/users/ipdxco/received_events", "repos_url": "https://api.github.com/users/ipdxco/repos", "site_admin": false, "starred_url": "https://api.github.com/users/ipdxco/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/ipdxco/subscriptions", "type": "Organization", "url": "https://api.github.com/users/ipdxco" }, "private": true, "pulls_url": "https://api.github.com/repos/ipdxco/ipdx-docs/pulls{/number}", "pushed_at": "2024-03-13T14:45:59Z", "releases_url": "https://api.github.com/repos/ipdxco/ipdx-docs/releases{/id}", "size": 2832, "squash_merge_commit_message": "COMMIT_MESSAGES", "squash_merge_commit_title": "COMMIT_OR_PR_TITLE", "ssh_url": "git@github.com:ipdxco/ipdx-docs.git", "stargazers_count": 0, "stargazers_url": "https://api.github.com/repos/ipdxco/ipdx-docs/stargazers", "statuses_url": "https://api.github.com/repos/ipdxco/ipdx-docs/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/ipdxco/ipdx-docs/subscribers", "subscription_url": "https://api.github.com/repos/ipdxco/ipdx-docs/subscription", "svn_url": "https://github.com/ipdxco/ipdx-docs", "tags_url": "https://api.github.com/repos/ipdxco/ipdx-docs/tags", "teams_url": "https://api.github.com/repos/ipdxco/ipdx-docs/teams", "topics": [], "trees_url": "https://api.github.com/repos/ipdxco/ipdx-docs/git/trees{/sha}", "updated_at": "2024-03-06T16:02:25Z", "url": "https://api.github.com/repos/ipdxco/ipdx-docs", "use_squash_pr_title_as_default": false, "visibility": "internal", "watchers": 0, "watchers_count": 0, "web_commit_signoff_required": false }, "sha": "2ea5d7d543ebd63872e78c5b8e35c37b9bc915b8", "user": { "avatar_url": "https://avatars.githubusercontent.com/u/147632863?v=4", "events_url": "https://api.github.com/users/ipdxco/events{/privacy}", "followers_url": "https://api.github.com/users/ipdxco/followers", "following_url": "https://api.github.com/users/ipdxco/following{/other_user}", "gists_url": "https://api.github.com/users/ipdxco/gists{/gist_id}", "gravatar_id": "", "html_url": "https://github.com/ipdxco", "id": 147632863, "login": "ipdxco", "node_id": "O_kgDOCMyy3w", "organizations_url": "https://api.github.com/users/ipdxco/orgs", "received_events_url": "https://api.github.com/users/ipdxco/received_events", "repos_url": "https://api.github.com/users/ipdxco/repos", "site_admin": false, "starred_url": "https://api.github.com/users/ipdxco/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/ipdxco/subscriptions", "type": "Organization", "url": "https://api.github.com/users/ipdxco" } }, "body": null, "changed_files": 38, "closed_at": null, "comments": 0, "comments_url": "https://api.github.com/repos/ipdxco/ipdx-docs/issues/1/comments", "commits": 1, "commits_url": "https://api.github.com/repos/ipdxco/ipdx-docs/pulls/1/commits", "created_at": "2024-03-13T14:45:59Z", "deletions": 30213, "diff_url": "https://github.com/ipdxco/ipdx-docs/pull/1.diff", "draft": false, "head": { "label": "ipdxco:fix-payloads", "ref": "fix-payloads", "repo": { "allow_auto_merge": false, "allow_forking": false, "allow_merge_commit": true, "allow_rebase_merge": true, "allow_squash_merge": true, "allow_update_branch": false, "archive_url": "https://api.github.com/repos/ipdxco/ipdx-docs/{archive_format}{/ref}", "archived": false, "assignees_url": "https://api.github.com/repos/ipdxco/ipdx-docs/assignees{/user}", "blobs_url": "https://api.github.com/repos/ipdxco/ipdx-docs/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/ipdxco/ipdx-docs/branches{/branch}", "clone_url": "https://github.com/ipdxco/ipdx-docs.git", "collaborators_url": "https://api.github.com/repos/ipdxco/ipdx-docs/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/ipdxco/ipdx-docs/comments{/number}", "commits_url": "https://api.github.com/repos/ipdxco/ipdx-docs/commits{/sha}", "compare_url": "https://api.github.com/repos/ipdxco/ipdx-docs/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/ipdxco/ipdx-docs/contents/{+path}", "contributors_url": "https://api.github.com/repos/ipdxco/ipdx-docs/contributors", "created_at": "2024-03-06T15:40:55Z", "default_branch": "main", "delete_branch_on_merge": false, "deployments_url": "https://api.github.com/repos/ipdxco/ipdx-docs/deployments", "description": null, "disabled": false, "downloads_url": "https://api.github.com/repos/ipdxco/ipdx-docs/downloads", "events_url": "https://api.github.com/repos/ipdxco/ipdx-docs/events", "fork": false, "forks": 0, "forks_count": 0, "forks_url": "https://api.github.com/repos/ipdxco/ipdx-docs/forks", "full_name": "ipdxco/ipdx-docs", "git_commits_url": "https://api.github.com/repos/ipdxco/ipdx-docs/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/ipdxco/ipdx-docs/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/ipdxco/ipdx-docs/git/tags{/sha}", "git_url": "git://github.com/ipdxco/ipdx-docs.git", "has_discussions": false, "has_downloads": true, "has_issues": true, "has_pages": true, "has_projects": true, "has_wiki": true, "homepage": null, "hooks_url": "https://api.github.com/repos/ipdxco/ipdx-docs/hooks", "html_url": "https://github.com/ipdxco/ipdx-docs", "id": 768168564, "is_template": false, "issue_comment_url": "https://api.github.com/repos/ipdxco/ipdx-docs/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/ipdxco/ipdx-docs/issues/events{/number}", "issues_url": "https://api.github.com/repos/ipdxco/ipdx-docs/issues{/number}", "keys_url": "https://api.github.com/repos/ipdxco/ipdx-docs/keys{/key_id}", "labels_url": "https://api.github.com/repos/ipdxco/ipdx-docs/labels{/name}", "language": "Jupyter Notebook", "languages_url": "https://api.github.com/repos/ipdxco/ipdx-docs/languages", "license": null, "merge_commit_message": "PR_TITLE", "merge_commit_title": "MERGE_MESSAGE", "merges_url": "https://api.github.com/repos/ipdxco/ipdx-docs/merges", "milestones_url": "https://api.github.com/repos/ipdxco/ipdx-docs/milestones{/number}", "mirror_url": null, "name": "ipdx-docs", "node_id": "R_kgDOLclSdA", "notifications_url": "https://api.github.com/repos/ipdxco/ipdx-docs/notifications{?since,all,participating}", "open_issues": 1, "open_issues_count": 1, "owner": { "avatar_url": "https://avatars.githubusercontent.com/u/147632863?v=4", "events_url": "https://api.github.com/users/ipdxco/events{/privacy}", "followers_url": "https://api.github.com/users/ipdxco/followers", "following_url": "https://api.github.com/users/ipdxco/following{/other_user}", "gists_url": "https://api.github.com/users/ipdxco/gists{/gist_id}", "gravatar_id": "", "html_url": "https://github.com/ipdxco", "id": 147632863, "login": "ipdxco", "node_id": "O_kgDOCMyy3w", "organizations_url": "https://api.github.com/users/ipdxco/orgs", "received_events_url": "https://api.github.com/users/ipdxco/received_events", "repos_url": "https://api.github.com/users/ipdxco/repos", "site_admin": false, "starred_url": "https://api.github.com/users/ipdxco/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/ipdxco/subscriptions", "type": "Organization", "url": "https://api.github.com/users/ipdxco" }, "private": true, "pulls_url": "https://api.github.com/repos/ipdxco/ipdx-docs/pulls{/number}", "pushed_at": "2024-03-13T14:45:59Z", "releases_url": "https://api.github.com/repos/ipdxco/ipdx-docs/releases{/id}", "size": 2832, "squash_merge_commit_message": "COMMIT_MESSAGES", "squash_merge_commit_title": "COMMIT_OR_PR_TITLE", "ssh_url": "git@github.com:ipdxco/ipdx-docs.git", "stargazers_count": 0, "stargazers_url": "https://api.github.com/repos/ipdxco/ipdx-docs/stargazers", "statuses_url": "https://api.github.com/repos/ipdxco/ipdx-docs/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/ipdxco/ipdx-docs/subscribers", "subscription_url": "https://api.github.com/repos/ipdxco/ipdx-docs/subscription", "svn_url": "https://github.com/ipdxco/ipdx-docs", "tags_url": "https://api.github.com/repos/ipdxco/ipdx-docs/tags", "teams_url": "https://api.github.com/repos/ipdxco/ipdx-docs/teams", "topics": [], "trees_url": "https://api.github.com/repos/ipdxco/ipdx-docs/git/trees{/sha}", "updated_at": "2024-03-06T16:02:25Z", "url": "https://api.github.com/repos/ipdxco/ipdx-docs", "use_squash_pr_title_as_default": false, "visibility": "internal", "watchers": 0, "watchers_count": 0, "web_commit_signoff_required": false }, "sha": "637a4ad5d1c7fc97b3fff4e1d7c087409f452796", "user": { "avatar_url": "https://avatars.githubusercontent.com/u/147632863?v=4", "events_url": "https://api.github.com/users/ipdxco/events{/privacy}", "followers_url": "https://api.github.com/users/ipdxco/followers", "following_url": "https://api.github.com/users/ipdxco/following{/other_user}", "gists_url": "https://api.github.com/users/ipdxco/gists{/gist_id}", "gravatar_id": "", "html_url": "https://github.com/ipdxco", "id": 147632863, "login": "ipdxco", "node_id": "O_kgDOCMyy3w", "organizations_url": "https://api.github.com/users/ipdxco/orgs", "received_events_url": "https://api.github.com/users/ipdxco/received_events", "repos_url": "https://api.github.com/users/ipdxco/repos", "site_admin": false, "starred_url": "https://api.github.com/users/ipdxco/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/ipdxco/subscriptions", "type": "Organization", "url": "https://api.github.com/users/ipdxco" } }, "html_url": "https://github.com/ipdxco/ipdx-docs/pull/1", "id": 1770269438, "issue_url": "https://api.github.com/repos/ipdxco/ipdx-docs/issues/1", "labels": [], "locked": false, "maintainer_can_modify": false, "merge_commit_sha": null, "mergeable": null, "mergeable_state": "unknown", "merged": false, "merged_at": null, "merged_by": null, "milestone": null, "node_id": "PR_kwDOLclSdM5phCr-", "number": 1, "patch_url": "https://github.com/ipdxco/ipdx-docs/pull/1.patch", "rebaseable": null, "requested_reviewers": [], "requested_teams": [], "review_comment_url": "https://api.github.com/repos/ipdxco/ipdx-docs/pulls/comments{/number}", "review_comments": 0, "review_comments_url": "https://api.github.com/repos/ipdxco/ipdx-docs/pulls/1/comments", "state": "open", "statuses_url": "https://api.github.com/repos/ipdxco/ipdx-docs/statuses/637a4ad5d1c7fc97b3fff4e1d7c087409f452796", "title": "Fix: payload names", "updated_at": "2024-03-13T14:45:59Z", "url": "https://api.github.com/repos/ipdxco/ipdx-docs/pulls/1", "user": { "avatar_url": "https://avatars.githubusercontent.com/u/1136669?v=4", "events_url": "https://api.github.com/users/laurentsenta/events{/privacy}", "followers_url": "https://api.github.com/users/laurentsenta/followers", "following_url": "https://api.github.com/users/laurentsenta/following{/other_user}", "gists_url": "https://api.github.com/users/laurentsenta/gists{/gist_id}", "gravatar_id": "", "html_url": "https://github.com/laurentsenta", "id": 1136669, "login": "laurentsenta", "node_id": "MDQ6VXNlcjExMzY2Njk=", "organizations_url": "https://api.github.com/users/laurentsenta/orgs", "received_events_url": "https://api.github.com/users/laurentsenta/received_events", "repos_url": "https://api.github.com/users/laurentsenta/repos", "site_admin": false, "starred_url": "https://api.github.com/users/laurentsenta/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/laurentsenta/subscriptions", "type": "User", "url": "https://api.github.com/users/laurentsenta" } }, "repository": { "allow_forking": false, "archive_url": "https://api.github.com/repos/ipdxco/ipdx-docs/{archive_format}{/ref}", "archived": false, "assignees_url": "https://api.github.com/repos/ipdxco/ipdx-docs/assignees{/user}", "blobs_url": "https://api.github.com/repos/ipdxco/ipdx-docs/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/ipdxco/ipdx-docs/branches{/branch}", "clone_url": "https://github.com/ipdxco/ipdx-docs.git", "collaborators_url": "https://api.github.com/repos/ipdxco/ipdx-docs/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/ipdxco/ipdx-docs/comments{/number}", "commits_url": "https://api.github.com/repos/ipdxco/ipdx-docs/commits{/sha}", "compare_url": "https://api.github.com/repos/ipdxco/ipdx-docs/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/ipdxco/ipdx-docs/contents/{+path}", "contributors_url": "https://api.github.com/repos/ipdxco/ipdx-docs/contributors", "created_at": "2024-03-06T15:40:55Z", "custom_properties": {}, "default_branch": "main", "deployments_url": "https://api.github.com/repos/ipdxco/ipdx-docs/deployments", "description": null, "disabled": false, "downloads_url": "https://api.github.com/repos/ipdxco/ipdx-docs/downloads", "events_url": "https://api.github.com/repos/ipdxco/ipdx-docs/events", "fork": false, "forks": 0, "forks_count": 0, "forks_url": "https://api.github.com/repos/ipdxco/ipdx-docs/forks", "full_name": "ipdxco/ipdx-docs", "git_commits_url": "https://api.github.com/repos/ipdxco/ipdx-docs/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/ipdxco/ipdx-docs/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/ipdxco/ipdx-docs/git/tags{/sha}", "git_url": "git://github.com/ipdxco/ipdx-docs.git", "has_discussions": false, "has_downloads": true, "has_issues": true, "has_pages": true, "has_projects": true, "has_wiki": true, "homepage": null, "hooks_url": "https://api.github.com/repos/ipdxco/ipdx-docs/hooks", "html_url": "https://github.com/ipdxco/ipdx-docs", "id": 768168564, "is_template": false, "issue_comment_url": "https://api.github.com/repos/ipdxco/ipdx-docs/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/ipdxco/ipdx-docs/issues/events{/number}", "issues_url": "https://api.github.com/repos/ipdxco/ipdx-docs/issues{/number}", "keys_url": "https://api.github.com/repos/ipdxco/ipdx-docs/keys{/key_id}", "labels_url": "https://api.github.com/repos/ipdxco/ipdx-docs/labels{/name}", "language": "Jupyter Notebook", "languages_url": "https://api.github.com/repos/ipdxco/ipdx-docs/languages", "license": null, "merges_url": "https://api.github.com/repos/ipdxco/ipdx-docs/merges", "milestones_url": "https://api.github.com/repos/ipdxco/ipdx-docs/milestones{/number}", "mirror_url": null, "name": "ipdx-docs", "node_id": "R_kgDOLclSdA", "notifications_url": "https://api.github.com/repos/ipdxco/ipdx-docs/notifications{?since,all,participating}", "open_issues": 1, "open_issues_count": 1, "owner": { "avatar_url": "https://avatars.githubusercontent.com/u/147632863?v=4", "events_url": "https://api.github.com/users/ipdxco/events{/privacy}", "followers_url": "https://api.github.com/users/ipdxco/followers", "following_url": "https://api.github.com/users/ipdxco/following{/other_user}", "gists_url": "https://api.github.com/users/ipdxco/gists{/gist_id}", "gravatar_id": "", "html_url": "https://github.com/ipdxco", "id": 147632863, "login": "ipdxco", "node_id": "O_kgDOCMyy3w", "organizations_url": "https://api.github.com/users/ipdxco/orgs", "received_events_url": "https://api.github.com/users/ipdxco/received_events", "repos_url": "https://api.github.com/users/ipdxco/repos", "site_admin": false, "starred_url": "https://api.github.com/users/ipdxco/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/ipdxco/subscriptions", "type": "Organization", "url": "https://api.github.com/users/ipdxco" }, "private": true, "pulls_url": "https://api.github.com/repos/ipdxco/ipdx-docs/pulls{/number}", "pushed_at": "2024-03-13T14:45:59Z", "releases_url": "https://api.github.com/repos/ipdxco/ipdx-docs/releases{/id}", "size": 2832, "ssh_url": "git@github.com:ipdxco/ipdx-docs.git", "stargazers_count": 0, "stargazers_url": "https://api.github.com/repos/ipdxco/ipdx-docs/stargazers", "statuses_url": "https://api.github.com/repos/ipdxco/ipdx-docs/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/ipdxco/ipdx-docs/subscribers", "subscription_url": "https://api.github.com/repos/ipdxco/ipdx-docs/subscription", "svn_url": "https://github.com/ipdxco/ipdx-docs", "tags_url": "https://api.github.com/repos/ipdxco/ipdx-docs/tags", "teams_url": "https://api.github.com/repos/ipdxco/ipdx-docs/teams", "topics": [], "trees_url": "https://api.github.com/repos/ipdxco/ipdx-docs/git/trees{/sha}", "updated_at": "2024-03-06T16:02:25Z", "url": "https://api.github.com/repos/ipdxco/ipdx-docs", "visibility": "internal", "watchers": 0, "watchers_count": 0, "web_commit_signoff_required": false }, "sender": { "avatar_url": "https://avatars.githubusercontent.com/u/1136669?v=4", "events_url": "https://api.github.com/users/laurentsenta/events{/privacy}", "followers_url": "https://api.github.com/users/laurentsenta/followers", "following_url": "https://api.github.com/users/laurentsenta/following{/other_user}", "gists_url": "https://api.github.com/users/laurentsenta/gists{/gist_id}", "gravatar_id": "", "html_url": "https://github.com/laurentsenta", "id": 1136669, "login": "laurentsenta", "node_id": "MDQ6VXNlcjExMzY2Njk=", "organizations_url": "https://api.github.com/users/laurentsenta/orgs", "received_events_url": "https://api.github.com/users/laurentsenta/received_events", "repos_url": "https://api.github.com/users/laurentsenta/repos", "site_admin": false, "starred_url": "https://api.github.com/users/laurentsenta/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/laurentsenta/subscriptions", "type": "User", "url": "https://api.github.com/users/laurentsenta" } }, "server_url": "https://github.com", "api_url": "https://api.github.com", "graphql_url": "https://api.github.com/graphql", "ref_name": "1/merge", "ref_protected": false, "ref_type": "branch", "secret_source": "Actions", "workflow_ref": "ipdxco/ipdx-docs/.github/workflows/on_pull_request.yaml@refs/pull/1/merge", "workflow_sha": "21ca0d474ff8bb5aceebcef0cfb3dabc462c06f2", "workspace": "/home/runner/work/ipdx-docs/ipdx-docs", "action": "__run" }