pull_request

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

Github Event pull_request #

Github Action Trigger #

source

Webhook event payloadActivity typesGITHUB_SHAGITHUB_REF
pull_requestassigned
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 branchPR 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 is openedsynchronize, or reopened. To trigger workflows by different activity types, use the types 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 the pull_request_target trigger, you should be aware of the security risks. For more information, see pull_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 be refs/pull/PULL_REQUEST_NUMBER/merge. If a pull request was closed as a result of being merged, it will be the fully qualified ref 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_reviewpull_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_requestissue_commentpull_request_review_commentpull_request_review, and pull_request_target events to the base repository. No pull request events occur on the forked repository.

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

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

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

Event Payload #

source

Activities: 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.
fieldtyperequireddescription
github.event.enterpriseobjectoptional

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured on an enterprise account or an organization that’s part of an enterprise account. For more information, see “About enterprise accounts."

github.event.numberintegerrequired

The pull request number.

github.event.organizationobjectoptional

A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.

github.event.pull_requestobjectrequired
github.event.pull_request._linksobjectrequired
github.event.pull_request._links.commentsobjectrequired
github.event.pull_request._links.comments.hrefstringrequired
github.event.pull_request._links.commitsobjectrequired
github.event.pull_request._links.commits.hrefstringrequired
github.event.pull_request._links.htmlobjectrequired
github.event.pull_request._links.html.hrefstringrequired
github.event.pull_request._links.issueobjectrequired
github.event.pull_request._links.issue.hrefstringrequired
github.event.pull_request._links.review_commentobjectrequired
github.event.pull_request._links.review_comment.hrefstringrequired
github.event.pull_request._links.review_commentsobjectrequired
github.event.pull_request._links.review_comments.hrefstringrequired
github.event.pull_request._links.selfobjectrequired
github.event.pull_request._links.self.hrefstringrequired
github.event.pull_request._links.statusesobjectrequired
github.event.pull_request._links.statuses.hrefstringrequired
github.event.pull_request.assignee.emailstring or nulloptional
github.event.pull_request.assignee.idintegerrequired
github.event.pull_request.assignee.loginstringrequired
github.event.pull_request.author_associationCOLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNERrequired

How the author is associated with the repository.

github.event.pull_request.auto_mergeobject or nullrequired

The status of auto merging a pull request.

github.event.pull_request.auto_merge.enabled_by.emailstring or nulloptional
github.event.pull_request.auto_merge.enabled_by.idintegerrequired
github.event.pull_request.auto_merge.enabled_by.loginstringrequired
github.event.pull_request.auto_merge.merge_methodmerge, squash, rebaserequired

The merge method to use.

github.event.pull_request.baseobjectrequired
github.event.pull_request.base.refstringrequired
github.event.pull_request.base.repoobjectrequired

A git repository

github.event.pull_request.base.repo.allow_forkingbooleanoptional

Whether to allow private forks

github.event.pull_request.base.repo.allow_merge_commitbooleanoptional

Whether to allow merge commits for pull requests.

github.event.pull_request.base.repo.allow_rebase_mergebooleanoptional

Whether to allow rebase merges for pull requests.

github.event.pull_request.base.repo.allow_squash_mergebooleanoptional

Whether to allow squash merges for pull requests.

github.event.pull_request.base.repo.archive_urlstringrequired
github.event.pull_request.base.repo.archivedbooleanrequired

Whether the repository is archived.

github.event.pull_request.base.repo.assignees_urlstringrequired
github.event.pull_request.base.repo.blobs_urlstringrequired
github.event.pull_request.base.repo.branches_urlstringrequired
github.event.pull_request.base.repo.clone_urlstringrequired
github.event.pull_request.base.repo.collaborators_urlstringrequired
github.event.pull_request.base.repo.comments_urlstringrequired
github.event.pull_request.base.repo.commits_urlstringrequired
github.event.pull_request.base.repo.compare_urlstringrequired
github.event.pull_request.base.repo.contents_urlstringrequired
github.event.pull_request.base.repo.contributors_urlstringrequired
github.event.pull_request.base.repo.default_branchstringrequired

The default branch of the repository.

github.event.pull_request.base.repo.deployments_urlstringrequired
github.event.pull_request.base.repo.descriptionstring or nullrequired
github.event.pull_request.base.repo.downloads_urlstringrequired
github.event.pull_request.base.repo.events_urlstringrequired
github.event.pull_request.base.repo.forkbooleanrequired
github.event.pull_request.base.repo.forksintegerrequired
github.event.pull_request.base.repo.forks_countintegerrequired
github.event.pull_request.base.repo.forks_urlstringrequired
github.event.pull_request.base.repo.full_namestringrequired
github.event.pull_request.base.repo.git_commits_urlstringrequired
github.event.pull_request.base.repo.git_refs_urlstringrequired
github.event.pull_request.base.repo.git_tags_urlstringrequired
github.event.pull_request.base.repo.git_urlstringrequired
github.event.pull_request.base.repo.has_downloadsbooleanrequired

Whether downloads are enabled.

github.event.pull_request.base.repo.has_issuesbooleanrequired

Whether issues are enabled.

github.event.pull_request.base.repo.has_pagesbooleanrequired
github.event.pull_request.base.repo.has_projectsbooleanrequired

Whether projects are enabled.

github.event.pull_request.base.repo.has_wikibooleanrequired

Whether the wiki is enabled.

github.event.pull_request.base.repo.has_discussionsbooleanrequired

Whether discussions are enabled.

github.event.pull_request.base.repo.homepagestring or nullrequired
github.event.pull_request.base.repo.hooks_urlstringrequired
github.event.pull_request.base.repo.html_urlstringrequired
github.event.pull_request.base.repo.idintegerrequired

Unique identifier of the repository

github.event.pull_request.base.repo.is_templatebooleanoptional
github.event.pull_request.base.repo.issue_comment_urlstringrequired
github.event.pull_request.base.repo.issue_events_urlstringrequired
github.event.pull_request.base.repo.issues_urlstringrequired
github.event.pull_request.base.repo.keys_urlstringrequired
github.event.pull_request.base.repo.labels_urlstringrequired
github.event.pull_request.base.repo.languagestring or nullrequired
github.event.pull_request.base.repo.languages_urlstringrequired
github.event.pull_request.base.repo.license.keystringrequired
github.event.pull_request.base.repo.license.namestringrequired
github.event.pull_request.base.repo.license.node_idstringrequired
github.event.pull_request.base.repo.license.urlstring or nullrequired
github.event.pull_request.base.repo.master_branchstringoptional
github.event.pull_request.base.repo.merges_urlstringrequired
github.event.pull_request.base.repo.milestones_urlstringrequired
github.event.pull_request.base.repo.mirror_urlstring or nullrequired
github.event.pull_request.base.repo.namestringrequired

The name of the repository.

github.event.pull_request.base.repo.node_idstringrequired
github.event.pull_request.base.repo.notifications_urlstringrequired
github.event.pull_request.base.repo.open_issuesintegerrequired
github.event.pull_request.base.repo.open_issues_countintegerrequired
github.event.pull_request.base.repo.owner.idintegerrequired
github.event.pull_request.base.repo.owner.loginstringrequired
github.event.pull_request.base.repo.permissionsobjectoptional
github.event.pull_request.base.repo.permissions.adminbooleanrequired
github.event.pull_request.base.repo.permissions.maintainbooleanoptional
github.event.pull_request.base.repo.permissions.pullbooleanrequired
github.event.pull_request.base.repo.permissions.pushbooleanrequired
github.event.pull_request.base.repo.permissions.triagebooleanoptional
github.event.pull_request.base.repo.privatebooleanrequired

Whether the repository is private or public.

github.event.pull_request.base.repo.pulls_urlstringrequired
github.event.pull_request.base.repo.releases_urlstringrequired
github.event.pull_request.base.repo.sizeintegerrequired
github.event.pull_request.base.repo.ssh_urlstringrequired
github.event.pull_request.base.repo.stargazers_countintegerrequired
github.event.pull_request.base.repo.stargazers_urlstringrequired
github.event.pull_request.base.repo.statuses_urlstringrequired
github.event.pull_request.base.repo.subscribers_urlstringrequired
github.event.pull_request.base.repo.subscription_urlstringrequired
github.event.pull_request.base.repo.svn_urlstringrequired
github.event.pull_request.base.repo.tags_urlstringrequired
github.event.pull_request.base.repo.teams_urlstringrequired
github.event.pull_request.base.repo.trees_urlstringrequired
github.event.pull_request.base.repo.updated_atstringrequired
github.event.pull_request.base.repo.urlstringrequired
github.event.pull_request.base.repo.watchersintegerrequired
github.event.pull_request.base.repo.watchers_countintegerrequired
github.event.pull_request.base.repo.web_commit_signoff_requiredbooleanoptional

Whether to require contributors to sign off on web-based commits

github.event.pull_request.base.shastringrequired
github.event.pull_request.base.user.idintegerrequired
github.event.pull_request.base.user.loginstringrequired
github.event.pull_request.bodystring or nullrequired
github.event.pull_request.closed_atstring or nullrequired
github.event.pull_request.comments_urlstringrequired
github.event.pull_request.commits_urlstringrequired
github.event.pull_request.created_atstringrequired
github.event.pull_request.diff_urlstringrequired
github.event.pull_request.headobjectrequired
github.event.pull_request.head.refstringrequired
github.event.pull_request.head.repo.allow_forkingbooleanoptional

Whether to allow private forks

github.event.pull_request.head.repo.allow_merge_commitbooleanoptional

Whether to allow merge commits for pull requests.

github.event.pull_request.head.repo.allow_rebase_mergebooleanoptional

Whether to allow rebase merges for pull requests.

github.event.pull_request.head.repo.allow_squash_mergebooleanoptional

Whether to allow squash merges for pull requests.

github.event.pull_request.head.repo.archive_urlstringrequired
github.event.pull_request.head.repo.archivedbooleanrequired

Whether the repository is archived.

github.event.pull_request.head.repo.assignees_urlstringrequired
github.event.pull_request.head.repo.blobs_urlstringrequired
github.event.pull_request.head.repo.branches_urlstringrequired
github.event.pull_request.head.repo.clone_urlstringrequired
github.event.pull_request.head.repo.collaborators_urlstringrequired
github.event.pull_request.head.repo.comments_urlstringrequired
github.event.pull_request.head.repo.commits_urlstringrequired
github.event.pull_request.head.repo.compare_urlstringrequired
github.event.pull_request.head.repo.contents_urlstringrequired
github.event.pull_request.head.repo.contributors_urlstringrequired
github.event.pull_request.head.repo.default_branchstringrequired

The default branch of the repository.

github.event.pull_request.head.repo.deployments_urlstringrequired
github.event.pull_request.head.repo.descriptionstring or nullrequired
github.event.pull_request.head.repo.downloads_urlstringrequired
github.event.pull_request.head.repo.events_urlstringrequired
github.event.pull_request.head.repo.forkbooleanrequired
github.event.pull_request.head.repo.forksintegerrequired
github.event.pull_request.head.repo.forks_countintegerrequired
github.event.pull_request.head.repo.forks_urlstringrequired
github.event.pull_request.head.repo.full_namestringrequired
github.event.pull_request.head.repo.git_commits_urlstringrequired
github.event.pull_request.head.repo.git_refs_urlstringrequired
github.event.pull_request.head.repo.git_tags_urlstringrequired
github.event.pull_request.head.repo.git_urlstringrequired
github.event.pull_request.head.repo.has_downloadsbooleanrequired

Whether downloads are enabled.

github.event.pull_request.head.repo.has_issuesbooleanrequired

Whether issues are enabled.

github.event.pull_request.head.repo.has_pagesbooleanrequired
github.event.pull_request.head.repo.has_projectsbooleanrequired

Whether projects are enabled.

github.event.pull_request.head.repo.has_wikibooleanrequired

Whether the wiki is enabled.

github.event.pull_request.head.repo.has_discussionsbooleanrequired

Whether discussions are enabled.

github.event.pull_request.head.repo.homepagestring or nullrequired
github.event.pull_request.head.repo.hooks_urlstringrequired
github.event.pull_request.head.repo.html_urlstringrequired
github.event.pull_request.head.repo.idintegerrequired

Unique identifier of the repository

github.event.pull_request.head.repo.is_templatebooleanoptional
github.event.pull_request.head.repo.issue_comment_urlstringrequired
github.event.pull_request.head.repo.issue_events_urlstringrequired
github.event.pull_request.head.repo.issues_urlstringrequired
github.event.pull_request.head.repo.keys_urlstringrequired
github.event.pull_request.head.repo.labels_urlstringrequired
github.event.pull_request.head.repo.languagestring or nullrequired
github.event.pull_request.head.repo.languages_urlstringrequired
github.event.pull_request.head.repo.licenseobject or nullrequired
github.event.pull_request.head.repo.license.keystringrequired
github.event.pull_request.head.repo.license.namestringrequired
github.event.pull_request.head.repo.license.node_idstringrequired
github.event.pull_request.head.repo.license.urlstring or nullrequired
github.event.pull_request.head.repo.master_branchstringoptional
github.event.pull_request.head.repo.merges_urlstringrequired
github.event.pull_request.head.repo.milestones_urlstringrequired
github.event.pull_request.head.repo.mirror_urlstring or nullrequired
github.event.pull_request.head.repo.namestringrequired

The name of the repository.

github.event.pull_request.head.repo.node_idstringrequired
github.event.pull_request.head.repo.notifications_urlstringrequired
github.event.pull_request.head.repo.open_issuesintegerrequired
github.event.pull_request.head.repo.open_issues_countintegerrequired
github.event.pull_request.head.repo.owner.idintegerrequired
github.event.pull_request.head.repo.owner.loginstringrequired
github.event.pull_request.head.repo.permissionsobjectoptional
github.event.pull_request.head.repo.permissions.adminbooleanrequired
github.event.pull_request.head.repo.permissions.maintainbooleanoptional
github.event.pull_request.head.repo.permissions.pullbooleanrequired
github.event.pull_request.head.repo.permissions.pushbooleanrequired
github.event.pull_request.head.repo.permissions.triagebooleanoptional
github.event.pull_request.head.repo.privatebooleanrequired

Whether the repository is private or public.

github.event.pull_request.head.repo.pulls_urlstringrequired
github.event.pull_request.head.repo.releases_urlstringrequired
github.event.pull_request.head.repo.sizeintegerrequired
github.event.pull_request.head.repo.ssh_urlstringrequired
github.event.pull_request.head.repo.stargazers_countintegerrequired
github.event.pull_request.head.repo.stargazers_urlstringrequired
github.event.pull_request.head.repo.statuses_urlstringrequired
github.event.pull_request.head.repo.subscribers_urlstringrequired
github.event.pull_request.head.repo.subscription_urlstringrequired
github.event.pull_request.head.repo.svn_urlstringrequired
github.event.pull_request.head.repo.tags_urlstringrequired
github.event.pull_request.head.repo.teams_urlstringrequired
github.event.pull_request.head.repo.trees_urlstringrequired
github.event.pull_request.head.repo.updated_atstringrequired
github.event.pull_request.head.repo.urlstringrequired
github.event.pull_request.head.repo.watchersintegerrequired
github.event.pull_request.head.repo.watchers_countintegerrequired
github.event.pull_request.head.repo.web_commit_signoff_requiredbooleanoptional

Whether to require contributors to sign off on web-based commits

github.event.pull_request.head.shastringrequired
github.event.pull_request.head.user.idintegerrequired
github.event.pull_request.head.user.loginstringrequired
github.event.pull_request.html_urlstringrequired
github.event.pull_request.idintegerrequired
github.event.pull_request.issue_urlstringrequired
github.event.pull_request.labelsarray of objectsrequired
github.event.pull_request.labels.colorstringrequired

6-character hex code, without the leading #, identifying the color

github.event.pull_request.labels.defaultbooleanrequired
github.event.pull_request.labels.descriptionstring or nullrequired
github.event.pull_request.labels.idintegerrequired
github.event.pull_request.labels.namestringrequired

The name of the label.

github.event.pull_request.labels.node_idstringrequired
github.event.pull_request.labels.urlstringrequired

URL for the label

github.event.pull_request.lockedbooleanrequired
github.event.pull_request.merge_commit_shastring or nullrequired
github.event.pull_request.merged_atstring or nullrequired
github.event.pull_request.merged_by.emailstring or nulloptional
github.event.pull_request.merged_by.idintegerrequired
github.event.pull_request.merged_by.loginstringrequired
github.event.pull_request.milestone.closed_atstring or nullrequired
github.event.pull_request.milestone.closed_issuesintegerrequired
github.event.pull_request.milestone.created_atstringrequired
github.event.pull_request.milestone.creator.emailstring or nulloptional
github.event.pull_request.milestone.creator.idintegerrequired
github.event.pull_request.milestone.creator.loginstringrequired
github.event.pull_request.milestone.descriptionstring or nullrequired
github.event.pull_request.milestone.due_onstring or nullrequired
github.event.pull_request.milestone.html_urlstringrequired
github.event.pull_request.milestone.idintegerrequired
github.event.pull_request.milestone.labels_urlstringrequired
github.event.pull_request.milestone.node_idstringrequired
github.event.pull_request.milestone.numberintegerrequired

The number of the milestone.

github.event.pull_request.milestone.open_issuesintegerrequired
github.event.pull_request.milestone.stateopen, closedrequired

The state of the milestone.

github.event.pull_request.milestone.titlestringrequired

The title of the milestone.

github.event.pull_request.milestone.updated_atstringrequired
github.event.pull_request.milestone.urlstringrequired
github.event.pull_request.node_idstringrequired
github.event.pull_request.numberintegerrequired

Number uniquely identifying the pull request within its repository.

github.event.pull_request.patch_urlstringrequired
github.event.pull_request.rebaseableboolean or nulloptional
github.event.pull_request.requested_teams.idintegerrequired

Unique identifier of the team

github.event.pull_request.requested_teams.namestringrequired

Name of the team

github.event.pull_request.review_comment_urlstringrequired
github.event.pull_request.review_comments_urlstringrequired
github.event.pull_request.stateopen, closedrequired

State of this Pull Request. Either open or closed.

github.event.pull_request.statuses_urlstringrequired
github.event.pull_request.titlestringrequired

The title of the pull request.

github.event.pull_request.updated_atstringrequired
github.event.pull_request.urlstringrequired
github.event.pull_request.user.emailstring or nulloptional
github.event.pull_request.user.idintegerrequired
github.event.pull_request.user.loginstringrequired
github.event.repositoryobjectrequired

The repository on GitHub where the event occurred. Webhook payloads contain the repository property when the event occurs from activity in a repository.

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.

fieldtyperequireddescription
github.event.actionassignedrequired
github.event.assigneeobject or nullrequired
github.event.assignee.avatar_urlstringoptional
github.event.assignee.deletedbooleanoptional
github.event.assignee.emailstring or nulloptional
github.event.assignee.events_urlstringoptional
github.event.assignee.followers_urlstringoptional
github.event.assignee.following_urlstringoptional
github.event.assignee.gists_urlstringoptional
github.event.assignee.gravatar_idstringoptional
github.event.assignee.html_urlstringoptional
github.event.assignee.idintegerrequired
github.event.assignee.loginstringrequired
github.event.assignee.namestringoptional
github.event.assignee.node_idstringoptional
github.event.assignee.organizations_urlstringoptional
github.event.assignee.received_events_urlstringoptional
github.event.assignee.repos_urlstringoptional
github.event.assignee.site_adminbooleanoptional
github.event.assignee.starred_urlstringoptional
github.event.assignee.subscriptions_urlstringoptional
github.event.assignee.typeBot, User, Organizationoptional
github.event.assignee.urlstringoptional
github.event.installationobjectoptional

The GitHub App installation. Webhook payloads contain the installation property when the event is configured for and sent to a GitHub App. For more information, see “Using webhooks with GitHub Apps."

github.event.pull_request.active_lock_reasonresolved, off-topic, too heated, spam, Nonerequired
github.event.pull_request.additionsintegeroptional
github.event.pull_request.assigneeobject or nullrequired
github.event.pull_request.assignee.avatar_urlstringoptional
github.event.pull_request.assignee.deletedbooleanoptional
github.event.pull_request.assignee.events_urlstringoptional
github.event.pull_request.assignee.followers_urlstringoptional
github.event.pull_request.assignee.following_urlstringoptional
github.event.pull_request.assignee.gists_urlstringoptional
github.event.pull_request.assignee.gravatar_idstringoptional
github.event.pull_request.assignee.html_urlstringoptional
github.event.pull_request.assignee.namestringoptional
github.event.pull_request.assignee.node_idstringoptional
github.event.pull_request.assignee.organizations_urlstringoptional
github.event.pull_request.assignee.received_events_urlstringoptional
github.event.pull_request.assignee.repos_urlstringoptional
github.event.pull_request.assignee.site_adminbooleanoptional
github.event.pull_request.assignee.starred_urlstringoptional
github.event.pull_request.assignee.subscriptions_urlstringoptional
github.event.pull_request.assignee.typeBot, User, Organization, Mannequinoptional
github.event.pull_request.assignee.urlstringoptional
github.event.pull_request.assigneesarray of object,nullsrequired
github.event.pull_request.auto_merge.commit_messagestring or nullrequired

Commit message for the merge commit.

github.event.pull_request.auto_merge.commit_titlestring or nullrequired

Title for the merge commit message.

github.event.pull_request.auto_merge.enabled_byobject or nullrequired
github.event.pull_request.auto_merge.enabled_by.avatar_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.deletedbooleanoptional
github.event.pull_request.auto_merge.enabled_by.events_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.followers_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.following_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.gists_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.gravatar_idstringoptional
github.event.pull_request.auto_merge.enabled_by.html_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.namestringoptional
github.event.pull_request.auto_merge.enabled_by.node_idstringoptional
github.event.pull_request.auto_merge.enabled_by.organizations_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.received_events_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.repos_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.site_adminbooleanoptional
github.event.pull_request.auto_merge.enabled_by.starred_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.subscriptions_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.typeBot, User, Organizationoptional
github.event.pull_request.auto_merge.enabled_by.urlstringoptional
github.event.pull_request.base.labelstringrequired
github.event.pull_request.base.repo.allow_auto_mergebooleanoptional

Whether to allow auto-merge for pull requests.

github.event.pull_request.base.repo.allow_update_branchbooleanoptional
github.event.pull_request.base.repo.created_atinteger or stringrequired
github.event.pull_request.base.repo.delete_branch_on_mergebooleanoptional

Whether to delete head branches when pull requests are merged

github.event.pull_request.base.repo.disabledbooleanoptional

Returns whether or not this repository is disabled.

github.event.pull_request.base.repo.licenseobject or nullrequired
github.event.pull_request.base.repo.license.spdx_idstringrequired
github.event.pull_request.base.repo.merge_commit_messagePR_BODY, PR_TITLE, BLANKoptional

The default value for a merge commit message.

  • PR_TITLE - default to the pull request’s title.
  • PR_BODY - default to the pull request’s body.
  • BLANK - default to a blank commit message.
github.event.pull_request.base.repo.merge_commit_titlePR_TITLE, MERGE_MESSAGEoptional

The default value for a merge commit title.

  • PR_TITLE - default to the pull request’s title.
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
github.event.pull_request.base.repo.organizationstringoptional
github.event.pull_request.base.repo.ownerobject or nullrequired
github.event.pull_request.base.repo.owner.avatar_urlstringoptional
github.event.pull_request.base.repo.owner.deletedbooleanoptional
github.event.pull_request.base.repo.owner.emailstring or nulloptional
github.event.pull_request.base.repo.owner.events_urlstringoptional
github.event.pull_request.base.repo.owner.followers_urlstringoptional
github.event.pull_request.base.repo.owner.following_urlstringoptional
github.event.pull_request.base.repo.owner.gists_urlstringoptional
github.event.pull_request.base.repo.owner.gravatar_idstringoptional
github.event.pull_request.base.repo.owner.html_urlstringoptional
github.event.pull_request.base.repo.owner.namestringoptional
github.event.pull_request.base.repo.owner.node_idstringoptional
github.event.pull_request.base.repo.owner.organizations_urlstringoptional
github.event.pull_request.base.repo.owner.received_events_urlstringoptional
github.event.pull_request.base.repo.owner.repos_urlstringoptional
github.event.pull_request.base.repo.owner.site_adminbooleanoptional
github.event.pull_request.base.repo.owner.starred_urlstringoptional
github.event.pull_request.base.repo.owner.subscriptions_urlstringoptional
github.event.pull_request.base.repo.owner.typeBot, User, Organizationoptional
github.event.pull_request.base.repo.owner.urlstringoptional
github.event.pull_request.base.repo.publicbooleanoptional
github.event.pull_request.base.repo.pushed_atnull or integer or stringrequired
github.event.pull_request.base.repo.role_namestring or nulloptional
github.event.pull_request.base.repo.squash_merge_commit_messagePR_BODY, COMMIT_MESSAGES, BLANKoptional

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request’s body.
  • COMMIT_MESSAGES - default to the branch’s commit messages.
  • BLANK - default to a blank commit message.
github.event.pull_request.base.repo.squash_merge_commit_titlePR_TITLE, COMMIT_OR_PR_TITLEoptional

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request’s title.
  • COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
github.event.pull_request.base.repo.stargazersintegeroptional
github.event.pull_request.base.repo.topicsarray of stringsrequired
github.event.pull_request.base.repo.use_squash_pr_title_as_defaultbooleanoptional

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

github.event.pull_request.base.repo.visibilitypublic, private, internalrequired
github.event.pull_request.base.userobject or nullrequired
github.event.pull_request.base.user.avatar_urlstringoptional
github.event.pull_request.base.user.deletedbooleanoptional
github.event.pull_request.base.user.emailstring or nulloptional
github.event.pull_request.base.user.events_urlstringoptional
github.event.pull_request.base.user.followers_urlstringoptional
github.event.pull_request.base.user.following_urlstringoptional
github.event.pull_request.base.user.gists_urlstringoptional
github.event.pull_request.base.user.gravatar_idstringoptional
github.event.pull_request.base.user.html_urlstringoptional
github.event.pull_request.base.user.namestringoptional
github.event.pull_request.base.user.node_idstringoptional
github.event.pull_request.base.user.organizations_urlstringoptional
github.event.pull_request.base.user.received_events_urlstringoptional
github.event.pull_request.base.user.repos_urlstringoptional
github.event.pull_request.base.user.site_adminbooleanoptional
github.event.pull_request.base.user.starred_urlstringoptional
github.event.pull_request.base.user.subscriptions_urlstringoptional
github.event.pull_request.base.user.typeBot, User, Organizationoptional
github.event.pull_request.base.user.urlstringoptional
github.event.pull_request.changed_filesintegeroptional
github.event.pull_request.commentsintegeroptional
github.event.pull_request.commitsintegeroptional
github.event.pull_request.deletionsintegeroptional
github.event.pull_request.draftbooleanrequired

Indicates whether or not the pull request is a draft.

github.event.pull_request.head.labelstring or nullrequired
github.event.pull_request.head.repoobject or nullrequired

A git repository

github.event.pull_request.head.repo.allow_auto_mergebooleanoptional

Whether to allow auto-merge for pull requests.

github.event.pull_request.head.repo.allow_update_branchbooleanoptional
github.event.pull_request.head.repo.created_atinteger or stringrequired
github.event.pull_request.head.repo.delete_branch_on_mergebooleanoptional

Whether to delete head branches when pull requests are merged

github.event.pull_request.head.repo.disabledbooleanoptional

Returns whether or not this repository is disabled.

github.event.pull_request.head.repo.license.spdx_idstringrequired
github.event.pull_request.head.repo.merge_commit_messagePR_BODY, PR_TITLE, BLANKoptional

The default value for a merge commit message.

  • PR_TITLE - default to the pull request’s title.
  • PR_BODY - default to the pull request’s body.
  • BLANK - default to a blank commit message.
github.event.pull_request.head.repo.merge_commit_titlePR_TITLE, MERGE_MESSAGEoptional

The default value for a merge commit title.

  • PR_TITLE - default to the pull request’s title.
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
github.event.pull_request.head.repo.organizationstringoptional
github.event.pull_request.head.repo.ownerobject or nullrequired
github.event.pull_request.head.repo.owner.avatar_urlstringoptional
github.event.pull_request.head.repo.owner.deletedbooleanoptional
github.event.pull_request.head.repo.owner.emailstring or nulloptional
github.event.pull_request.head.repo.owner.events_urlstringoptional
github.event.pull_request.head.repo.owner.followers_urlstringoptional
github.event.pull_request.head.repo.owner.following_urlstringoptional
github.event.pull_request.head.repo.owner.gists_urlstringoptional
github.event.pull_request.head.repo.owner.gravatar_idstringoptional
github.event.pull_request.head.repo.owner.html_urlstringoptional
github.event.pull_request.head.repo.owner.namestringoptional
github.event.pull_request.head.repo.owner.node_idstringoptional
github.event.pull_request.head.repo.owner.organizations_urlstringoptional
github.event.pull_request.head.repo.owner.received_events_urlstringoptional
github.event.pull_request.head.repo.owner.repos_urlstringoptional
github.event.pull_request.head.repo.owner.site_adminbooleanoptional
github.event.pull_request.head.repo.owner.starred_urlstringoptional
github.event.pull_request.head.repo.owner.subscriptions_urlstringoptional
github.event.pull_request.head.repo.owner.typeBot, User, Organizationoptional
github.event.pull_request.head.repo.owner.urlstringoptional
github.event.pull_request.head.repo.publicbooleanoptional
github.event.pull_request.head.repo.pushed_atnull or integer or stringrequired
github.event.pull_request.head.repo.role_namestring or nulloptional
github.event.pull_request.head.repo.squash_merge_commit_messagePR_BODY, COMMIT_MESSAGES, BLANKoptional

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request’s body.
  • COMMIT_MESSAGES - default to the branch’s commit messages.
  • BLANK - default to a blank commit message.
github.event.pull_request.head.repo.squash_merge_commit_titlePR_TITLE, COMMIT_OR_PR_TITLEoptional

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request’s title.
  • COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
github.event.pull_request.head.repo.stargazersintegeroptional
github.event.pull_request.head.repo.topicsarray of stringsrequired
github.event.pull_request.head.repo.use_squash_pr_title_as_defaultbooleanoptional

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

github.event.pull_request.head.repo.visibilitypublic, private, internalrequired
github.event.pull_request.head.userobject or nullrequired
github.event.pull_request.head.user.avatar_urlstringoptional
github.event.pull_request.head.user.deletedbooleanoptional
github.event.pull_request.head.user.emailstring or nulloptional
github.event.pull_request.head.user.events_urlstringoptional
github.event.pull_request.head.user.followers_urlstringoptional
github.event.pull_request.head.user.following_urlstringoptional
github.event.pull_request.head.user.gists_urlstringoptional
github.event.pull_request.head.user.gravatar_idstringoptional
github.event.pull_request.head.user.html_urlstringoptional
github.event.pull_request.head.user.namestringoptional
github.event.pull_request.head.user.node_idstringoptional
github.event.pull_request.head.user.organizations_urlstringoptional
github.event.pull_request.head.user.received_events_urlstringoptional
github.event.pull_request.head.user.repos_urlstringoptional
github.event.pull_request.head.user.site_adminbooleanoptional
github.event.pull_request.head.user.starred_urlstringoptional
github.event.pull_request.head.user.subscriptions_urlstringoptional
github.event.pull_request.head.user.typeBot, User, Organizationoptional
github.event.pull_request.head.user.urlstringoptional
github.event.pull_request.maintainer_can_modifybooleanoptional

Indicates whether maintainers can modify the pull request.

github.event.pull_request.mergeableboolean or nulloptional
github.event.pull_request.mergeable_statestringoptional
github.event.pull_request.mergedboolean or nulloptional
github.event.pull_request.merged_byobject or nulloptional
github.event.pull_request.merged_by.avatar_urlstringoptional
github.event.pull_request.merged_by.deletedbooleanoptional
github.event.pull_request.merged_by.events_urlstringoptional
github.event.pull_request.merged_by.followers_urlstringoptional
github.event.pull_request.merged_by.following_urlstringoptional
github.event.pull_request.merged_by.gists_urlstringoptional
github.event.pull_request.merged_by.gravatar_idstringoptional
github.event.pull_request.merged_by.html_urlstringoptional
github.event.pull_request.merged_by.namestringoptional
github.event.pull_request.merged_by.node_idstringoptional
github.event.pull_request.merged_by.organizations_urlstringoptional
github.event.pull_request.merged_by.received_events_urlstringoptional
github.event.pull_request.merged_by.repos_urlstringoptional
github.event.pull_request.merged_by.site_adminbooleanoptional
github.event.pull_request.merged_by.starred_urlstringoptional
github.event.pull_request.merged_by.subscriptions_urlstringoptional
github.event.pull_request.merged_by.typeBot, User, Organizationoptional
github.event.pull_request.merged_by.urlstringoptional
github.event.pull_request.milestoneobject or nullrequired

A collection of related issues and pull requests.

github.event.pull_request.milestone.creatorobject or nullrequired
github.event.pull_request.milestone.creator.avatar_urlstringoptional
github.event.pull_request.milestone.creator.deletedbooleanoptional
github.event.pull_request.milestone.creator.events_urlstringoptional
github.event.pull_request.milestone.creator.followers_urlstringoptional
github.event.pull_request.milestone.creator.following_urlstringoptional
github.event.pull_request.milestone.creator.gists_urlstringoptional
github.event.pull_request.milestone.creator.gravatar_idstringoptional
github.event.pull_request.milestone.creator.html_urlstringoptional
github.event.pull_request.milestone.creator.namestringoptional
github.event.pull_request.milestone.creator.node_idstringoptional
github.event.pull_request.milestone.creator.organizations_urlstringoptional
github.event.pull_request.milestone.creator.received_events_urlstringoptional
github.event.pull_request.milestone.creator.repos_urlstringoptional
github.event.pull_request.milestone.creator.site_adminbooleanoptional
github.event.pull_request.milestone.creator.starred_urlstringoptional
github.event.pull_request.milestone.creator.subscriptions_urlstringoptional
github.event.pull_request.milestone.creator.typeBot, User, Organization, Mannequinoptional
github.event.pull_request.milestone.creator.urlstringoptional
github.event.pull_request.requested_reviewersarrayrequired
github.event.pull_request.requested_teamsarray of objectsrequired
github.event.pull_request.requested_teams.deletedbooleanoptional
github.event.pull_request.requested_teams.descriptionstring or nulloptional

Description of the team

github.event.pull_request.requested_teams.html_urlstringoptional
github.event.pull_request.requested_teams.members_urlstringoptional
github.event.pull_request.requested_teams.node_idstringoptional
github.event.pull_request.requested_teams.parentobject or nulloptional
github.event.pull_request.requested_teams.parent.descriptionstring or nullrequired

Description of the team

github.event.pull_request.requested_teams.parent.html_urlstringrequired
github.event.pull_request.requested_teams.parent.idintegerrequired

Unique identifier of the team

github.event.pull_request.requested_teams.parent.members_urlstringrequired
github.event.pull_request.requested_teams.parent.namestringrequired

Name of the team

github.event.pull_request.requested_teams.parent.node_idstringrequired
github.event.pull_request.requested_teams.parent.permissionstringrequired

Permission that the team will have for its repositories

github.event.pull_request.requested_teams.parent.privacyopen, closed, secretrequired
github.event.pull_request.requested_teams.parent.repositories_urlstringrequired
github.event.pull_request.requested_teams.parent.slugstringrequired
github.event.pull_request.requested_teams.parent.urlstringrequired

URL for the team

github.event.pull_request.requested_teams.permissionstringoptional

Permission that the team will have for its repositories

github.event.pull_request.requested_teams.privacyopen, closed, secretoptional
github.event.pull_request.requested_teams.repositories_urlstringoptional
github.event.pull_request.requested_teams.slugstringoptional
github.event.pull_request.requested_teams.urlstringoptional

URL for the team

github.event.pull_request.review_commentsintegeroptional
github.event.pull_request.userobject or nullrequired
github.event.pull_request.user.avatar_urlstringoptional
github.event.pull_request.user.deletedbooleanoptional
github.event.pull_request.user.events_urlstringoptional
github.event.pull_request.user.followers_urlstringoptional
github.event.pull_request.user.following_urlstringoptional
github.event.pull_request.user.gists_urlstringoptional
github.event.pull_request.user.gravatar_idstringoptional
github.event.pull_request.user.html_urlstringoptional
github.event.pull_request.user.namestringoptional
github.event.pull_request.user.node_idstringoptional
github.event.pull_request.user.organizations_urlstringoptional
github.event.pull_request.user.received_events_urlstringoptional
github.event.pull_request.user.repos_urlstringoptional
github.event.pull_request.user.site_adminbooleanoptional
github.event.pull_request.user.starred_urlstringoptional
github.event.pull_request.user.subscriptions_urlstringoptional
github.event.pull_request.user.typeBot, User, Organization, Mannequinoptional
github.event.pull_request.user.urlstringoptional
github.event.senderobjectrequired

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.

fieldtyperequireddescription
github.event.actionauto_merge_disabledrequired
github.event.installationobjectoptional

The GitHub App installation. Webhook payloads contain the installation property when the event is configured for and sent to a GitHub App. For more information, see “Using webhooks with GitHub Apps."

github.event.pull_request.active_lock_reasonresolved, off-topic, too heated, spam, Nonerequired
github.event.pull_request.additionsintegeroptional
github.event.pull_request.assigneeobject or nullrequired
github.event.pull_request.assignee.avatar_urlstringoptional
github.event.pull_request.assignee.deletedbooleanoptional
github.event.pull_request.assignee.events_urlstringoptional
github.event.pull_request.assignee.followers_urlstringoptional
github.event.pull_request.assignee.following_urlstringoptional
github.event.pull_request.assignee.gists_urlstringoptional
github.event.pull_request.assignee.gravatar_idstringoptional
github.event.pull_request.assignee.html_urlstringoptional
github.event.pull_request.assignee.namestringoptional
github.event.pull_request.assignee.node_idstringoptional
github.event.pull_request.assignee.organizations_urlstringoptional
github.event.pull_request.assignee.received_events_urlstringoptional
github.event.pull_request.assignee.repos_urlstringoptional
github.event.pull_request.assignee.site_adminbooleanoptional
github.event.pull_request.assignee.starred_urlstringoptional
github.event.pull_request.assignee.subscriptions_urlstringoptional
github.event.pull_request.assignee.typeBot, User, Organizationoptional
github.event.pull_request.assignee.urlstringoptional
github.event.pull_request.assigneesarray of object,nullsrequired
github.event.pull_request.auto_merge.commit_messagestring or nullrequired

Commit message for the merge commit.

github.event.pull_request.auto_merge.commit_titlestring or nullrequired

Title for the merge commit message.

github.event.pull_request.auto_merge.enabled_byobject or nullrequired
github.event.pull_request.auto_merge.enabled_by.avatar_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.deletedbooleanoptional
github.event.pull_request.auto_merge.enabled_by.events_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.followers_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.following_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.gists_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.gravatar_idstringoptional
github.event.pull_request.auto_merge.enabled_by.html_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.namestringoptional
github.event.pull_request.auto_merge.enabled_by.node_idstringoptional
github.event.pull_request.auto_merge.enabled_by.organizations_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.received_events_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.repos_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.site_adminbooleanoptional
github.event.pull_request.auto_merge.enabled_by.starred_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.subscriptions_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.typeBot, User, Organizationoptional
github.event.pull_request.auto_merge.enabled_by.urlstringoptional
github.event.pull_request.base.labelstringrequired
github.event.pull_request.base.repo.allow_auto_mergebooleanoptional

Whether to allow auto-merge for pull requests.

github.event.pull_request.base.repo.allow_update_branchbooleanoptional
github.event.pull_request.base.repo.created_atinteger or stringrequired
github.event.pull_request.base.repo.delete_branch_on_mergebooleanoptional

Whether to delete head branches when pull requests are merged

github.event.pull_request.base.repo.disabledbooleanoptional

Returns whether or not this repository is disabled.

github.event.pull_request.base.repo.licenseobject or nullrequired
github.event.pull_request.base.repo.license.spdx_idstringrequired
github.event.pull_request.base.repo.merge_commit_messagePR_BODY, PR_TITLE, BLANKoptional

The default value for a merge commit message.

  • PR_TITLE - default to the pull request’s title.
  • PR_BODY - default to the pull request’s body.
  • BLANK - default to a blank commit message.
github.event.pull_request.base.repo.merge_commit_titlePR_TITLE, MERGE_MESSAGEoptional

The default value for a merge commit title.

  • PR_TITLE - default to the pull request’s title.
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
github.event.pull_request.base.repo.organizationstringoptional
github.event.pull_request.base.repo.ownerobject or nullrequired
github.event.pull_request.base.repo.owner.avatar_urlstringoptional
github.event.pull_request.base.repo.owner.deletedbooleanoptional
github.event.pull_request.base.repo.owner.emailstring or nulloptional
github.event.pull_request.base.repo.owner.events_urlstringoptional
github.event.pull_request.base.repo.owner.followers_urlstringoptional
github.event.pull_request.base.repo.owner.following_urlstringoptional
github.event.pull_request.base.repo.owner.gists_urlstringoptional
github.event.pull_request.base.repo.owner.gravatar_idstringoptional
github.event.pull_request.base.repo.owner.html_urlstringoptional
github.event.pull_request.base.repo.owner.namestringoptional
github.event.pull_request.base.repo.owner.node_idstringoptional
github.event.pull_request.base.repo.owner.organizations_urlstringoptional
github.event.pull_request.base.repo.owner.received_events_urlstringoptional
github.event.pull_request.base.repo.owner.repos_urlstringoptional
github.event.pull_request.base.repo.owner.site_adminbooleanoptional
github.event.pull_request.base.repo.owner.starred_urlstringoptional
github.event.pull_request.base.repo.owner.subscriptions_urlstringoptional
github.event.pull_request.base.repo.owner.typeBot, User, Organizationoptional
github.event.pull_request.base.repo.owner.urlstringoptional
github.event.pull_request.base.repo.publicbooleanoptional
github.event.pull_request.base.repo.pushed_atnull or integer or stringrequired
github.event.pull_request.base.repo.role_namestring or nulloptional
github.event.pull_request.base.repo.squash_merge_commit_messagePR_BODY, COMMIT_MESSAGES, BLANKoptional

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request’s body.
  • COMMIT_MESSAGES - default to the branch’s commit messages.
  • BLANK - default to a blank commit message.
github.event.pull_request.base.repo.squash_merge_commit_titlePR_TITLE, COMMIT_OR_PR_TITLEoptional

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request’s title.
  • COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
github.event.pull_request.base.repo.stargazersintegeroptional
github.event.pull_request.base.repo.topicsarray of stringsrequired
github.event.pull_request.base.repo.use_squash_pr_title_as_defaultbooleanoptional

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

github.event.pull_request.base.repo.visibilitypublic, private, internalrequired
github.event.pull_request.base.userobject or nullrequired
github.event.pull_request.base.user.avatar_urlstringoptional
github.event.pull_request.base.user.deletedbooleanoptional
github.event.pull_request.base.user.emailstring or nulloptional
github.event.pull_request.base.user.events_urlstringoptional
github.event.pull_request.base.user.followers_urlstringoptional
github.event.pull_request.base.user.following_urlstringoptional
github.event.pull_request.base.user.gists_urlstringoptional
github.event.pull_request.base.user.gravatar_idstringoptional
github.event.pull_request.base.user.html_urlstringoptional
github.event.pull_request.base.user.namestringoptional
github.event.pull_request.base.user.node_idstringoptional
github.event.pull_request.base.user.organizations_urlstringoptional
github.event.pull_request.base.user.received_events_urlstringoptional
github.event.pull_request.base.user.repos_urlstringoptional
github.event.pull_request.base.user.site_adminbooleanoptional
github.event.pull_request.base.user.starred_urlstringoptional
github.event.pull_request.base.user.subscriptions_urlstringoptional
github.event.pull_request.base.user.typeBot, User, Organizationoptional
github.event.pull_request.base.user.urlstringoptional
github.event.pull_request.changed_filesintegeroptional
github.event.pull_request.commentsintegeroptional
github.event.pull_request.commitsintegeroptional
github.event.pull_request.deletionsintegeroptional
github.event.pull_request.draftbooleanrequired

Indicates whether or not the pull request is a draft.

github.event.pull_request.head.labelstringrequired
github.event.pull_request.head.repoobjectrequired

A git repository

github.event.pull_request.head.repo.allow_auto_mergebooleanoptional

Whether to allow auto-merge for pull requests.

github.event.pull_request.head.repo.allow_update_branchbooleanoptional
github.event.pull_request.head.repo.created_atinteger or stringrequired
github.event.pull_request.head.repo.delete_branch_on_mergebooleanoptional

Whether to delete head branches when pull requests are merged

github.event.pull_request.head.repo.disabledbooleanoptional

Returns whether or not this repository is disabled.

github.event.pull_request.head.repo.license.spdx_idstringrequired
github.event.pull_request.head.repo.merge_commit_messagePR_BODY, PR_TITLE, BLANKoptional

The default value for a merge commit message.

  • PR_TITLE - default to the pull request’s title.
  • PR_BODY - default to the pull request’s body.
  • BLANK - default to a blank commit message.
github.event.pull_request.head.repo.merge_commit_titlePR_TITLE, MERGE_MESSAGEoptional

The default value for a merge commit title.

  • PR_TITLE - default to the pull request’s title.
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
github.event.pull_request.head.repo.organizationstringoptional
github.event.pull_request.head.repo.ownerobject or nullrequired
github.event.pull_request.head.repo.owner.avatar_urlstringoptional
github.event.pull_request.head.repo.owner.deletedbooleanoptional
github.event.pull_request.head.repo.owner.emailstring or nulloptional
github.event.pull_request.head.repo.owner.events_urlstringoptional
github.event.pull_request.head.repo.owner.followers_urlstringoptional
github.event.pull_request.head.repo.owner.following_urlstringoptional
github.event.pull_request.head.repo.owner.gists_urlstringoptional
github.event.pull_request.head.repo.owner.gravatar_idstringoptional
github.event.pull_request.head.repo.owner.html_urlstringoptional
github.event.pull_request.head.repo.owner.namestringoptional
github.event.pull_request.head.repo.owner.node_idstringoptional
github.event.pull_request.head.repo.owner.organizations_urlstringoptional
github.event.pull_request.head.repo.owner.received_events_urlstringoptional
github.event.pull_request.head.repo.owner.repos_urlstringoptional
github.event.pull_request.head.repo.owner.site_adminbooleanoptional
github.event.pull_request.head.repo.owner.starred_urlstringoptional
github.event.pull_request.head.repo.owner.subscriptions_urlstringoptional
github.event.pull_request.head.repo.owner.typeBot, User, Organizationoptional
github.event.pull_request.head.repo.owner.urlstringoptional
github.event.pull_request.head.repo.publicbooleanoptional
github.event.pull_request.head.repo.pushed_atnull or integer or stringrequired
github.event.pull_request.head.repo.role_namestring or nulloptional
github.event.pull_request.head.repo.squash_merge_commit_messagePR_BODY, COMMIT_MESSAGES, BLANKoptional

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request’s body.
  • COMMIT_MESSAGES - default to the branch’s commit messages.
  • BLANK - default to a blank commit message.
github.event.pull_request.head.repo.squash_merge_commit_titlePR_TITLE, COMMIT_OR_PR_TITLEoptional

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request’s title.
  • COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
github.event.pull_request.head.repo.stargazersintegeroptional
github.event.pull_request.head.repo.topicsarray of stringsrequired
github.event.pull_request.head.repo.use_squash_pr_title_as_defaultbooleanoptional

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

github.event.pull_request.head.repo.visibilitypublic, private, internalrequired
github.event.pull_request.head.userobject or nullrequired
github.event.pull_request.head.user.avatar_urlstringoptional
github.event.pull_request.head.user.deletedbooleanoptional
github.event.pull_request.head.user.emailstring or nulloptional
github.event.pull_request.head.user.events_urlstringoptional
github.event.pull_request.head.user.followers_urlstringoptional
github.event.pull_request.head.user.following_urlstringoptional
github.event.pull_request.head.user.gists_urlstringoptional
github.event.pull_request.head.user.gravatar_idstringoptional
github.event.pull_request.head.user.html_urlstringoptional
github.event.pull_request.head.user.namestringoptional
github.event.pull_request.head.user.node_idstringoptional
github.event.pull_request.head.user.organizations_urlstringoptional
github.event.pull_request.head.user.received_events_urlstringoptional
github.event.pull_request.head.user.repos_urlstringoptional
github.event.pull_request.head.user.site_adminbooleanoptional
github.event.pull_request.head.user.starred_urlstringoptional
github.event.pull_request.head.user.subscriptions_urlstringoptional
github.event.pull_request.head.user.typeBot, User, Organizationoptional
github.event.pull_request.head.user.urlstringoptional
github.event.pull_request.maintainer_can_modifybooleanoptional

Indicates whether maintainers can modify the pull request.

github.event.pull_request.mergeableboolean or nulloptional
github.event.pull_request.mergeable_statestringoptional
github.event.pull_request.mergedboolean or nulloptional
github.event.pull_request.merged_byobject or nulloptional
github.event.pull_request.merged_by.avatar_urlstringoptional
github.event.pull_request.merged_by.deletedbooleanoptional
github.event.pull_request.merged_by.events_urlstringoptional
github.event.pull_request.merged_by.followers_urlstringoptional
github.event.pull_request.merged_by.following_urlstringoptional
github.event.pull_request.merged_by.gists_urlstringoptional
github.event.pull_request.merged_by.gravatar_idstringoptional
github.event.pull_request.merged_by.html_urlstringoptional
github.event.pull_request.merged_by.namestringoptional
github.event.pull_request.merged_by.node_idstringoptional
github.event.pull_request.merged_by.organizations_urlstringoptional
github.event.pull_request.merged_by.received_events_urlstringoptional
github.event.pull_request.merged_by.repos_urlstringoptional
github.event.pull_request.merged_by.site_adminbooleanoptional
github.event.pull_request.merged_by.starred_urlstringoptional
github.event.pull_request.merged_by.subscriptions_urlstringoptional
github.event.pull_request.merged_by.typeBot, User, Organizationoptional
github.event.pull_request.merged_by.urlstringoptional
github.event.pull_request.milestoneobject or nullrequired

A collection of related issues and pull requests.

github.event.pull_request.milestone.creatorobject or nullrequired
github.event.pull_request.milestone.creator.avatar_urlstringoptional
github.event.pull_request.milestone.creator.deletedbooleanoptional
github.event.pull_request.milestone.creator.events_urlstringoptional
github.event.pull_request.milestone.creator.followers_urlstringoptional
github.event.pull_request.milestone.creator.following_urlstringoptional
github.event.pull_request.milestone.creator.gists_urlstringoptional
github.event.pull_request.milestone.creator.gravatar_idstringoptional
github.event.pull_request.milestone.creator.html_urlstringoptional
github.event.pull_request.milestone.creator.namestringoptional
github.event.pull_request.milestone.creator.node_idstringoptional
github.event.pull_request.milestone.creator.organizations_urlstringoptional
github.event.pull_request.milestone.creator.received_events_urlstringoptional
github.event.pull_request.milestone.creator.repos_urlstringoptional
github.event.pull_request.milestone.creator.site_adminbooleanoptional
github.event.pull_request.milestone.creator.starred_urlstringoptional
github.event.pull_request.milestone.creator.subscriptions_urlstringoptional
github.event.pull_request.milestone.creator.typeBot, User, Organizationoptional
github.event.pull_request.milestone.creator.urlstringoptional
github.event.pull_request.requested_reviewersarrayrequired
github.event.pull_request.requested_teamsarray of objectsrequired
github.event.pull_request.requested_teams.deletedbooleanoptional
github.event.pull_request.requested_teams.descriptionstring or nulloptional

Description of the team

github.event.pull_request.requested_teams.html_urlstringoptional
github.event.pull_request.requested_teams.members_urlstringoptional
github.event.pull_request.requested_teams.node_idstringoptional
github.event.pull_request.requested_teams.parentobject or nulloptional
github.event.pull_request.requested_teams.parent.descriptionstring or nullrequired

Description of the team

github.event.pull_request.requested_teams.parent.html_urlstringrequired
github.event.pull_request.requested_teams.parent.idintegerrequired

Unique identifier of the team

github.event.pull_request.requested_teams.parent.members_urlstringrequired
github.event.pull_request.requested_teams.parent.namestringrequired

Name of the team

github.event.pull_request.requested_teams.parent.node_idstringrequired
github.event.pull_request.requested_teams.parent.permissionstringrequired

Permission that the team will have for its repositories

github.event.pull_request.requested_teams.parent.privacyopen, closed, secretrequired
github.event.pull_request.requested_teams.parent.repositories_urlstringrequired
github.event.pull_request.requested_teams.parent.slugstringrequired
github.event.pull_request.requested_teams.parent.urlstringrequired

URL for the team

github.event.pull_request.requested_teams.permissionstringoptional

Permission that the team will have for its repositories

github.event.pull_request.requested_teams.privacyopen, closed, secretoptional
github.event.pull_request.requested_teams.repositories_urlstringoptional
github.event.pull_request.requested_teams.slugstringoptional
github.event.pull_request.requested_teams.urlstringoptional

URL for the team

github.event.pull_request.review_commentsintegeroptional
github.event.pull_request.userobject or nullrequired
github.event.pull_request.user.avatar_urlstringoptional
github.event.pull_request.user.deletedbooleanoptional
github.event.pull_request.user.events_urlstringoptional
github.event.pull_request.user.followers_urlstringoptional
github.event.pull_request.user.following_urlstringoptional
github.event.pull_request.user.gists_urlstringoptional
github.event.pull_request.user.gravatar_idstringoptional
github.event.pull_request.user.html_urlstringoptional
github.event.pull_request.user.namestringoptional
github.event.pull_request.user.node_idstringoptional
github.event.pull_request.user.organizations_urlstringoptional
github.event.pull_request.user.received_events_urlstringoptional
github.event.pull_request.user.repos_urlstringoptional
github.event.pull_request.user.site_adminbooleanoptional
github.event.pull_request.user.starred_urlstringoptional
github.event.pull_request.user.subscriptions_urlstringoptional
github.event.pull_request.user.typeBot, User, Organization, Mannequinoptional
github.event.pull_request.user.urlstringoptional
github.event.reasonstringrequired
github.event.senderobjectrequired

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.

fieldtyperequireddescription
github.event.actionauto_merge_enabledrequired
github.event.installationobjectoptional

The GitHub App installation. Webhook payloads contain the installation property when the event is configured for and sent to a GitHub App. For more information, see “Using webhooks with GitHub Apps."

github.event.pull_request.active_lock_reasonresolved, off-topic, too heated, spam, Nonerequired
github.event.pull_request.additionsintegeroptional
github.event.pull_request.assigneeobject or nullrequired
github.event.pull_request.assignee.avatar_urlstringoptional
github.event.pull_request.assignee.deletedbooleanoptional
github.event.pull_request.assignee.events_urlstringoptional
github.event.pull_request.assignee.followers_urlstringoptional
github.event.pull_request.assignee.following_urlstringoptional
github.event.pull_request.assignee.gists_urlstringoptional
github.event.pull_request.assignee.gravatar_idstringoptional
github.event.pull_request.assignee.html_urlstringoptional
github.event.pull_request.assignee.namestringoptional
github.event.pull_request.assignee.node_idstringoptional
github.event.pull_request.assignee.organizations_urlstringoptional
github.event.pull_request.assignee.received_events_urlstringoptional
github.event.pull_request.assignee.repos_urlstringoptional
github.event.pull_request.assignee.site_adminbooleanoptional
github.event.pull_request.assignee.starred_urlstringoptional
github.event.pull_request.assignee.subscriptions_urlstringoptional
github.event.pull_request.assignee.typeBot, User, Organizationoptional
github.event.pull_request.assignee.urlstringoptional
github.event.pull_request.assigneesarray of object,nullsrequired
github.event.pull_request.auto_merge.commit_messagestring or nullrequired

Commit message for the merge commit.

github.event.pull_request.auto_merge.commit_titlestring or nullrequired

Title for the merge commit message.

github.event.pull_request.auto_merge.enabled_byobject or nullrequired
github.event.pull_request.auto_merge.enabled_by.avatar_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.deletedbooleanoptional
github.event.pull_request.auto_merge.enabled_by.events_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.followers_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.following_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.gists_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.gravatar_idstringoptional
github.event.pull_request.auto_merge.enabled_by.html_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.namestringoptional
github.event.pull_request.auto_merge.enabled_by.node_idstringoptional
github.event.pull_request.auto_merge.enabled_by.organizations_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.received_events_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.repos_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.site_adminbooleanoptional
github.event.pull_request.auto_merge.enabled_by.starred_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.subscriptions_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.typeBot, User, Organizationoptional
github.event.pull_request.auto_merge.enabled_by.urlstringoptional
github.event.pull_request.base.labelstringrequired
github.event.pull_request.base.repo.allow_auto_mergebooleanoptional

Whether to allow auto-merge for pull requests.

github.event.pull_request.base.repo.allow_update_branchbooleanoptional
github.event.pull_request.base.repo.created_atinteger or stringrequired
github.event.pull_request.base.repo.delete_branch_on_mergebooleanoptional

Whether to delete head branches when pull requests are merged

github.event.pull_request.base.repo.disabledbooleanoptional

Returns whether or not this repository is disabled.

github.event.pull_request.base.repo.licenseobject or nullrequired
github.event.pull_request.base.repo.license.spdx_idstringrequired
github.event.pull_request.base.repo.merge_commit_messagePR_BODY, PR_TITLE, BLANKoptional

The default value for a merge commit message.

  • PR_TITLE - default to the pull request’s title.
  • PR_BODY - default to the pull request’s body.
  • BLANK - default to a blank commit message.
github.event.pull_request.base.repo.merge_commit_titlePR_TITLE, MERGE_MESSAGEoptional

The default value for a merge commit title.

  • PR_TITLE - default to the pull request’s title.
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
github.event.pull_request.base.repo.organizationstringoptional
github.event.pull_request.base.repo.ownerobject or nullrequired
github.event.pull_request.base.repo.owner.avatar_urlstringoptional
github.event.pull_request.base.repo.owner.deletedbooleanoptional
github.event.pull_request.base.repo.owner.emailstring or nulloptional
github.event.pull_request.base.repo.owner.events_urlstringoptional
github.event.pull_request.base.repo.owner.followers_urlstringoptional
github.event.pull_request.base.repo.owner.following_urlstringoptional
github.event.pull_request.base.repo.owner.gists_urlstringoptional
github.event.pull_request.base.repo.owner.gravatar_idstringoptional
github.event.pull_request.base.repo.owner.html_urlstringoptional
github.event.pull_request.base.repo.owner.namestringoptional
github.event.pull_request.base.repo.owner.node_idstringoptional
github.event.pull_request.base.repo.owner.organizations_urlstringoptional
github.event.pull_request.base.repo.owner.received_events_urlstringoptional
github.event.pull_request.base.repo.owner.repos_urlstringoptional
github.event.pull_request.base.repo.owner.site_adminbooleanoptional
github.event.pull_request.base.repo.owner.starred_urlstringoptional
github.event.pull_request.base.repo.owner.subscriptions_urlstringoptional
github.event.pull_request.base.repo.owner.typeBot, User, Organizationoptional
github.event.pull_request.base.repo.owner.urlstringoptional
github.event.pull_request.base.repo.publicbooleanoptional
github.event.pull_request.base.repo.pushed_atnull or integer or stringrequired
github.event.pull_request.base.repo.role_namestring or nulloptional
github.event.pull_request.base.repo.squash_merge_commit_messagePR_BODY, COMMIT_MESSAGES, BLANKoptional

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request’s body.
  • COMMIT_MESSAGES - default to the branch’s commit messages.
  • BLANK - default to a blank commit message.
github.event.pull_request.base.repo.squash_merge_commit_titlePR_TITLE, COMMIT_OR_PR_TITLEoptional

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request’s title.
  • COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
github.event.pull_request.base.repo.stargazersintegeroptional
github.event.pull_request.base.repo.topicsarray of stringsrequired
github.event.pull_request.base.repo.use_squash_pr_title_as_defaultbooleanoptional

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

github.event.pull_request.base.repo.visibilitypublic, private, internalrequired
github.event.pull_request.base.userobject or nullrequired
github.event.pull_request.base.user.avatar_urlstringoptional
github.event.pull_request.base.user.deletedbooleanoptional
github.event.pull_request.base.user.emailstring or nulloptional
github.event.pull_request.base.user.events_urlstringoptional
github.event.pull_request.base.user.followers_urlstringoptional
github.event.pull_request.base.user.following_urlstringoptional
github.event.pull_request.base.user.gists_urlstringoptional
github.event.pull_request.base.user.gravatar_idstringoptional
github.event.pull_request.base.user.html_urlstringoptional
github.event.pull_request.base.user.namestringoptional
github.event.pull_request.base.user.node_idstringoptional
github.event.pull_request.base.user.organizations_urlstringoptional
github.event.pull_request.base.user.received_events_urlstringoptional
github.event.pull_request.base.user.repos_urlstringoptional
github.event.pull_request.base.user.site_adminbooleanoptional
github.event.pull_request.base.user.starred_urlstringoptional
github.event.pull_request.base.user.subscriptions_urlstringoptional
github.event.pull_request.base.user.typeBot, User, Organizationoptional
github.event.pull_request.base.user.urlstringoptional
github.event.pull_request.changed_filesintegeroptional
github.event.pull_request.commentsintegeroptional
github.event.pull_request.commitsintegeroptional
github.event.pull_request.deletionsintegeroptional
github.event.pull_request.draftbooleanrequired

Indicates whether or not the pull request is a draft.

github.event.pull_request.head.labelstringrequired
github.event.pull_request.head.repoobjectrequired

A git repository

github.event.pull_request.head.repo.allow_auto_mergebooleanoptional

Whether to allow auto-merge for pull requests.

github.event.pull_request.head.repo.allow_update_branchbooleanoptional
github.event.pull_request.head.repo.created_atinteger or stringrequired
github.event.pull_request.head.repo.delete_branch_on_mergebooleanoptional

Whether to delete head branches when pull requests are merged

github.event.pull_request.head.repo.disabledbooleanoptional

Returns whether or not this repository is disabled.

github.event.pull_request.head.repo.license.spdx_idstringrequired
github.event.pull_request.head.repo.merge_commit_messagePR_BODY, PR_TITLE, BLANKoptional

The default value for a merge commit message.

  • PR_TITLE - default to the pull request’s title.
  • PR_BODY - default to the pull request’s body.
  • BLANK - default to a blank commit message.
github.event.pull_request.head.repo.merge_commit_titlePR_TITLE, MERGE_MESSAGEoptional

The default value for a merge commit title.

  • PR_TITLE - default to the pull request’s title.
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
github.event.pull_request.head.repo.organizationstringoptional
github.event.pull_request.head.repo.ownerobject or nullrequired
github.event.pull_request.head.repo.owner.avatar_urlstringoptional
github.event.pull_request.head.repo.owner.deletedbooleanoptional
github.event.pull_request.head.repo.owner.emailstring or nulloptional
github.event.pull_request.head.repo.owner.events_urlstringoptional
github.event.pull_request.head.repo.owner.followers_urlstringoptional
github.event.pull_request.head.repo.owner.following_urlstringoptional
github.event.pull_request.head.repo.owner.gists_urlstringoptional
github.event.pull_request.head.repo.owner.gravatar_idstringoptional
github.event.pull_request.head.repo.owner.html_urlstringoptional
github.event.pull_request.head.repo.owner.namestringoptional
github.event.pull_request.head.repo.owner.node_idstringoptional
github.event.pull_request.head.repo.owner.organizations_urlstringoptional
github.event.pull_request.head.repo.owner.received_events_urlstringoptional
github.event.pull_request.head.repo.owner.repos_urlstringoptional
github.event.pull_request.head.repo.owner.site_adminbooleanoptional
github.event.pull_request.head.repo.owner.starred_urlstringoptional
github.event.pull_request.head.repo.owner.subscriptions_urlstringoptional
github.event.pull_request.head.repo.owner.typeBot, User, Organizationoptional
github.event.pull_request.head.repo.owner.urlstringoptional
github.event.pull_request.head.repo.publicbooleanoptional
github.event.pull_request.head.repo.pushed_atnull or integer or stringrequired
github.event.pull_request.head.repo.role_namestring or nulloptional
github.event.pull_request.head.repo.squash_merge_commit_messagePR_BODY, COMMIT_MESSAGES, BLANKoptional

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request’s body.
  • COMMIT_MESSAGES - default to the branch’s commit messages.
  • BLANK - default to a blank commit message.
github.event.pull_request.head.repo.squash_merge_commit_titlePR_TITLE, COMMIT_OR_PR_TITLEoptional

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request’s title.
  • COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
github.event.pull_request.head.repo.stargazersintegeroptional
github.event.pull_request.head.repo.topicsarray of stringsrequired
github.event.pull_request.head.repo.use_squash_pr_title_as_defaultbooleanoptional

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

github.event.pull_request.head.repo.visibilitypublic, private, internalrequired
github.event.pull_request.head.userobject or nullrequired
github.event.pull_request.head.user.avatar_urlstringoptional
github.event.pull_request.head.user.deletedbooleanoptional
github.event.pull_request.head.user.emailstring or nulloptional
github.event.pull_request.head.user.events_urlstringoptional
github.event.pull_request.head.user.followers_urlstringoptional
github.event.pull_request.head.user.following_urlstringoptional
github.event.pull_request.head.user.gists_urlstringoptional
github.event.pull_request.head.user.gravatar_idstringoptional
github.event.pull_request.head.user.html_urlstringoptional
github.event.pull_request.head.user.namestringoptional
github.event.pull_request.head.user.node_idstringoptional
github.event.pull_request.head.user.organizations_urlstringoptional
github.event.pull_request.head.user.received_events_urlstringoptional
github.event.pull_request.head.user.repos_urlstringoptional
github.event.pull_request.head.user.site_adminbooleanoptional
github.event.pull_request.head.user.starred_urlstringoptional
github.event.pull_request.head.user.subscriptions_urlstringoptional
github.event.pull_request.head.user.typeBot, User, Organizationoptional
github.event.pull_request.head.user.urlstringoptional
github.event.pull_request.maintainer_can_modifybooleanoptional

Indicates whether maintainers can modify the pull request.

github.event.pull_request.mergeableboolean or nulloptional
github.event.pull_request.mergeable_statestringoptional
github.event.pull_request.mergedboolean or nulloptional
github.event.pull_request.merged_byobject or nulloptional
github.event.pull_request.merged_by.avatar_urlstringoptional
github.event.pull_request.merged_by.deletedbooleanoptional
github.event.pull_request.merged_by.events_urlstringoptional
github.event.pull_request.merged_by.followers_urlstringoptional
github.event.pull_request.merged_by.following_urlstringoptional
github.event.pull_request.merged_by.gists_urlstringoptional
github.event.pull_request.merged_by.gravatar_idstringoptional
github.event.pull_request.merged_by.html_urlstringoptional
github.event.pull_request.merged_by.namestringoptional
github.event.pull_request.merged_by.node_idstringoptional
github.event.pull_request.merged_by.organizations_urlstringoptional
github.event.pull_request.merged_by.received_events_urlstringoptional
github.event.pull_request.merged_by.repos_urlstringoptional
github.event.pull_request.merged_by.site_adminbooleanoptional
github.event.pull_request.merged_by.starred_urlstringoptional
github.event.pull_request.merged_by.subscriptions_urlstringoptional
github.event.pull_request.merged_by.typeBot, User, Organizationoptional
github.event.pull_request.merged_by.urlstringoptional
github.event.pull_request.milestoneobject or nullrequired

A collection of related issues and pull requests.

github.event.pull_request.milestone.creatorobject or nullrequired
github.event.pull_request.milestone.creator.avatar_urlstringoptional
github.event.pull_request.milestone.creator.deletedbooleanoptional
github.event.pull_request.milestone.creator.events_urlstringoptional
github.event.pull_request.milestone.creator.followers_urlstringoptional
github.event.pull_request.milestone.creator.following_urlstringoptional
github.event.pull_request.milestone.creator.gists_urlstringoptional
github.event.pull_request.milestone.creator.gravatar_idstringoptional
github.event.pull_request.milestone.creator.html_urlstringoptional
github.event.pull_request.milestone.creator.namestringoptional
github.event.pull_request.milestone.creator.node_idstringoptional
github.event.pull_request.milestone.creator.organizations_urlstringoptional
github.event.pull_request.milestone.creator.received_events_urlstringoptional
github.event.pull_request.milestone.creator.repos_urlstringoptional
github.event.pull_request.milestone.creator.site_adminbooleanoptional
github.event.pull_request.milestone.creator.starred_urlstringoptional
github.event.pull_request.milestone.creator.subscriptions_urlstringoptional
github.event.pull_request.milestone.creator.typeBot, User, Organization, Mannequinoptional
github.event.pull_request.milestone.creator.urlstringoptional
github.event.pull_request.requested_reviewersarrayrequired
github.event.pull_request.requested_teamsarray of objectsrequired
github.event.pull_request.requested_teams.deletedbooleanoptional
github.event.pull_request.requested_teams.descriptionstring or nulloptional

Description of the team

github.event.pull_request.requested_teams.html_urlstringoptional
github.event.pull_request.requested_teams.members_urlstringoptional
github.event.pull_request.requested_teams.node_idstringoptional
github.event.pull_request.requested_teams.parentobject or nulloptional
github.event.pull_request.requested_teams.parent.descriptionstring or nullrequired

Description of the team

github.event.pull_request.requested_teams.parent.html_urlstringrequired
github.event.pull_request.requested_teams.parent.idintegerrequired

Unique identifier of the team

github.event.pull_request.requested_teams.parent.members_urlstringrequired
github.event.pull_request.requested_teams.parent.namestringrequired

Name of the team

github.event.pull_request.requested_teams.parent.node_idstringrequired
github.event.pull_request.requested_teams.parent.permissionstringrequired

Permission that the team will have for its repositories

github.event.pull_request.requested_teams.parent.privacyopen, closed, secretrequired
github.event.pull_request.requested_teams.parent.repositories_urlstringrequired
github.event.pull_request.requested_teams.parent.slugstringrequired
github.event.pull_request.requested_teams.parent.urlstringrequired

URL for the team

github.event.pull_request.requested_teams.permissionstringoptional

Permission that the team will have for its repositories

github.event.pull_request.requested_teams.privacyopen, closed, secretoptional
github.event.pull_request.requested_teams.repositories_urlstringoptional
github.event.pull_request.requested_teams.slugstringoptional
github.event.pull_request.requested_teams.urlstringoptional

URL for the team

github.event.pull_request.review_commentsintegeroptional
github.event.pull_request.userobject or nullrequired
github.event.pull_request.user.avatar_urlstringoptional
github.event.pull_request.user.deletedbooleanoptional
github.event.pull_request.user.events_urlstringoptional
github.event.pull_request.user.followers_urlstringoptional
github.event.pull_request.user.following_urlstringoptional
github.event.pull_request.user.gists_urlstringoptional
github.event.pull_request.user.gravatar_idstringoptional
github.event.pull_request.user.html_urlstringoptional
github.event.pull_request.user.namestringoptional
github.event.pull_request.user.node_idstringoptional
github.event.pull_request.user.organizations_urlstringoptional
github.event.pull_request.user.received_events_urlstringoptional
github.event.pull_request.user.repos_urlstringoptional
github.event.pull_request.user.site_adminbooleanoptional
github.event.pull_request.user.starred_urlstringoptional
github.event.pull_request.user.subscriptions_urlstringoptional
github.event.pull_request.user.typeBot, User, Organization, Mannequinoptional
github.event.pull_request.user.urlstringoptional
github.event.reasonstringoptional
github.event.senderobjectrequired

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.

fieldtyperequireddescription
github.event.actionclosedrequired
github.event.installationobjectoptional

The GitHub App installation. Webhook payloads contain the installation property when the event is configured for and sent to a GitHub App. For more information, see “Using webhooks with GitHub Apps."

github.event.pull_request.userobjectrequired

A GitHub user.

github.event.pull_request.user.namestring or nulloptional
github.event.pull_request.user.node_idstringrequired
github.event.pull_request.user.avatar_urlstringrequired
github.event.pull_request.user.gravatar_idstring or nullrequired
github.event.pull_request.user.urlstringrequired
github.event.pull_request.user.html_urlstringrequired
github.event.pull_request.user.followers_urlstringrequired
github.event.pull_request.user.following_urlstringrequired
github.event.pull_request.user.gists_urlstringrequired
github.event.pull_request.user.starred_urlstringrequired
github.event.pull_request.user.subscriptions_urlstringrequired
github.event.pull_request.user.organizations_urlstringrequired
github.event.pull_request.user.repos_urlstringrequired
github.event.pull_request.user.events_urlstringrequired
github.event.pull_request.user.received_events_urlstringrequired
github.event.pull_request.user.typestringrequired
github.event.pull_request.user.site_adminbooleanrequired
github.event.pull_request.user.starred_atstringoptional
github.event.pull_request.milestoneobjectrequired

A collection of related issues and pull requests.

github.event.pull_request.milestone.creatorobjectrequired

A GitHub user.

github.event.pull_request.milestone.creator.namestring or nulloptional
github.event.pull_request.milestone.creator.node_idstringrequired
github.event.pull_request.milestone.creator.avatar_urlstringrequired
github.event.pull_request.milestone.creator.gravatar_idstring or nullrequired
github.event.pull_request.milestone.creator.urlstringrequired
github.event.pull_request.milestone.creator.html_urlstringrequired
github.event.pull_request.milestone.creator.followers_urlstringrequired
github.event.pull_request.milestone.creator.following_urlstringrequired
github.event.pull_request.milestone.creator.gists_urlstringrequired
github.event.pull_request.milestone.creator.starred_urlstringrequired
github.event.pull_request.milestone.creator.subscriptions_urlstringrequired
github.event.pull_request.milestone.creator.organizations_urlstringrequired
github.event.pull_request.milestone.creator.repos_urlstringrequired
github.event.pull_request.milestone.creator.events_urlstringrequired
github.event.pull_request.milestone.creator.received_events_urlstringrequired
github.event.pull_request.milestone.creator.typestringrequired
github.event.pull_request.milestone.creator.site_adminbooleanrequired
github.event.pull_request.milestone.creator.starred_atstringoptional
github.event.pull_request.active_lock_reasonstring or nulloptional
github.event.pull_request.assigneeobjectrequired

A GitHub user.

github.event.pull_request.assignee.namestring or nulloptional
github.event.pull_request.assignee.node_idstringrequired
github.event.pull_request.assignee.avatar_urlstringrequired
github.event.pull_request.assignee.gravatar_idstring or nullrequired
github.event.pull_request.assignee.urlstringrequired
github.event.pull_request.assignee.html_urlstringrequired
github.event.pull_request.assignee.followers_urlstringrequired
github.event.pull_request.assignee.following_urlstringrequired
github.event.pull_request.assignee.gists_urlstringrequired
github.event.pull_request.assignee.starred_urlstringrequired
github.event.pull_request.assignee.subscriptions_urlstringrequired
github.event.pull_request.assignee.organizations_urlstringrequired
github.event.pull_request.assignee.repos_urlstringrequired
github.event.pull_request.assignee.events_urlstringrequired
github.event.pull_request.assignee.received_events_urlstringrequired
github.event.pull_request.assignee.typestringrequired
github.event.pull_request.assignee.site_adminbooleanrequired
github.event.pull_request.assignee.starred_atstringoptional
github.event.pull_request.assigneesarray of objects or nulloptional
github.event.pull_request.assignees.namestring or nulloptional
github.event.pull_request.assignees.emailstring or nulloptional
github.event.pull_request.assignees.loginstringrequired
github.event.pull_request.assignees.idintegerrequired
github.event.pull_request.assignees.node_idstringrequired
github.event.pull_request.assignees.avatar_urlstringrequired
github.event.pull_request.assignees.gravatar_idstring or nullrequired
github.event.pull_request.assignees.urlstringrequired
github.event.pull_request.assignees.html_urlstringrequired
github.event.pull_request.assignees.followers_urlstringrequired
github.event.pull_request.assignees.following_urlstringrequired
github.event.pull_request.assignees.gists_urlstringrequired
github.event.pull_request.assignees.starred_urlstringrequired
github.event.pull_request.assignees.subscriptions_urlstringrequired
github.event.pull_request.assignees.organizations_urlstringrequired
github.event.pull_request.assignees.repos_urlstringrequired
github.event.pull_request.assignees.events_urlstringrequired
github.event.pull_request.assignees.received_events_urlstringrequired
github.event.pull_request.assignees.typestringrequired
github.event.pull_request.assignees.site_adminbooleanrequired
github.event.pull_request.assignees.starred_atstringoptional
github.event.pull_request.requested_reviewersarray of objects or nulloptional
github.event.pull_request.requested_reviewers.namestring or nulloptional
github.event.pull_request.requested_reviewers.emailstring or nulloptional
github.event.pull_request.requested_reviewers.loginstringrequired
github.event.pull_request.requested_reviewers.idintegerrequired
github.event.pull_request.requested_reviewers.node_idstringrequired
github.event.pull_request.requested_reviewers.avatar_urlstringrequired
github.event.pull_request.requested_reviewers.gravatar_idstring or nullrequired
github.event.pull_request.requested_reviewers.urlstringrequired
github.event.pull_request.requested_reviewers.html_urlstringrequired
github.event.pull_request.requested_reviewers.followers_urlstringrequired
github.event.pull_request.requested_reviewers.following_urlstringrequired
github.event.pull_request.requested_reviewers.gists_urlstringrequired
github.event.pull_request.requested_reviewers.starred_urlstringrequired
github.event.pull_request.requested_reviewers.subscriptions_urlstringrequired
github.event.pull_request.requested_reviewers.organizations_urlstringrequired
github.event.pull_request.requested_reviewers.repos_urlstringrequired
github.event.pull_request.requested_reviewers.events_urlstringrequired
github.event.pull_request.requested_reviewers.received_events_urlstringrequired
github.event.pull_request.requested_reviewers.typestringrequired
github.event.pull_request.requested_reviewers.site_adminbooleanrequired
github.event.pull_request.requested_reviewers.starred_atstringoptional
github.event.pull_request.requested_teamsarray of objects or nulloptional
github.event.pull_request.requested_teams.node_idstringrequired
github.event.pull_request.requested_teams.urlstringrequired

URL for the team

github.event.pull_request.requested_teams.members_urlstringrequired
github.event.pull_request.requested_teams.descriptionstring or nullrequired

Description of the team

github.event.pull_request.requested_teams.permissionstringrequired

Permission that the team will have for its repositories

github.event.pull_request.requested_teams.privacystringoptional

The level of privacy this team should have

github.event.pull_request.requested_teams.notification_settingstringoptional

The notification setting the team has set

github.event.pull_request.requested_teams.html_urlstringrequired
github.event.pull_request.requested_teams.repositories_urlstringrequired
github.event.pull_request.requested_teams.slugstringrequired
github.event.pull_request.requested_teams.ldap_dnstringoptional

Distinguished Name (DN) that team maps to within LDAP environment

github.event.pull_request.head.labelstringrequired
github.event.pull_request.head.repoobject or nullrequired
github.event.pull_request.head.repo.ownerobjectrequired
github.event.pull_request.head.repo.owner.avatar_urlstringrequired
github.event.pull_request.head.repo.owner.events_urlstringrequired
github.event.pull_request.head.repo.owner.followers_urlstringrequired
github.event.pull_request.head.repo.owner.following_urlstringrequired
github.event.pull_request.head.repo.owner.gists_urlstringrequired
github.event.pull_request.head.repo.owner.gravatar_idstring or nullrequired
github.event.pull_request.head.repo.owner.html_urlstringrequired
github.event.pull_request.head.repo.owner.node_idstringrequired
github.event.pull_request.head.repo.owner.organizations_urlstringrequired
github.event.pull_request.head.repo.owner.received_events_urlstringrequired
github.event.pull_request.head.repo.owner.repos_urlstringrequired
github.event.pull_request.head.repo.owner.site_adminbooleanrequired
github.event.pull_request.head.repo.owner.starred_urlstringrequired
github.event.pull_request.head.repo.owner.subscriptions_urlstringrequired
github.event.pull_request.head.repo.owner.typestringrequired
github.event.pull_request.head.repo.owner.urlstringrequired
github.event.pull_request.head.repo.disabledbooleanrequired
github.event.pull_request.head.repo.visibilitystringoptional

The repository visibility: public, private, or internal.

github.event.pull_request.head.repo.temp_clone_tokenstringoptional
github.event.pull_request.head.repo.license.spdx_idstring or nullrequired
github.event.pull_request.head.repo.pushed_atstringrequired
github.event.pull_request.head.repo.topicsarray of stringsoptional
github.event.pull_request.head.repo.created_atstringrequired
github.event.pull_request.head.userobjectrequired
github.event.pull_request.head.user.avatar_urlstringrequired
github.event.pull_request.head.user.events_urlstringrequired
github.event.pull_request.head.user.followers_urlstringrequired
github.event.pull_request.head.user.following_urlstringrequired
github.event.pull_request.head.user.gists_urlstringrequired
github.event.pull_request.head.user.gravatar_idstring or nullrequired
github.event.pull_request.head.user.html_urlstringrequired
github.event.pull_request.head.user.node_idstringrequired
github.event.pull_request.head.user.organizations_urlstringrequired
github.event.pull_request.head.user.received_events_urlstringrequired
github.event.pull_request.head.user.repos_urlstringrequired
github.event.pull_request.head.user.site_adminbooleanrequired
github.event.pull_request.head.user.starred_urlstringrequired
github.event.pull_request.head.user.subscriptions_urlstringrequired
github.event.pull_request.head.user.typestringrequired
github.event.pull_request.head.user.urlstringrequired
github.event.pull_request.base.labelstringrequired
github.event.pull_request.base.repo.ownerobjectrequired
github.event.pull_request.base.repo.owner.avatar_urlstringrequired
github.event.pull_request.base.repo.owner.events_urlstringrequired
github.event.pull_request.base.repo.owner.followers_urlstringrequired
github.event.pull_request.base.repo.owner.following_urlstringrequired
github.event.pull_request.base.repo.owner.gists_urlstringrequired
github.event.pull_request.base.repo.owner.gravatar_idstring or nullrequired
github.event.pull_request.base.repo.owner.html_urlstringrequired
github.event.pull_request.base.repo.owner.node_idstringrequired
github.event.pull_request.base.repo.owner.organizations_urlstringrequired
github.event.pull_request.base.repo.owner.received_events_urlstringrequired
github.event.pull_request.base.repo.owner.repos_urlstringrequired
github.event.pull_request.base.repo.owner.site_adminbooleanrequired
github.event.pull_request.base.repo.owner.starred_urlstringrequired
github.event.pull_request.base.repo.owner.subscriptions_urlstringrequired
github.event.pull_request.base.repo.owner.typestringrequired
github.event.pull_request.base.repo.owner.urlstringrequired
github.event.pull_request.base.repo.disabledbooleanrequired
github.event.pull_request.base.repo.visibilitystringoptional

The repository visibility: public, private, or internal.

github.event.pull_request.base.repo.temp_clone_tokenstringoptional
github.event.pull_request.base.repo.licenseobjectrequired

License Simple

github.event.pull_request.base.repo.license.spdx_idstring or nullrequired
github.event.pull_request.base.repo.license.html_urlstringoptional
github.event.pull_request.base.repo.pushed_atstringrequired
github.event.pull_request.base.repo.topicsarray of stringsoptional
github.event.pull_request.base.repo.created_atstringrequired
github.event.pull_request.base.userobjectrequired
github.event.pull_request.base.user.avatar_urlstringrequired
github.event.pull_request.base.user.events_urlstringrequired
github.event.pull_request.base.user.followers_urlstringrequired
github.event.pull_request.base.user.following_urlstringrequired
github.event.pull_request.base.user.gists_urlstringrequired
github.event.pull_request.base.user.gravatar_idstring or nullrequired
github.event.pull_request.base.user.html_urlstringrequired
github.event.pull_request.base.user.node_idstringrequired
github.event.pull_request.base.user.organizations_urlstringrequired
github.event.pull_request.base.user.received_events_urlstringrequired
github.event.pull_request.base.user.repos_urlstringrequired
github.event.pull_request.base.user.site_adminbooleanrequired
github.event.pull_request.base.user.starred_urlstringrequired
github.event.pull_request.base.user.subscriptions_urlstringrequired
github.event.pull_request.base.user.typestringrequired
github.event.pull_request.base.user.urlstringrequired
github.event.pull_request.auto_merge.enabled_byobjectrequired

A GitHub user.

github.event.pull_request.auto_merge.enabled_by.namestring or nulloptional
github.event.pull_request.auto_merge.enabled_by.node_idstringrequired
github.event.pull_request.auto_merge.enabled_by.avatar_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.gravatar_idstring or nullrequired
github.event.pull_request.auto_merge.enabled_by.urlstringrequired
github.event.pull_request.auto_merge.enabled_by.html_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.followers_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.following_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.gists_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.starred_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.subscriptions_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.organizations_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.repos_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.events_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.received_events_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.typestringrequired
github.event.pull_request.auto_merge.enabled_by.site_adminbooleanrequired
github.event.pull_request.auto_merge.enabled_by.starred_atstringoptional
github.event.pull_request.auto_merge.commit_titlestringrequired

Title for the merge commit message.

github.event.pull_request.auto_merge.commit_messagestringrequired

Commit message for the merge commit.

github.event.pull_request.draftbooleanoptional

Indicates whether or not the pull request is a draft.

github.event.pull_request.mergedbooleanrequired
github.event.pull_request.mergeableboolean or nullrequired
github.event.pull_request.mergeable_statestringrequired
github.event.pull_request.merged_byobjectrequired

A GitHub user.

github.event.pull_request.merged_by.namestring or nulloptional
github.event.pull_request.merged_by.node_idstringrequired
github.event.pull_request.merged_by.avatar_urlstringrequired
github.event.pull_request.merged_by.gravatar_idstring or nullrequired
github.event.pull_request.merged_by.urlstringrequired
github.event.pull_request.merged_by.html_urlstringrequired
github.event.pull_request.merged_by.followers_urlstringrequired
github.event.pull_request.merged_by.following_urlstringrequired
github.event.pull_request.merged_by.gists_urlstringrequired
github.event.pull_request.merged_by.starred_urlstringrequired
github.event.pull_request.merged_by.subscriptions_urlstringrequired
github.event.pull_request.merged_by.organizations_urlstringrequired
github.event.pull_request.merged_by.repos_urlstringrequired
github.event.pull_request.merged_by.events_urlstringrequired
github.event.pull_request.merged_by.received_events_urlstringrequired
github.event.pull_request.merged_by.typestringrequired
github.event.pull_request.merged_by.site_adminbooleanrequired
github.event.pull_request.merged_by.starred_atstringoptional
github.event.pull_request.commentsintegerrequired
github.event.pull_request.review_commentsintegerrequired
github.event.pull_request.maintainer_can_modifybooleanrequired

Indicates whether maintainers can modify the pull request.

github.event.pull_request.commitsintegerrequired
github.event.pull_request.additionsintegerrequired
github.event.pull_request.deletionsintegerrequired
github.event.pull_request.changed_filesintegerrequired
github.event.pull_request.allow_auto_mergebooleanoptional

Whether to allow auto-merge for pull requests.

github.event.pull_request.allow_update_branchbooleanoptional

Whether to allow updating the pull request’s branch.

github.event.pull_request.delete_branch_on_mergebooleanoptional

Whether to delete head branches when pull requests are merged.

github.event.pull_request.merge_commit_messagePR_BODY, PR_TITLE, BLANKoptional

The default value for a merge commit message.

  • PR_TITLE - default to the pull request’s title.
  • PR_BODY - default to the pull request’s body.
  • BLANK - default to a blank commit message.
github.event.pull_request.merge_commit_titlePR_TITLE, MERGE_MESSAGEoptional

The default value for a merge commit title.

  • PR_TITLE - default to the pull request’s title.
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., “Merge pull request #123 from branch-name”).
github.event.pull_request.squash_merge_commit_messagePR_BODY, COMMIT_MESSAGES, BLANKoptional

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request’s body.
  • COMMIT_MESSAGES - default to the branch’s commit messages.
  • BLANK - default to a blank commit message.
github.event.pull_request.squash_merge_commit_titlePR_TITLE, COMMIT_OR_PR_TITLEoptional

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request’s title.
  • COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
github.event.pull_request.use_squash_pr_title_as_defaultbooleanoptional

Whether a squash merge commit can use the pull request title as default. This property has been deprecated. Please use squash_merge_commit_title instead.

github.event.senderobjectrequired

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.

fieldtyperequireddescription
github.event.actionconverted_to_draftrequired
github.event.installationobjectoptional

The GitHub App installation. Webhook payloads contain the installation property when the event is configured for and sent to a GitHub App. For more information, see “Using webhooks with GitHub Apps."

github.event.pull_request.userobjectrequired

A GitHub user.

github.event.pull_request.user.namestring or nulloptional
github.event.pull_request.user.node_idstringrequired
github.event.pull_request.user.avatar_urlstringrequired
github.event.pull_request.user.gravatar_idstring or nullrequired
github.event.pull_request.user.urlstringrequired
github.event.pull_request.user.html_urlstringrequired
github.event.pull_request.user.followers_urlstringrequired
github.event.pull_request.user.following_urlstringrequired
github.event.pull_request.user.gists_urlstringrequired
github.event.pull_request.user.starred_urlstringrequired
github.event.pull_request.user.subscriptions_urlstringrequired
github.event.pull_request.user.organizations_urlstringrequired
github.event.pull_request.user.repos_urlstringrequired
github.event.pull_request.user.events_urlstringrequired
github.event.pull_request.user.received_events_urlstringrequired
github.event.pull_request.user.typestringrequired
github.event.pull_request.user.site_adminbooleanrequired
github.event.pull_request.user.starred_atstringoptional
github.event.pull_request.milestoneobjectrequired

A collection of related issues and pull requests.

github.event.pull_request.milestone.creatorobjectrequired

A GitHub user.

github.event.pull_request.milestone.creator.namestring or nulloptional
github.event.pull_request.milestone.creator.node_idstringrequired
github.event.pull_request.milestone.creator.avatar_urlstringrequired
github.event.pull_request.milestone.creator.gravatar_idstring or nullrequired
github.event.pull_request.milestone.creator.urlstringrequired
github.event.pull_request.milestone.creator.html_urlstringrequired
github.event.pull_request.milestone.creator.followers_urlstringrequired
github.event.pull_request.milestone.creator.following_urlstringrequired
github.event.pull_request.milestone.creator.gists_urlstringrequired
github.event.pull_request.milestone.creator.starred_urlstringrequired
github.event.pull_request.milestone.creator.subscriptions_urlstringrequired
github.event.pull_request.milestone.creator.organizations_urlstringrequired
github.event.pull_request.milestone.creator.repos_urlstringrequired
github.event.pull_request.milestone.creator.events_urlstringrequired
github.event.pull_request.milestone.creator.received_events_urlstringrequired
github.event.pull_request.milestone.creator.typestringrequired
github.event.pull_request.milestone.creator.site_adminbooleanrequired
github.event.pull_request.milestone.creator.starred_atstringoptional
github.event.pull_request.active_lock_reasonstring or nulloptional
github.event.pull_request.assigneeobjectrequired

A GitHub user.

github.event.pull_request.assignee.namestring or nulloptional
github.event.pull_request.assignee.node_idstringrequired
github.event.pull_request.assignee.avatar_urlstringrequired
github.event.pull_request.assignee.gravatar_idstring or nullrequired
github.event.pull_request.assignee.urlstringrequired
github.event.pull_request.assignee.html_urlstringrequired
github.event.pull_request.assignee.followers_urlstringrequired
github.event.pull_request.assignee.following_urlstringrequired
github.event.pull_request.assignee.gists_urlstringrequired
github.event.pull_request.assignee.starred_urlstringrequired
github.event.pull_request.assignee.subscriptions_urlstringrequired
github.event.pull_request.assignee.organizations_urlstringrequired
github.event.pull_request.assignee.repos_urlstringrequired
github.event.pull_request.assignee.events_urlstringrequired
github.event.pull_request.assignee.received_events_urlstringrequired
github.event.pull_request.assignee.typestringrequired
github.event.pull_request.assignee.site_adminbooleanrequired
github.event.pull_request.assignee.starred_atstringoptional
github.event.pull_request.assigneesarray of objects or nulloptional
github.event.pull_request.assignees.namestring or nulloptional
github.event.pull_request.assignees.emailstring or nulloptional
github.event.pull_request.assignees.loginstringrequired
github.event.pull_request.assignees.idintegerrequired
github.event.pull_request.assignees.node_idstringrequired
github.event.pull_request.assignees.avatar_urlstringrequired
github.event.pull_request.assignees.gravatar_idstring or nullrequired
github.event.pull_request.assignees.urlstringrequired
github.event.pull_request.assignees.html_urlstringrequired
github.event.pull_request.assignees.followers_urlstringrequired
github.event.pull_request.assignees.following_urlstringrequired
github.event.pull_request.assignees.gists_urlstringrequired
github.event.pull_request.assignees.starred_urlstringrequired
github.event.pull_request.assignees.subscriptions_urlstringrequired
github.event.pull_request.assignees.organizations_urlstringrequired
github.event.pull_request.assignees.repos_urlstringrequired
github.event.pull_request.assignees.events_urlstringrequired
github.event.pull_request.assignees.received_events_urlstringrequired
github.event.pull_request.assignees.typestringrequired
github.event.pull_request.assignees.site_adminbooleanrequired
github.event.pull_request.assignees.starred_atstringoptional
github.event.pull_request.requested_reviewersarray of objects or nulloptional
github.event.pull_request.requested_reviewers.namestring or nulloptional
github.event.pull_request.requested_reviewers.emailstring or nulloptional
github.event.pull_request.requested_reviewers.loginstringrequired
github.event.pull_request.requested_reviewers.idintegerrequired
github.event.pull_request.requested_reviewers.node_idstringrequired
github.event.pull_request.requested_reviewers.avatar_urlstringrequired
github.event.pull_request.requested_reviewers.gravatar_idstring or nullrequired
github.event.pull_request.requested_reviewers.urlstringrequired
github.event.pull_request.requested_reviewers.html_urlstringrequired
github.event.pull_request.requested_reviewers.followers_urlstringrequired
github.event.pull_request.requested_reviewers.following_urlstringrequired
github.event.pull_request.requested_reviewers.gists_urlstringrequired
github.event.pull_request.requested_reviewers.starred_urlstringrequired
github.event.pull_request.requested_reviewers.subscriptions_urlstringrequired
github.event.pull_request.requested_reviewers.organizations_urlstringrequired
github.event.pull_request.requested_reviewers.repos_urlstringrequired
github.event.pull_request.requested_reviewers.events_urlstringrequired
github.event.pull_request.requested_reviewers.received_events_urlstringrequired
github.event.pull_request.requested_reviewers.typestringrequired
github.event.pull_request.requested_reviewers.site_adminbooleanrequired
github.event.pull_request.requested_reviewers.starred_atstringoptional
github.event.pull_request.requested_teamsarray of objects or nulloptional
github.event.pull_request.requested_teams.node_idstringrequired
github.event.pull_request.requested_teams.urlstringrequired

URL for the team

github.event.pull_request.requested_teams.members_urlstringrequired
github.event.pull_request.requested_teams.descriptionstring or nullrequired

Description of the team

github.event.pull_request.requested_teams.permissionstringrequired

Permission that the team will have for its repositories

github.event.pull_request.requested_teams.privacystringoptional

The level of privacy this team should have

github.event.pull_request.requested_teams.notification_settingstringoptional

The notification setting the team has set

github.event.pull_request.requested_teams.html_urlstringrequired
github.event.pull_request.requested_teams.repositories_urlstringrequired
github.event.pull_request.requested_teams.slugstringrequired
github.event.pull_request.requested_teams.ldap_dnstringoptional

Distinguished Name (DN) that team maps to within LDAP environment

github.event.pull_request.head.labelstringrequired
github.event.pull_request.head.repoobject or nullrequired
github.event.pull_request.head.repo.ownerobjectrequired
github.event.pull_request.head.repo.owner.avatar_urlstringrequired
github.event.pull_request.head.repo.owner.events_urlstringrequired
github.event.pull_request.head.repo.owner.followers_urlstringrequired
github.event.pull_request.head.repo.owner.following_urlstringrequired
github.event.pull_request.head.repo.owner.gists_urlstringrequired
github.event.pull_request.head.repo.owner.gravatar_idstring or nullrequired
github.event.pull_request.head.repo.owner.html_urlstringrequired
github.event.pull_request.head.repo.owner.node_idstringrequired
github.event.pull_request.head.repo.owner.organizations_urlstringrequired
github.event.pull_request.head.repo.owner.received_events_urlstringrequired
github.event.pull_request.head.repo.owner.repos_urlstringrequired
github.event.pull_request.head.repo.owner.site_adminbooleanrequired
github.event.pull_request.head.repo.owner.starred_urlstringrequired
github.event.pull_request.head.repo.owner.subscriptions_urlstringrequired
github.event.pull_request.head.repo.owner.typestringrequired
github.event.pull_request.head.repo.owner.urlstringrequired
github.event.pull_request.head.repo.disabledbooleanrequired
github.event.pull_request.head.repo.visibilitystringoptional

The repository visibility: public, private, or internal.

github.event.pull_request.head.repo.temp_clone_tokenstringoptional
github.event.pull_request.head.repo.license.spdx_idstring or nullrequired
github.event.pull_request.head.repo.pushed_atstringrequired
github.event.pull_request.head.repo.topicsarray of stringsoptional
github.event.pull_request.head.repo.created_atstringrequired
github.event.pull_request.head.userobjectrequired
github.event.pull_request.head.user.avatar_urlstringrequired
github.event.pull_request.head.user.events_urlstringrequired
github.event.pull_request.head.user.followers_urlstringrequired
github.event.pull_request.head.user.following_urlstringrequired
github.event.pull_request.head.user.gists_urlstringrequired
github.event.pull_request.head.user.gravatar_idstring or nullrequired
github.event.pull_request.head.user.html_urlstringrequired
github.event.pull_request.head.user.node_idstringrequired
github.event.pull_request.head.user.organizations_urlstringrequired
github.event.pull_request.head.user.received_events_urlstringrequired
github.event.pull_request.head.user.repos_urlstringrequired
github.event.pull_request.head.user.site_adminbooleanrequired
github.event.pull_request.head.user.starred_urlstringrequired
github.event.pull_request.head.user.subscriptions_urlstringrequired
github.event.pull_request.head.user.typestringrequired
github.event.pull_request.head.user.urlstringrequired
github.event.pull_request.base.labelstringrequired
github.event.pull_request.base.repo.ownerobjectrequired
github.event.pull_request.base.repo.owner.avatar_urlstringrequired
github.event.pull_request.base.repo.owner.events_urlstringrequired
github.event.pull_request.base.repo.owner.followers_urlstringrequired
github.event.pull_request.base.repo.owner.following_urlstringrequired
github.event.pull_request.base.repo.owner.gists_urlstringrequired
github.event.pull_request.base.repo.owner.gravatar_idstring or nullrequired
github.event.pull_request.base.repo.owner.html_urlstringrequired
github.event.pull_request.base.repo.owner.node_idstringrequired
github.event.pull_request.base.repo.owner.organizations_urlstringrequired
github.event.pull_request.base.repo.owner.received_events_urlstringrequired
github.event.pull_request.base.repo.owner.repos_urlstringrequired
github.event.pull_request.base.repo.owner.site_adminbooleanrequired
github.event.pull_request.base.repo.owner.starred_urlstringrequired
github.event.pull_request.base.repo.owner.subscriptions_urlstringrequired
github.event.pull_request.base.repo.owner.typestringrequired
github.event.pull_request.base.repo.owner.urlstringrequired
github.event.pull_request.base.repo.disabledbooleanrequired
github.event.pull_request.base.repo.visibilitystringoptional

The repository visibility: public, private, or internal.

github.event.pull_request.base.repo.temp_clone_tokenstringoptional
github.event.pull_request.base.repo.licenseobjectrequired

License Simple

github.event.pull_request.base.repo.license.spdx_idstring or nullrequired
github.event.pull_request.base.repo.license.html_urlstringoptional
github.event.pull_request.base.repo.pushed_atstringrequired
github.event.pull_request.base.repo.topicsarray of stringsoptional
github.event.pull_request.base.repo.created_atstringrequired
github.event.pull_request.base.userobjectrequired
github.event.pull_request.base.user.avatar_urlstringrequired
github.event.pull_request.base.user.events_urlstringrequired
github.event.pull_request.base.user.followers_urlstringrequired
github.event.pull_request.base.user.following_urlstringrequired
github.event.pull_request.base.user.gists_urlstringrequired
github.event.pull_request.base.user.gravatar_idstring or nullrequired
github.event.pull_request.base.user.html_urlstringrequired
github.event.pull_request.base.user.node_idstringrequired
github.event.pull_request.base.user.organizations_urlstringrequired
github.event.pull_request.base.user.received_events_urlstringrequired
github.event.pull_request.base.user.repos_urlstringrequired
github.event.pull_request.base.user.site_adminbooleanrequired
github.event.pull_request.base.user.starred_urlstringrequired
github.event.pull_request.base.user.subscriptions_urlstringrequired
github.event.pull_request.base.user.typestringrequired
github.event.pull_request.base.user.urlstringrequired
github.event.pull_request.auto_merge.enabled_byobjectrequired

A GitHub user.

github.event.pull_request.auto_merge.enabled_by.namestring or nulloptional
github.event.pull_request.auto_merge.enabled_by.node_idstringrequired
github.event.pull_request.auto_merge.enabled_by.avatar_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.gravatar_idstring or nullrequired
github.event.pull_request.auto_merge.enabled_by.urlstringrequired
github.event.pull_request.auto_merge.enabled_by.html_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.followers_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.following_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.gists_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.starred_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.subscriptions_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.organizations_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.repos_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.events_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.received_events_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.typestringrequired
github.event.pull_request.auto_merge.enabled_by.site_adminbooleanrequired
github.event.pull_request.auto_merge.enabled_by.starred_atstringoptional
github.event.pull_request.auto_merge.commit_titlestringrequired

Title for the merge commit message.

github.event.pull_request.auto_merge.commit_messagestringrequired

Commit message for the merge commit.

github.event.pull_request.draftbooleanoptional

Indicates whether or not the pull request is a draft.

github.event.pull_request.mergedbooleanrequired
github.event.pull_request.mergeableboolean or nullrequired
github.event.pull_request.mergeable_statestringrequired
github.event.pull_request.merged_byobjectrequired

A GitHub user.

github.event.pull_request.merged_by.namestring or nulloptional
github.event.pull_request.merged_by.node_idstringrequired
github.event.pull_request.merged_by.avatar_urlstringrequired
github.event.pull_request.merged_by.gravatar_idstring or nullrequired
github.event.pull_request.merged_by.urlstringrequired
github.event.pull_request.merged_by.html_urlstringrequired
github.event.pull_request.merged_by.followers_urlstringrequired
github.event.pull_request.merged_by.following_urlstringrequired
github.event.pull_request.merged_by.gists_urlstringrequired
github.event.pull_request.merged_by.starred_urlstringrequired
github.event.pull_request.merged_by.subscriptions_urlstringrequired
github.event.pull_request.merged_by.organizations_urlstringrequired
github.event.pull_request.merged_by.repos_urlstringrequired
github.event.pull_request.merged_by.events_urlstringrequired
github.event.pull_request.merged_by.received_events_urlstringrequired
github.event.pull_request.merged_by.typestringrequired
github.event.pull_request.merged_by.site_adminbooleanrequired
github.event.pull_request.merged_by.starred_atstringoptional
github.event.pull_request.commentsintegerrequired
github.event.pull_request.review_commentsintegerrequired
github.event.pull_request.maintainer_can_modifybooleanrequired

Indicates whether maintainers can modify the pull request.

github.event.pull_request.commitsintegerrequired
github.event.pull_request.additionsintegerrequired
github.event.pull_request.deletionsintegerrequired
github.event.pull_request.changed_filesintegerrequired
github.event.pull_request.allow_auto_mergebooleanoptional

Whether to allow auto-merge for pull requests.

github.event.pull_request.allow_update_branchbooleanoptional

Whether to allow updating the pull request’s branch.

github.event.pull_request.delete_branch_on_mergebooleanoptional

Whether to delete head branches when pull requests are merged.

github.event.pull_request.merge_commit_messagePR_BODY, PR_TITLE, BLANKoptional

The default value for a merge commit message.

  • PR_TITLE - default to the pull request’s title.
  • PR_BODY - default to the pull request’s body.
  • BLANK - default to a blank commit message.
github.event.pull_request.merge_commit_titlePR_TITLE, MERGE_MESSAGEoptional

The default value for a merge commit title.

  • PR_TITLE - default to the pull request’s title.
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., “Merge pull request #123 from branch-name”).
github.event.pull_request.squash_merge_commit_messagePR_BODY, COMMIT_MESSAGES, BLANKoptional

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request’s body.
  • COMMIT_MESSAGES - default to the branch’s commit messages.
  • BLANK - default to a blank commit message.
github.event.pull_request.squash_merge_commit_titlePR_TITLE, COMMIT_OR_PR_TITLEoptional

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request’s title.
  • COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
github.event.pull_request.use_squash_pr_title_as_defaultbooleanoptional

Whether a squash merge commit can use the pull request title as default. This property has been deprecated. Please use squash_merge_commit_title instead.

github.event.senderobjectrequired

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.

fieldtyperequireddescription
github.event.actiondemilestonedrequired
github.event.milestoneobjectoptional

A collection of related issues and pull requests.

github.event.milestone.urlstringrequired
github.event.milestone.html_urlstringrequired
github.event.milestone.labels_urlstringrequired
github.event.milestone.idintegerrequired
github.event.milestone.node_idstringrequired
github.event.milestone.numberintegerrequired

The number of the milestone.

github.event.milestone.stateopen, closedrequired

The state of the milestone.

github.event.milestone.titlestringrequired

The title of the milestone.

github.event.milestone.descriptionstring or nullrequired
github.event.milestone.creatorobjectrequired

A GitHub user.

github.event.milestone.creator.namestring or nulloptional
github.event.milestone.creator.emailstring or nulloptional
github.event.milestone.creator.loginstringrequired
github.event.milestone.creator.idintegerrequired
github.event.milestone.creator.node_idstringrequired
github.event.milestone.creator.avatar_urlstringrequired
github.event.milestone.creator.gravatar_idstring or nullrequired
github.event.milestone.creator.urlstringrequired
github.event.milestone.creator.html_urlstringrequired
github.event.milestone.creator.followers_urlstringrequired
github.event.milestone.creator.following_urlstringrequired
github.event.milestone.creator.gists_urlstringrequired
github.event.milestone.creator.starred_urlstringrequired
github.event.milestone.creator.subscriptions_urlstringrequired
github.event.milestone.creator.organizations_urlstringrequired
github.event.milestone.creator.repos_urlstringrequired
github.event.milestone.creator.events_urlstringrequired
github.event.milestone.creator.received_events_urlstringrequired
github.event.milestone.creator.typestringrequired
github.event.milestone.creator.site_adminbooleanrequired
github.event.milestone.creator.starred_atstringoptional
github.event.milestone.open_issuesintegerrequired
github.event.milestone.closed_issuesintegerrequired
github.event.milestone.created_atstringrequired
github.event.milestone.updated_atstringrequired
github.event.milestone.closed_atstring or nullrequired
github.event.milestone.due_onstring or nullrequired
github.event.pull_request.active_lock_reasonresolved, off-topic, too heated, spam, Nonerequired
github.event.pull_request.additionsintegeroptional
github.event.pull_request.assigneeobject or nullrequired
github.event.pull_request.assignee.avatar_urlstringoptional
github.event.pull_request.assignee.deletedbooleanoptional
github.event.pull_request.assignee.events_urlstringoptional
github.event.pull_request.assignee.followers_urlstringoptional
github.event.pull_request.assignee.following_urlstringoptional
github.event.pull_request.assignee.gists_urlstringoptional
github.event.pull_request.assignee.gravatar_idstringoptional
github.event.pull_request.assignee.html_urlstringoptional
github.event.pull_request.assignee.namestringoptional
github.event.pull_request.assignee.node_idstringoptional
github.event.pull_request.assignee.organizations_urlstringoptional
github.event.pull_request.assignee.received_events_urlstringoptional
github.event.pull_request.assignee.repos_urlstringoptional
github.event.pull_request.assignee.site_adminbooleanoptional
github.event.pull_request.assignee.starred_urlstringoptional
github.event.pull_request.assignee.subscriptions_urlstringoptional
github.event.pull_request.assignee.typeBot, User, Organization, Mannequinoptional
github.event.pull_request.assignee.urlstringoptional
github.event.pull_request.assigneesarray of object,nullsrequired
github.event.pull_request.auto_merge.commit_messagestring or nullrequired

Commit message for the merge commit.

github.event.pull_request.auto_merge.commit_titlestring or nullrequired

Title for the merge commit message.

github.event.pull_request.auto_merge.enabled_byobject or nullrequired
github.event.pull_request.auto_merge.enabled_by.avatar_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.deletedbooleanoptional
github.event.pull_request.auto_merge.enabled_by.events_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.followers_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.following_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.gists_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.gravatar_idstringoptional
github.event.pull_request.auto_merge.enabled_by.html_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.namestringoptional
github.event.pull_request.auto_merge.enabled_by.node_idstringoptional
github.event.pull_request.auto_merge.enabled_by.organizations_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.received_events_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.repos_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.site_adminbooleanoptional
github.event.pull_request.auto_merge.enabled_by.starred_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.subscriptions_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.typeBot, User, Organizationoptional
github.event.pull_request.auto_merge.enabled_by.urlstringoptional
github.event.pull_request.base.labelstringrequired
github.event.pull_request.base.repo.allow_auto_mergebooleanoptional

Whether to allow auto-merge for pull requests.

github.event.pull_request.base.repo.allow_update_branchbooleanoptional
github.event.pull_request.base.repo.created_atinteger or stringrequired
github.event.pull_request.base.repo.delete_branch_on_mergebooleanoptional

Whether to delete head branches when pull requests are merged

github.event.pull_request.base.repo.disabledbooleanoptional

Returns whether or not this repository is disabled.

github.event.pull_request.base.repo.licenseobject or nullrequired
github.event.pull_request.base.repo.license.spdx_idstringrequired
github.event.pull_request.base.repo.merge_commit_messagePR_BODY, PR_TITLE, BLANKoptional

The default value for a merge commit message.

  • PR_TITLE - default to the pull request’s title.
  • PR_BODY - default to the pull request’s body.
  • BLANK - default to a blank commit message.
github.event.pull_request.base.repo.merge_commit_titlePR_TITLE, MERGE_MESSAGEoptional

The default value for a merge commit title.

  • PR_TITLE - default to the pull request’s title.
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
github.event.pull_request.base.repo.organizationstringoptional
github.event.pull_request.base.repo.ownerobject or nullrequired
github.event.pull_request.base.repo.owner.avatar_urlstringoptional
github.event.pull_request.base.repo.owner.deletedbooleanoptional
github.event.pull_request.base.repo.owner.emailstring or nulloptional
github.event.pull_request.base.repo.owner.events_urlstringoptional
github.event.pull_request.base.repo.owner.followers_urlstringoptional
github.event.pull_request.base.repo.owner.following_urlstringoptional
github.event.pull_request.base.repo.owner.gists_urlstringoptional
github.event.pull_request.base.repo.owner.gravatar_idstringoptional
github.event.pull_request.base.repo.owner.html_urlstringoptional
github.event.pull_request.base.repo.owner.namestringoptional
github.event.pull_request.base.repo.owner.node_idstringoptional
github.event.pull_request.base.repo.owner.organizations_urlstringoptional
github.event.pull_request.base.repo.owner.received_events_urlstringoptional
github.event.pull_request.base.repo.owner.repos_urlstringoptional
github.event.pull_request.base.repo.owner.site_adminbooleanoptional
github.event.pull_request.base.repo.owner.starred_urlstringoptional
github.event.pull_request.base.repo.owner.subscriptions_urlstringoptional
github.event.pull_request.base.repo.owner.typeBot, User, Organizationoptional
github.event.pull_request.base.repo.owner.urlstringoptional
github.event.pull_request.base.repo.publicbooleanoptional
github.event.pull_request.base.repo.pushed_atnull or integer or stringrequired
github.event.pull_request.base.repo.role_namestring or nulloptional
github.event.pull_request.base.repo.squash_merge_commit_messagePR_BODY, COMMIT_MESSAGES, BLANKoptional

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request’s body.
  • COMMIT_MESSAGES - default to the branch’s commit messages.
  • BLANK - default to a blank commit message.
github.event.pull_request.base.repo.squash_merge_commit_titlePR_TITLE, COMMIT_OR_PR_TITLEoptional

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request’s title.
  • COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
github.event.pull_request.base.repo.stargazersintegeroptional
github.event.pull_request.base.repo.topicsarray of stringsrequired
github.event.pull_request.base.repo.use_squash_pr_title_as_defaultbooleanoptional

Whether a squash merge commit can use the pull request title as default.

github.event.pull_request.base.repo.visibilitypublic, private, internalrequired
github.event.pull_request.base.userobject or nullrequired
github.event.pull_request.base.user.avatar_urlstringoptional
github.event.pull_request.base.user.deletedbooleanoptional
github.event.pull_request.base.user.emailstring or nulloptional
github.event.pull_request.base.user.events_urlstringoptional
github.event.pull_request.base.user.followers_urlstringoptional
github.event.pull_request.base.user.following_urlstringoptional
github.event.pull_request.base.user.gists_urlstringoptional
github.event.pull_request.base.user.gravatar_idstringoptional
github.event.pull_request.base.user.html_urlstringoptional
github.event.pull_request.base.user.namestringoptional
github.event.pull_request.base.user.node_idstringoptional
github.event.pull_request.base.user.organizations_urlstringoptional
github.event.pull_request.base.user.received_events_urlstringoptional
github.event.pull_request.base.user.repos_urlstringoptional
github.event.pull_request.base.user.site_adminbooleanoptional
github.event.pull_request.base.user.starred_urlstringoptional
github.event.pull_request.base.user.subscriptions_urlstringoptional
github.event.pull_request.base.user.typeBot, User, Organizationoptional
github.event.pull_request.base.user.urlstringoptional
github.event.pull_request.changed_filesintegeroptional
github.event.pull_request.commentsintegeroptional
github.event.pull_request.commitsintegeroptional
github.event.pull_request.deletionsintegeroptional
github.event.pull_request.draftbooleanrequired

Indicates whether or not the pull request is a draft.

github.event.pull_request.head.labelstringrequired
github.event.pull_request.head.repoobjectrequired

A git repository

github.event.pull_request.head.repo.allow_auto_mergebooleanoptional

Whether to allow auto-merge for pull requests.

github.event.pull_request.head.repo.allow_update_branchbooleanoptional
github.event.pull_request.head.repo.created_atinteger or stringrequired
github.event.pull_request.head.repo.delete_branch_on_mergebooleanoptional

Whether to delete head branches when pull requests are merged

github.event.pull_request.head.repo.disabledbooleanoptional

Returns whether or not this repository is disabled.

github.event.pull_request.head.repo.license.spdx_idstringrequired
github.event.pull_request.head.repo.merge_commit_messagePR_BODY, PR_TITLE, BLANKoptional

The default value for a merge commit message.

  • PR_TITLE - default to the pull request’s title.
  • PR_BODY - default to the pull request’s body.
  • BLANK - default to a blank commit message.
github.event.pull_request.head.repo.merge_commit_titlePR_TITLE, MERGE_MESSAGEoptional

The default value for a merge commit title.

  • PR_TITLE - default to the pull request’s title.
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
github.event.pull_request.head.repo.organizationstringoptional
github.event.pull_request.head.repo.ownerobject or nullrequired
github.event.pull_request.head.repo.owner.avatar_urlstringoptional
github.event.pull_request.head.repo.owner.deletedbooleanoptional
github.event.pull_request.head.repo.owner.emailstring or nulloptional
github.event.pull_request.head.repo.owner.events_urlstringoptional
github.event.pull_request.head.repo.owner.followers_urlstringoptional
github.event.pull_request.head.repo.owner.following_urlstringoptional
github.event.pull_request.head.repo.owner.gists_urlstringoptional
github.event.pull_request.head.repo.owner.gravatar_idstringoptional
github.event.pull_request.head.repo.owner.html_urlstringoptional
github.event.pull_request.head.repo.owner.namestringoptional
github.event.pull_request.head.repo.owner.node_idstringoptional
github.event.pull_request.head.repo.owner.organizations_urlstringoptional
github.event.pull_request.head.repo.owner.received_events_urlstringoptional
github.event.pull_request.head.repo.owner.repos_urlstringoptional
github.event.pull_request.head.repo.owner.site_adminbooleanoptional
github.event.pull_request.head.repo.owner.starred_urlstringoptional
github.event.pull_request.head.repo.owner.subscriptions_urlstringoptional
github.event.pull_request.head.repo.owner.typeBot, User, Organizationoptional
github.event.pull_request.head.repo.owner.urlstringoptional
github.event.pull_request.head.repo.publicbooleanoptional
github.event.pull_request.head.repo.pushed_atnull or integer or stringrequired
github.event.pull_request.head.repo.role_namestring or nulloptional
github.event.pull_request.head.repo.squash_merge_commit_messagePR_BODY, COMMIT_MESSAGES, BLANKoptional

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request’s body.
  • COMMIT_MESSAGES - default to the branch’s commit messages.
  • BLANK - default to a blank commit message.
github.event.pull_request.head.repo.squash_merge_commit_titlePR_TITLE, COMMIT_OR_PR_TITLEoptional

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request’s title.
  • COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
github.event.pull_request.head.repo.stargazersintegeroptional
github.event.pull_request.head.repo.topicsarray of stringsrequired
github.event.pull_request.head.repo.use_squash_pr_title_as_defaultbooleanoptional

Whether a squash merge commit can use the pull request title as default.

github.event.pull_request.head.repo.visibilitypublic, private, internalrequired
github.event.pull_request.head.userobject or nullrequired
github.event.pull_request.head.user.avatar_urlstringoptional
github.event.pull_request.head.user.deletedbooleanoptional
github.event.pull_request.head.user.emailstring or nulloptional
github.event.pull_request.head.user.events_urlstringoptional
github.event.pull_request.head.user.followers_urlstringoptional
github.event.pull_request.head.user.following_urlstringoptional
github.event.pull_request.head.user.gists_urlstringoptional
github.event.pull_request.head.user.gravatar_idstringoptional
github.event.pull_request.head.user.html_urlstringoptional
github.event.pull_request.head.user.namestringoptional
github.event.pull_request.head.user.node_idstringoptional
github.event.pull_request.head.user.organizations_urlstringoptional
github.event.pull_request.head.user.received_events_urlstringoptional
github.event.pull_request.head.user.repos_urlstringoptional
github.event.pull_request.head.user.site_adminbooleanoptional
github.event.pull_request.head.user.starred_urlstringoptional
github.event.pull_request.head.user.subscriptions_urlstringoptional
github.event.pull_request.head.user.typeBot, User, Organizationoptional
github.event.pull_request.head.user.urlstringoptional
github.event.pull_request.maintainer_can_modifybooleanoptional

Indicates whether maintainers can modify the pull request.

github.event.pull_request.mergeableboolean or nulloptional
github.event.pull_request.mergeable_statestringoptional
github.event.pull_request.mergedboolean or nulloptional
github.event.pull_request.merged_byobject or nulloptional
github.event.pull_request.merged_by.avatar_urlstringoptional
github.event.pull_request.merged_by.deletedbooleanoptional
github.event.pull_request.merged_by.events_urlstringoptional
github.event.pull_request.merged_by.followers_urlstringoptional
github.event.pull_request.merged_by.following_urlstringoptional
github.event.pull_request.merged_by.gists_urlstringoptional
github.event.pull_request.merged_by.gravatar_idstringoptional
github.event.pull_request.merged_by.html_urlstringoptional
github.event.pull_request.merged_by.namestringoptional
github.event.pull_request.merged_by.node_idstringoptional
github.event.pull_request.merged_by.organizations_urlstringoptional
github.event.pull_request.merged_by.received_events_urlstringoptional
github.event.pull_request.merged_by.repos_urlstringoptional
github.event.pull_request.merged_by.site_adminbooleanoptional
github.event.pull_request.merged_by.starred_urlstringoptional
github.event.pull_request.merged_by.subscriptions_urlstringoptional
github.event.pull_request.merged_by.typeBot, User, Organization, Mannequinoptional
github.event.pull_request.merged_by.urlstringoptional
github.event.pull_request.milestoneobject or nullrequired

A collection of related issues and pull requests.

github.event.pull_request.milestone.creatorobject or nullrequired
github.event.pull_request.milestone.creator.avatar_urlstringoptional
github.event.pull_request.milestone.creator.deletedbooleanoptional
github.event.pull_request.milestone.creator.events_urlstringoptional
github.event.pull_request.milestone.creator.followers_urlstringoptional
github.event.pull_request.milestone.creator.following_urlstringoptional
github.event.pull_request.milestone.creator.gists_urlstringoptional
github.event.pull_request.milestone.creator.gravatar_idstringoptional
github.event.pull_request.milestone.creator.html_urlstringoptional
github.event.pull_request.milestone.creator.namestringoptional
github.event.pull_request.milestone.creator.node_idstringoptional
github.event.pull_request.milestone.creator.organizations_urlstringoptional
github.event.pull_request.milestone.creator.received_events_urlstringoptional
github.event.pull_request.milestone.creator.repos_urlstringoptional
github.event.pull_request.milestone.creator.site_adminbooleanoptional
github.event.pull_request.milestone.creator.starred_urlstringoptional
github.event.pull_request.milestone.creator.subscriptions_urlstringoptional
github.event.pull_request.milestone.creator.typeBot, User, Organization, Mannequinoptional
github.event.pull_request.milestone.creator.urlstringoptional
github.event.pull_request.requested_reviewersarrayrequired
github.event.pull_request.requested_teamsarray of objectsrequired
github.event.pull_request.requested_teams.deletedbooleanoptional
github.event.pull_request.requested_teams.descriptionstring or nulloptional

Description of the team

github.event.pull_request.requested_teams.html_urlstringoptional
github.event.pull_request.requested_teams.members_urlstringoptional
github.event.pull_request.requested_teams.node_idstringoptional
github.event.pull_request.requested_teams.parentobject or nulloptional
github.event.pull_request.requested_teams.parent.descriptionstring or nullrequired

Description of the team

github.event.pull_request.requested_teams.parent.html_urlstringrequired
github.event.pull_request.requested_teams.parent.idintegerrequired

Unique identifier of the team

github.event.pull_request.requested_teams.parent.members_urlstringrequired
github.event.pull_request.requested_teams.parent.namestringrequired

Name of the team

github.event.pull_request.requested_teams.parent.node_idstringrequired
github.event.pull_request.requested_teams.parent.permissionstringrequired

Permission that the team will have for its repositories

github.event.pull_request.requested_teams.parent.privacyopen, closed, secretrequired
github.event.pull_request.requested_teams.parent.repositories_urlstringrequired
github.event.pull_request.requested_teams.parent.slugstringrequired
github.event.pull_request.requested_teams.parent.urlstringrequired

URL for the team

github.event.pull_request.requested_teams.permissionstringoptional

Permission that the team will have for its repositories

github.event.pull_request.requested_teams.privacyopen, closed, secretoptional
github.event.pull_request.requested_teams.repositories_urlstringoptional
github.event.pull_request.requested_teams.slugstringoptional
github.event.pull_request.requested_teams.urlstringoptional

URL for the team

github.event.pull_request.review_commentsintegeroptional
github.event.pull_request.userobject or nullrequired
github.event.pull_request.user.avatar_urlstringoptional
github.event.pull_request.user.deletedbooleanoptional
github.event.pull_request.user.events_urlstringoptional
github.event.pull_request.user.followers_urlstringoptional
github.event.pull_request.user.following_urlstringoptional
github.event.pull_request.user.gists_urlstringoptional
github.event.pull_request.user.gravatar_idstringoptional
github.event.pull_request.user.html_urlstringoptional
github.event.pull_request.user.namestringoptional
github.event.pull_request.user.node_idstringoptional
github.event.pull_request.user.organizations_urlstringoptional
github.event.pull_request.user.received_events_urlstringoptional
github.event.pull_request.user.repos_urlstringoptional
github.event.pull_request.user.site_adminbooleanoptional
github.event.pull_request.user.starred_urlstringoptional
github.event.pull_request.user.subscriptions_urlstringoptional
github.event.pull_request.user.typeBot, User, Organization, Mannequinoptional
github.event.pull_request.user.urlstringoptional
github.event.senderobjectoptional

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.

fieldtyperequireddescription
github.event.actiondequeuedrequired
github.event.installationobjectoptional

The GitHub App installation. Webhook payloads contain the installation property when the event is configured for and sent to a GitHub App. For more information, see “Using webhooks with GitHub Apps."

github.event.pull_request.active_lock_reasonresolved, off-topic, too heated, spam, Nonerequired
github.event.pull_request.additionsintegeroptional
github.event.pull_request.assigneeobject or nullrequired
github.event.pull_request.assignee.avatar_urlstringoptional
github.event.pull_request.assignee.deletedbooleanoptional
github.event.pull_request.assignee.events_urlstringoptional
github.event.pull_request.assignee.followers_urlstringoptional
github.event.pull_request.assignee.following_urlstringoptional
github.event.pull_request.assignee.gists_urlstringoptional
github.event.pull_request.assignee.gravatar_idstringoptional
github.event.pull_request.assignee.html_urlstringoptional
github.event.pull_request.assignee.namestringoptional
github.event.pull_request.assignee.node_idstringoptional
github.event.pull_request.assignee.organizations_urlstringoptional
github.event.pull_request.assignee.received_events_urlstringoptional
github.event.pull_request.assignee.repos_urlstringoptional
github.event.pull_request.assignee.site_adminbooleanoptional
github.event.pull_request.assignee.starred_urlstringoptional
github.event.pull_request.assignee.subscriptions_urlstringoptional
github.event.pull_request.assignee.typeBot, User, Organizationoptional
github.event.pull_request.assignee.urlstringoptional
github.event.pull_request.assigneesarray of object,nullsrequired
github.event.pull_request.auto_merge.commit_messagestring or nullrequired

Commit message for the merge commit.

github.event.pull_request.auto_merge.commit_titlestring or nullrequired

Title for the merge commit message.

github.event.pull_request.auto_merge.enabled_byobject or nullrequired
github.event.pull_request.auto_merge.enabled_by.avatar_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.deletedbooleanoptional
github.event.pull_request.auto_merge.enabled_by.events_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.followers_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.following_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.gists_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.gravatar_idstringoptional
github.event.pull_request.auto_merge.enabled_by.html_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.namestringoptional
github.event.pull_request.auto_merge.enabled_by.node_idstringoptional
github.event.pull_request.auto_merge.enabled_by.organizations_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.received_events_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.repos_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.site_adminbooleanoptional
github.event.pull_request.auto_merge.enabled_by.starred_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.subscriptions_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.typeBot, User, Organizationoptional
github.event.pull_request.auto_merge.enabled_by.urlstringoptional
github.event.pull_request.base.labelstringrequired
github.event.pull_request.base.repo.allow_auto_mergebooleanoptional

Whether to allow auto-merge for pull requests.

github.event.pull_request.base.repo.allow_update_branchbooleanoptional
github.event.pull_request.base.repo.created_atinteger or stringrequired
github.event.pull_request.base.repo.delete_branch_on_mergebooleanoptional

Whether to delete head branches when pull requests are merged

github.event.pull_request.base.repo.disabledbooleanoptional

Returns whether or not this repository is disabled.

github.event.pull_request.base.repo.licenseobject or nullrequired
github.event.pull_request.base.repo.license.spdx_idstringrequired
github.event.pull_request.base.repo.merge_commit_messagePR_BODY, PR_TITLE, BLANKoptional

The default value for a merge commit message.

  • PR_TITLE - default to the pull request’s title.
  • PR_BODY - default to the pull request’s body.
  • BLANK - default to a blank commit message.
github.event.pull_request.base.repo.merge_commit_titlePR_TITLE, MERGE_MESSAGEoptional

The default value for a merge commit title.

  • PR_TITLE - default to the pull request’s title.
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
github.event.pull_request.base.repo.organizationstringoptional
github.event.pull_request.base.repo.ownerobject or nullrequired
github.event.pull_request.base.repo.owner.avatar_urlstringoptional
github.event.pull_request.base.repo.owner.deletedbooleanoptional
github.event.pull_request.base.repo.owner.emailstring or nulloptional
github.event.pull_request.base.repo.owner.events_urlstringoptional
github.event.pull_request.base.repo.owner.followers_urlstringoptional
github.event.pull_request.base.repo.owner.following_urlstringoptional
github.event.pull_request.base.repo.owner.gists_urlstringoptional
github.event.pull_request.base.repo.owner.gravatar_idstringoptional
github.event.pull_request.base.repo.owner.html_urlstringoptional
github.event.pull_request.base.repo.owner.namestringoptional
github.event.pull_request.base.repo.owner.node_idstringoptional
github.event.pull_request.base.repo.owner.organizations_urlstringoptional
github.event.pull_request.base.repo.owner.received_events_urlstringoptional
github.event.pull_request.base.repo.owner.repos_urlstringoptional
github.event.pull_request.base.repo.owner.site_adminbooleanoptional
github.event.pull_request.base.repo.owner.starred_urlstringoptional
github.event.pull_request.base.repo.owner.subscriptions_urlstringoptional
github.event.pull_request.base.repo.owner.typeBot, User, Organizationoptional
github.event.pull_request.base.repo.owner.urlstringoptional
github.event.pull_request.base.repo.publicbooleanoptional
github.event.pull_request.base.repo.pushed_atnull or integer or stringrequired
github.event.pull_request.base.repo.role_namestring or nulloptional
github.event.pull_request.base.repo.squash_merge_commit_messagePR_BODY, COMMIT_MESSAGES, BLANKoptional

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request’s body.
  • COMMIT_MESSAGES - default to the branch’s commit messages.
  • BLANK - default to a blank commit message.
github.event.pull_request.base.repo.squash_merge_commit_titlePR_TITLE, COMMIT_OR_PR_TITLEoptional

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request’s title.
  • COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
github.event.pull_request.base.repo.stargazersintegeroptional
github.event.pull_request.base.repo.topicsarray of stringsrequired
github.event.pull_request.base.repo.use_squash_pr_title_as_defaultbooleanoptional

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

github.event.pull_request.base.repo.visibilitypublic, private, internalrequired
github.event.pull_request.base.userobject or nullrequired
github.event.pull_request.base.user.avatar_urlstringoptional
github.event.pull_request.base.user.deletedbooleanoptional
github.event.pull_request.base.user.emailstring or nulloptional
github.event.pull_request.base.user.events_urlstringoptional
github.event.pull_request.base.user.followers_urlstringoptional
github.event.pull_request.base.user.following_urlstringoptional
github.event.pull_request.base.user.gists_urlstringoptional
github.event.pull_request.base.user.gravatar_idstringoptional
github.event.pull_request.base.user.html_urlstringoptional
github.event.pull_request.base.user.namestringoptional
github.event.pull_request.base.user.node_idstringoptional
github.event.pull_request.base.user.organizations_urlstringoptional
github.event.pull_request.base.user.received_events_urlstringoptional
github.event.pull_request.base.user.repos_urlstringoptional
github.event.pull_request.base.user.site_adminbooleanoptional
github.event.pull_request.base.user.starred_urlstringoptional
github.event.pull_request.base.user.subscriptions_urlstringoptional
github.event.pull_request.base.user.typeBot, User, Organizationoptional
github.event.pull_request.base.user.urlstringoptional
github.event.pull_request.changed_filesintegeroptional
github.event.pull_request.commentsintegeroptional
github.event.pull_request.commitsintegeroptional
github.event.pull_request.deletionsintegeroptional
github.event.pull_request.draftbooleanrequired

Indicates whether or not the pull request is a draft.

github.event.pull_request.head.labelstringrequired
github.event.pull_request.head.repoobjectrequired

A git repository

github.event.pull_request.head.repo.allow_auto_mergebooleanoptional

Whether to allow auto-merge for pull requests.

github.event.pull_request.head.repo.allow_update_branchbooleanoptional
github.event.pull_request.head.repo.created_atinteger or stringrequired
github.event.pull_request.head.repo.delete_branch_on_mergebooleanoptional

Whether to delete head branches when pull requests are merged

github.event.pull_request.head.repo.disabledbooleanoptional

Returns whether or not this repository is disabled.

github.event.pull_request.head.repo.license.spdx_idstringrequired
github.event.pull_request.head.repo.merge_commit_messagePR_BODY, PR_TITLE, BLANKoptional

The default value for a merge commit message.

  • PR_TITLE - default to the pull request’s title.
  • PR_BODY - default to the pull request’s body.
  • BLANK - default to a blank commit message.
github.event.pull_request.head.repo.merge_commit_titlePR_TITLE, MERGE_MESSAGEoptional

The default value for a merge commit title.

  • PR_TITLE - default to the pull request’s title.
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
github.event.pull_request.head.repo.organizationstringoptional
github.event.pull_request.head.repo.ownerobject or nullrequired
github.event.pull_request.head.repo.owner.avatar_urlstringoptional
github.event.pull_request.head.repo.owner.deletedbooleanoptional
github.event.pull_request.head.repo.owner.emailstring or nulloptional
github.event.pull_request.head.repo.owner.events_urlstringoptional
github.event.pull_request.head.repo.owner.followers_urlstringoptional
github.event.pull_request.head.repo.owner.following_urlstringoptional
github.event.pull_request.head.repo.owner.gists_urlstringoptional
github.event.pull_request.head.repo.owner.gravatar_idstringoptional
github.event.pull_request.head.repo.owner.html_urlstringoptional
github.event.pull_request.head.repo.owner.namestringoptional
github.event.pull_request.head.repo.owner.node_idstringoptional
github.event.pull_request.head.repo.owner.organizations_urlstringoptional
github.event.pull_request.head.repo.owner.received_events_urlstringoptional
github.event.pull_request.head.repo.owner.repos_urlstringoptional
github.event.pull_request.head.repo.owner.site_adminbooleanoptional
github.event.pull_request.head.repo.owner.starred_urlstringoptional
github.event.pull_request.head.repo.owner.subscriptions_urlstringoptional
github.event.pull_request.head.repo.owner.typeBot, User, Organizationoptional
github.event.pull_request.head.repo.owner.urlstringoptional
github.event.pull_request.head.repo.publicbooleanoptional
github.event.pull_request.head.repo.pushed_atnull or integer or stringrequired
github.event.pull_request.head.repo.role_namestring or nulloptional
github.event.pull_request.head.repo.squash_merge_commit_messagePR_BODY, COMMIT_MESSAGES, BLANKoptional

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request’s body.
  • COMMIT_MESSAGES - default to the branch’s commit messages.
  • BLANK - default to a blank commit message.
github.event.pull_request.head.repo.squash_merge_commit_titlePR_TITLE, COMMIT_OR_PR_TITLEoptional

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request’s title.
  • COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
github.event.pull_request.head.repo.stargazersintegeroptional
github.event.pull_request.head.repo.topicsarray of stringsrequired
github.event.pull_request.head.repo.use_squash_pr_title_as_defaultbooleanoptional

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

github.event.pull_request.head.repo.visibilitypublic, private, internalrequired
github.event.pull_request.head.userobject or nullrequired
github.event.pull_request.head.user.avatar_urlstringoptional
github.event.pull_request.head.user.deletedbooleanoptional
github.event.pull_request.head.user.emailstring or nulloptional
github.event.pull_request.head.user.events_urlstringoptional
github.event.pull_request.head.user.followers_urlstringoptional
github.event.pull_request.head.user.following_urlstringoptional
github.event.pull_request.head.user.gists_urlstringoptional
github.event.pull_request.head.user.gravatar_idstringoptional
github.event.pull_request.head.user.html_urlstringoptional
github.event.pull_request.head.user.namestringoptional
github.event.pull_request.head.user.node_idstringoptional
github.event.pull_request.head.user.organizations_urlstringoptional
github.event.pull_request.head.user.received_events_urlstringoptional
github.event.pull_request.head.user.repos_urlstringoptional
github.event.pull_request.head.user.site_adminbooleanoptional
github.event.pull_request.head.user.starred_urlstringoptional
github.event.pull_request.head.user.subscriptions_urlstringoptional
github.event.pull_request.head.user.typeBot, User, Organizationoptional
github.event.pull_request.head.user.urlstringoptional
github.event.pull_request.maintainer_can_modifybooleanoptional

Indicates whether maintainers can modify the pull request.

github.event.pull_request.mergeableboolean or nulloptional
github.event.pull_request.mergeable_statestringoptional
github.event.pull_request.mergedboolean or nulloptional
github.event.pull_request.merged_byobject or nulloptional
github.event.pull_request.merged_by.avatar_urlstringoptional
github.event.pull_request.merged_by.deletedbooleanoptional
github.event.pull_request.merged_by.events_urlstringoptional
github.event.pull_request.merged_by.followers_urlstringoptional
github.event.pull_request.merged_by.following_urlstringoptional
github.event.pull_request.merged_by.gists_urlstringoptional
github.event.pull_request.merged_by.gravatar_idstringoptional
github.event.pull_request.merged_by.html_urlstringoptional
github.event.pull_request.merged_by.namestringoptional
github.event.pull_request.merged_by.node_idstringoptional
github.event.pull_request.merged_by.organizations_urlstringoptional
github.event.pull_request.merged_by.received_events_urlstringoptional
github.event.pull_request.merged_by.repos_urlstringoptional
github.event.pull_request.merged_by.site_adminbooleanoptional
github.event.pull_request.merged_by.starred_urlstringoptional
github.event.pull_request.merged_by.subscriptions_urlstringoptional
github.event.pull_request.merged_by.typeBot, User, Organizationoptional
github.event.pull_request.merged_by.urlstringoptional
github.event.pull_request.milestoneobject or nullrequired

A collection of related issues and pull requests.

github.event.pull_request.milestone.creatorobject or nullrequired
github.event.pull_request.milestone.creator.avatar_urlstringoptional
github.event.pull_request.milestone.creator.deletedbooleanoptional
github.event.pull_request.milestone.creator.events_urlstringoptional
github.event.pull_request.milestone.creator.followers_urlstringoptional
github.event.pull_request.milestone.creator.following_urlstringoptional
github.event.pull_request.milestone.creator.gists_urlstringoptional
github.event.pull_request.milestone.creator.gravatar_idstringoptional
github.event.pull_request.milestone.creator.html_urlstringoptional
github.event.pull_request.milestone.creator.namestringoptional
github.event.pull_request.milestone.creator.node_idstringoptional
github.event.pull_request.milestone.creator.organizations_urlstringoptional
github.event.pull_request.milestone.creator.received_events_urlstringoptional
github.event.pull_request.milestone.creator.repos_urlstringoptional
github.event.pull_request.milestone.creator.site_adminbooleanoptional
github.event.pull_request.milestone.creator.starred_urlstringoptional
github.event.pull_request.milestone.creator.subscriptions_urlstringoptional
github.event.pull_request.milestone.creator.typeBot, User, Organization, Mannequinoptional
github.event.pull_request.milestone.creator.urlstringoptional
github.event.pull_request.requested_reviewersarrayrequired
github.event.pull_request.requested_teamsarray of objectsrequired
github.event.pull_request.requested_teams.deletedbooleanoptional
github.event.pull_request.requested_teams.descriptionstring or nulloptional

Description of the team

github.event.pull_request.requested_teams.html_urlstringoptional
github.event.pull_request.requested_teams.members_urlstringoptional
github.event.pull_request.requested_teams.node_idstringoptional
github.event.pull_request.requested_teams.parentobject or nulloptional
github.event.pull_request.requested_teams.parent.descriptionstring or nullrequired

Description of the team

github.event.pull_request.requested_teams.parent.html_urlstringrequired
github.event.pull_request.requested_teams.parent.idintegerrequired

Unique identifier of the team

github.event.pull_request.requested_teams.parent.members_urlstringrequired
github.event.pull_request.requested_teams.parent.namestringrequired

Name of the team

github.event.pull_request.requested_teams.parent.node_idstringrequired
github.event.pull_request.requested_teams.parent.permissionstringrequired

Permission that the team will have for its repositories

github.event.pull_request.requested_teams.parent.privacyopen, closed, secretrequired
github.event.pull_request.requested_teams.parent.repositories_urlstringrequired
github.event.pull_request.requested_teams.parent.slugstringrequired
github.event.pull_request.requested_teams.parent.urlstringrequired

URL for the team

github.event.pull_request.requested_teams.permissionstringoptional

Permission that the team will have for its repositories

github.event.pull_request.requested_teams.privacyopen, closed, secretoptional
github.event.pull_request.requested_teams.repositories_urlstringoptional
github.event.pull_request.requested_teams.slugstringoptional
github.event.pull_request.requested_teams.urlstringoptional

URL for the team

github.event.pull_request.review_commentsintegeroptional
github.event.pull_request.userobject or nullrequired
github.event.pull_request.user.avatar_urlstringoptional
github.event.pull_request.user.deletedbooleanoptional
github.event.pull_request.user.events_urlstringoptional
github.event.pull_request.user.followers_urlstringoptional
github.event.pull_request.user.following_urlstringoptional
github.event.pull_request.user.gists_urlstringoptional
github.event.pull_request.user.gravatar_idstringoptional
github.event.pull_request.user.html_urlstringoptional
github.event.pull_request.user.namestringoptional
github.event.pull_request.user.node_idstringoptional
github.event.pull_request.user.organizations_urlstringoptional
github.event.pull_request.user.received_events_urlstringoptional
github.event.pull_request.user.repos_urlstringoptional
github.event.pull_request.user.site_adminbooleanoptional
github.event.pull_request.user.starred_urlstringoptional
github.event.pull_request.user.subscriptions_urlstringoptional
github.event.pull_request.user.typeBot, User, Organization, Mannequinoptional
github.event.pull_request.user.urlstringoptional
github.event.reasonstringrequired
github.event.senderobjectrequired

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.

fieldtyperequireddescription
github.event.actioneditedrequired
github.event.changesobjectrequired

The changes to the comment if the action was edited.

github.event.changes.baseobjectoptional
github.event.changes.base.refobjectrequired
github.event.changes.base.ref.fromstringrequired
github.event.changes.base.shaobjectrequired
github.event.changes.base.sha.fromstringrequired
github.event.changes.bodyobjectoptional
github.event.changes.body.fromstringrequired

The previous version of the body if the action was edited.

github.event.changes.titleobjectoptional
github.event.changes.title.fromstringrequired

The previous version of the title if the action was edited.

github.event.installationobjectoptional

The GitHub App installation. Webhook payloads contain the installation property when the event is configured for and sent to a GitHub App. For more information, see “Using webhooks with GitHub Apps."

github.event.pull_request.userobjectrequired

A GitHub user.

github.event.pull_request.user.namestring or nulloptional
github.event.pull_request.user.node_idstringrequired
github.event.pull_request.user.avatar_urlstringrequired
github.event.pull_request.user.gravatar_idstring or nullrequired
github.event.pull_request.user.urlstringrequired
github.event.pull_request.user.html_urlstringrequired
github.event.pull_request.user.followers_urlstringrequired
github.event.pull_request.user.following_urlstringrequired
github.event.pull_request.user.gists_urlstringrequired
github.event.pull_request.user.starred_urlstringrequired
github.event.pull_request.user.subscriptions_urlstringrequired
github.event.pull_request.user.organizations_urlstringrequired
github.event.pull_request.user.repos_urlstringrequired
github.event.pull_request.user.events_urlstringrequired
github.event.pull_request.user.received_events_urlstringrequired
github.event.pull_request.user.typestringrequired
github.event.pull_request.user.site_adminbooleanrequired
github.event.pull_request.user.starred_atstringoptional
github.event.pull_request.milestoneobjectrequired

A collection of related issues and pull requests.

github.event.pull_request.milestone.creatorobjectrequired

A GitHub user.

github.event.pull_request.milestone.creator.namestring or nulloptional
github.event.pull_request.milestone.creator.node_idstringrequired
github.event.pull_request.milestone.creator.avatar_urlstringrequired
github.event.pull_request.milestone.creator.gravatar_idstring or nullrequired
github.event.pull_request.milestone.creator.urlstringrequired
github.event.pull_request.milestone.creator.html_urlstringrequired
github.event.pull_request.milestone.creator.followers_urlstringrequired
github.event.pull_request.milestone.creator.following_urlstringrequired
github.event.pull_request.milestone.creator.gists_urlstringrequired
github.event.pull_request.milestone.creator.starred_urlstringrequired
github.event.pull_request.milestone.creator.subscriptions_urlstringrequired
github.event.pull_request.milestone.creator.organizations_urlstringrequired
github.event.pull_request.milestone.creator.repos_urlstringrequired
github.event.pull_request.milestone.creator.events_urlstringrequired
github.event.pull_request.milestone.creator.received_events_urlstringrequired
github.event.pull_request.milestone.creator.typestringrequired
github.event.pull_request.milestone.creator.site_adminbooleanrequired
github.event.pull_request.milestone.creator.starred_atstringoptional
github.event.pull_request.active_lock_reasonstring or nulloptional
github.event.pull_request.assigneeobjectrequired

A GitHub user.

github.event.pull_request.assignee.namestring or nulloptional
github.event.pull_request.assignee.node_idstringrequired
github.event.pull_request.assignee.avatar_urlstringrequired
github.event.pull_request.assignee.gravatar_idstring or nullrequired
github.event.pull_request.assignee.urlstringrequired
github.event.pull_request.assignee.html_urlstringrequired
github.event.pull_request.assignee.followers_urlstringrequired
github.event.pull_request.assignee.following_urlstringrequired
github.event.pull_request.assignee.gists_urlstringrequired
github.event.pull_request.assignee.starred_urlstringrequired
github.event.pull_request.assignee.subscriptions_urlstringrequired
github.event.pull_request.assignee.organizations_urlstringrequired
github.event.pull_request.assignee.repos_urlstringrequired
github.event.pull_request.assignee.events_urlstringrequired
github.event.pull_request.assignee.received_events_urlstringrequired
github.event.pull_request.assignee.typestringrequired
github.event.pull_request.assignee.site_adminbooleanrequired
github.event.pull_request.assignee.starred_atstringoptional
github.event.pull_request.assigneesarray of objects or nulloptional
github.event.pull_request.assignees.namestring or nulloptional
github.event.pull_request.assignees.emailstring or nulloptional
github.event.pull_request.assignees.loginstringrequired
github.event.pull_request.assignees.idintegerrequired
github.event.pull_request.assignees.node_idstringrequired
github.event.pull_request.assignees.avatar_urlstringrequired
github.event.pull_request.assignees.gravatar_idstring or nullrequired
github.event.pull_request.assignees.urlstringrequired
github.event.pull_request.assignees.html_urlstringrequired
github.event.pull_request.assignees.followers_urlstringrequired
github.event.pull_request.assignees.following_urlstringrequired
github.event.pull_request.assignees.gists_urlstringrequired
github.event.pull_request.assignees.starred_urlstringrequired
github.event.pull_request.assignees.subscriptions_urlstringrequired
github.event.pull_request.assignees.organizations_urlstringrequired
github.event.pull_request.assignees.repos_urlstringrequired
github.event.pull_request.assignees.events_urlstringrequired
github.event.pull_request.assignees.received_events_urlstringrequired
github.event.pull_request.assignees.typestringrequired
github.event.pull_request.assignees.site_adminbooleanrequired
github.event.pull_request.assignees.starred_atstringoptional
github.event.pull_request.requested_reviewersarray of objects or nulloptional
github.event.pull_request.requested_reviewers.namestring or nulloptional
github.event.pull_request.requested_reviewers.emailstring or nulloptional
github.event.pull_request.requested_reviewers.loginstringrequired
github.event.pull_request.requested_reviewers.idintegerrequired
github.event.pull_request.requested_reviewers.node_idstringrequired
github.event.pull_request.requested_reviewers.avatar_urlstringrequired
github.event.pull_request.requested_reviewers.gravatar_idstring or nullrequired
github.event.pull_request.requested_reviewers.urlstringrequired
github.event.pull_request.requested_reviewers.html_urlstringrequired
github.event.pull_request.requested_reviewers.followers_urlstringrequired
github.event.pull_request.requested_reviewers.following_urlstringrequired
github.event.pull_request.requested_reviewers.gists_urlstringrequired
github.event.pull_request.requested_reviewers.starred_urlstringrequired
github.event.pull_request.requested_reviewers.subscriptions_urlstringrequired
github.event.pull_request.requested_reviewers.organizations_urlstringrequired
github.event.pull_request.requested_reviewers.repos_urlstringrequired
github.event.pull_request.requested_reviewers.events_urlstringrequired
github.event.pull_request.requested_reviewers.received_events_urlstringrequired
github.event.pull_request.requested_reviewers.typestringrequired
github.event.pull_request.requested_reviewers.site_adminbooleanrequired
github.event.pull_request.requested_reviewers.starred_atstringoptional
github.event.pull_request.requested_teamsarray of objects or nulloptional
github.event.pull_request.requested_teams.node_idstringrequired
github.event.pull_request.requested_teams.urlstringrequired

URL for the team

github.event.pull_request.requested_teams.members_urlstringrequired
github.event.pull_request.requested_teams.descriptionstring or nullrequired

Description of the team

github.event.pull_request.requested_teams.permissionstringrequired

Permission that the team will have for its repositories

github.event.pull_request.requested_teams.privacystringoptional

The level of privacy this team should have

github.event.pull_request.requested_teams.notification_settingstringoptional

The notification setting the team has set

github.event.pull_request.requested_teams.html_urlstringrequired
github.event.pull_request.requested_teams.repositories_urlstringrequired
github.event.pull_request.requested_teams.slugstringrequired
github.event.pull_request.requested_teams.ldap_dnstringoptional

Distinguished Name (DN) that team maps to within LDAP environment

github.event.pull_request.head.labelstringrequired
github.event.pull_request.head.repoobject or nullrequired
github.event.pull_request.head.repo.ownerobjectrequired
github.event.pull_request.head.repo.owner.avatar_urlstringrequired
github.event.pull_request.head.repo.owner.events_urlstringrequired
github.event.pull_request.head.repo.owner.followers_urlstringrequired
github.event.pull_request.head.repo.owner.following_urlstringrequired
github.event.pull_request.head.repo.owner.gists_urlstringrequired
github.event.pull_request.head.repo.owner.gravatar_idstring or nullrequired
github.event.pull_request.head.repo.owner.html_urlstringrequired
github.event.pull_request.head.repo.owner.node_idstringrequired
github.event.pull_request.head.repo.owner.organizations_urlstringrequired
github.event.pull_request.head.repo.owner.received_events_urlstringrequired
github.event.pull_request.head.repo.owner.repos_urlstringrequired
github.event.pull_request.head.repo.owner.site_adminbooleanrequired
github.event.pull_request.head.repo.owner.starred_urlstringrequired
github.event.pull_request.head.repo.owner.subscriptions_urlstringrequired
github.event.pull_request.head.repo.owner.typestringrequired
github.event.pull_request.head.repo.owner.urlstringrequired
github.event.pull_request.head.repo.disabledbooleanrequired
github.event.pull_request.head.repo.visibilitystringoptional

The repository visibility: public, private, or internal.

github.event.pull_request.head.repo.temp_clone_tokenstringoptional
github.event.pull_request.head.repo.license.spdx_idstring or nullrequired
github.event.pull_request.head.repo.pushed_atstringrequired
github.event.pull_request.head.repo.topicsarray of stringsoptional
github.event.pull_request.head.repo.created_atstringrequired
github.event.pull_request.head.userobjectrequired
github.event.pull_request.head.user.avatar_urlstringrequired
github.event.pull_request.head.user.events_urlstringrequired
github.event.pull_request.head.user.followers_urlstringrequired
github.event.pull_request.head.user.following_urlstringrequired
github.event.pull_request.head.user.gists_urlstringrequired
github.event.pull_request.head.user.gravatar_idstring or nullrequired
github.event.pull_request.head.user.html_urlstringrequired
github.event.pull_request.head.user.node_idstringrequired
github.event.pull_request.head.user.organizations_urlstringrequired
github.event.pull_request.head.user.received_events_urlstringrequired
github.event.pull_request.head.user.repos_urlstringrequired
github.event.pull_request.head.user.site_adminbooleanrequired
github.event.pull_request.head.user.starred_urlstringrequired
github.event.pull_request.head.user.subscriptions_urlstringrequired
github.event.pull_request.head.user.typestringrequired
github.event.pull_request.head.user.urlstringrequired
github.event.pull_request.base.labelstringrequired
github.event.pull_request.base.repo.ownerobjectrequired
github.event.pull_request.base.repo.owner.avatar_urlstringrequired
github.event.pull_request.base.repo.owner.events_urlstringrequired
github.event.pull_request.base.repo.owner.followers_urlstringrequired
github.event.pull_request.base.repo.owner.following_urlstringrequired
github.event.pull_request.base.repo.owner.gists_urlstringrequired
github.event.pull_request.base.repo.owner.gravatar_idstring or nullrequired
github.event.pull_request.base.repo.owner.html_urlstringrequired
github.event.pull_request.base.repo.owner.node_idstringrequired
github.event.pull_request.base.repo.owner.organizations_urlstringrequired
github.event.pull_request.base.repo.owner.received_events_urlstringrequired
github.event.pull_request.base.repo.owner.repos_urlstringrequired
github.event.pull_request.base.repo.owner.site_adminbooleanrequired
github.event.pull_request.base.repo.owner.starred_urlstringrequired
github.event.pull_request.base.repo.owner.subscriptions_urlstringrequired
github.event.pull_request.base.repo.owner.typestringrequired
github.event.pull_request.base.repo.owner.urlstringrequired
github.event.pull_request.base.repo.disabledbooleanrequired
github.event.pull_request.base.repo.visibilitystringoptional

The repository visibility: public, private, or internal.

github.event.pull_request.base.repo.temp_clone_tokenstringoptional
github.event.pull_request.base.repo.licenseobjectrequired

License Simple

github.event.pull_request.base.repo.license.spdx_idstring or nullrequired
github.event.pull_request.base.repo.license.html_urlstringoptional
github.event.pull_request.base.repo.pushed_atstringrequired
github.event.pull_request.base.repo.topicsarray of stringsoptional
github.event.pull_request.base.repo.created_atstringrequired
github.event.pull_request.base.userobjectrequired
github.event.pull_request.base.user.avatar_urlstringrequired
github.event.pull_request.base.user.events_urlstringrequired
github.event.pull_request.base.user.followers_urlstringrequired
github.event.pull_request.base.user.following_urlstringrequired
github.event.pull_request.base.user.gists_urlstringrequired
github.event.pull_request.base.user.gravatar_idstring or nullrequired
github.event.pull_request.base.user.html_urlstringrequired
github.event.pull_request.base.user.node_idstringrequired
github.event.pull_request.base.user.organizations_urlstringrequired
github.event.pull_request.base.user.received_events_urlstringrequired
github.event.pull_request.base.user.repos_urlstringrequired
github.event.pull_request.base.user.site_adminbooleanrequired
github.event.pull_request.base.user.starred_urlstringrequired
github.event.pull_request.base.user.subscriptions_urlstringrequired
github.event.pull_request.base.user.typestringrequired
github.event.pull_request.base.user.urlstringrequired
github.event.pull_request.auto_merge.enabled_byobjectrequired

A GitHub user.

github.event.pull_request.auto_merge.enabled_by.namestring or nulloptional
github.event.pull_request.auto_merge.enabled_by.node_idstringrequired
github.event.pull_request.auto_merge.enabled_by.avatar_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.gravatar_idstring or nullrequired
github.event.pull_request.auto_merge.enabled_by.urlstringrequired
github.event.pull_request.auto_merge.enabled_by.html_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.followers_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.following_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.gists_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.starred_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.subscriptions_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.organizations_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.repos_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.events_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.received_events_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.typestringrequired
github.event.pull_request.auto_merge.enabled_by.site_adminbooleanrequired
github.event.pull_request.auto_merge.enabled_by.starred_atstringoptional
github.event.pull_request.auto_merge.commit_titlestringrequired

Title for the merge commit message.

github.event.pull_request.auto_merge.commit_messagestringrequired

Commit message for the merge commit.

github.event.pull_request.draftbooleanoptional

Indicates whether or not the pull request is a draft.

github.event.pull_request.mergedbooleanrequired
github.event.pull_request.mergeableboolean or nullrequired
github.event.pull_request.mergeable_statestringrequired
github.event.pull_request.merged_byobjectrequired

A GitHub user.

github.event.pull_request.merged_by.namestring or nulloptional
github.event.pull_request.merged_by.node_idstringrequired
github.event.pull_request.merged_by.avatar_urlstringrequired
github.event.pull_request.merged_by.gravatar_idstring or nullrequired
github.event.pull_request.merged_by.urlstringrequired
github.event.pull_request.merged_by.html_urlstringrequired
github.event.pull_request.merged_by.followers_urlstringrequired
github.event.pull_request.merged_by.following_urlstringrequired
github.event.pull_request.merged_by.gists_urlstringrequired
github.event.pull_request.merged_by.starred_urlstringrequired
github.event.pull_request.merged_by.subscriptions_urlstringrequired
github.event.pull_request.merged_by.organizations_urlstringrequired
github.event.pull_request.merged_by.repos_urlstringrequired
github.event.pull_request.merged_by.events_urlstringrequired
github.event.pull_request.merged_by.received_events_urlstringrequired
github.event.pull_request.merged_by.typestringrequired
github.event.pull_request.merged_by.site_adminbooleanrequired
github.event.pull_request.merged_by.starred_atstringoptional
github.event.pull_request.commentsintegerrequired
github.event.pull_request.review_commentsintegerrequired
github.event.pull_request.maintainer_can_modifybooleanrequired

Indicates whether maintainers can modify the pull request.

github.event.pull_request.commitsintegerrequired
github.event.pull_request.additionsintegerrequired
github.event.pull_request.deletionsintegerrequired
github.event.pull_request.changed_filesintegerrequired
github.event.pull_request.allow_auto_mergebooleanoptional

Whether to allow auto-merge for pull requests.

github.event.pull_request.allow_update_branchbooleanoptional

Whether to allow updating the pull request’s branch.

github.event.pull_request.delete_branch_on_mergebooleanoptional

Whether to delete head branches when pull requests are merged.

github.event.pull_request.merge_commit_messagePR_BODY, PR_TITLE, BLANKoptional

The default value for a merge commit message.

  • PR_TITLE - default to the pull request’s title.
  • PR_BODY - default to the pull request’s body.
  • BLANK - default to a blank commit message.
github.event.pull_request.merge_commit_titlePR_TITLE, MERGE_MESSAGEoptional

The default value for a merge commit title.

  • PR_TITLE - default to the pull request’s title.
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., “Merge pull request #123 from branch-name”).
github.event.pull_request.squash_merge_commit_messagePR_BODY, COMMIT_MESSAGES, BLANKoptional

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request’s body.
  • COMMIT_MESSAGES - default to the branch’s commit messages.
  • BLANK - default to a blank commit message.
github.event.pull_request.squash_merge_commit_titlePR_TITLE, COMMIT_OR_PR_TITLEoptional

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request’s title.
  • COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
github.event.pull_request.use_squash_pr_title_as_defaultbooleanoptional

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

github.event.senderobjectoptional

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.

fieldtyperequireddescription
github.event.actionenqueuedrequired
github.event.installationobjectoptional

The GitHub App installation. Webhook payloads contain the installation property when the event is configured for and sent to a GitHub App. For more information, see “Using webhooks with GitHub Apps."

github.event.pull_request.active_lock_reasonresolved, off-topic, too heated, spam, Nonerequired
github.event.pull_request.additionsintegeroptional
github.event.pull_request.assigneeobject or nullrequired
github.event.pull_request.assignee.avatar_urlstringoptional
github.event.pull_request.assignee.deletedbooleanoptional
github.event.pull_request.assignee.events_urlstringoptional
github.event.pull_request.assignee.followers_urlstringoptional
github.event.pull_request.assignee.following_urlstringoptional
github.event.pull_request.assignee.gists_urlstringoptional
github.event.pull_request.assignee.gravatar_idstringoptional
github.event.pull_request.assignee.html_urlstringoptional
github.event.pull_request.assignee.namestringoptional
github.event.pull_request.assignee.node_idstringoptional
github.event.pull_request.assignee.organizations_urlstringoptional
github.event.pull_request.assignee.received_events_urlstringoptional
github.event.pull_request.assignee.repos_urlstringoptional
github.event.pull_request.assignee.site_adminbooleanoptional
github.event.pull_request.assignee.starred_urlstringoptional
github.event.pull_request.assignee.subscriptions_urlstringoptional
github.event.pull_request.assignee.typeBot, User, Organizationoptional
github.event.pull_request.assignee.urlstringoptional
github.event.pull_request.assigneesarray of object,nullsrequired
github.event.pull_request.auto_merge.commit_messagestring or nullrequired

Commit message for the merge commit.

github.event.pull_request.auto_merge.commit_titlestring or nullrequired

Title for the merge commit message.

github.event.pull_request.auto_merge.enabled_byobject or nullrequired
github.event.pull_request.auto_merge.enabled_by.avatar_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.deletedbooleanoptional
github.event.pull_request.auto_merge.enabled_by.events_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.followers_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.following_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.gists_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.gravatar_idstringoptional
github.event.pull_request.auto_merge.enabled_by.html_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.namestringoptional
github.event.pull_request.auto_merge.enabled_by.node_idstringoptional
github.event.pull_request.auto_merge.enabled_by.organizations_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.received_events_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.repos_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.site_adminbooleanoptional
github.event.pull_request.auto_merge.enabled_by.starred_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.subscriptions_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.typeBot, User, Organizationoptional
github.event.pull_request.auto_merge.enabled_by.urlstringoptional
github.event.pull_request.base.labelstringrequired
github.event.pull_request.base.repo.allow_auto_mergebooleanoptional

Whether to allow auto-merge for pull requests.

github.event.pull_request.base.repo.allow_update_branchbooleanoptional
github.event.pull_request.base.repo.created_atinteger or stringrequired
github.event.pull_request.base.repo.delete_branch_on_mergebooleanoptional

Whether to delete head branches when pull requests are merged

github.event.pull_request.base.repo.disabledbooleanoptional

Returns whether or not this repository is disabled.

github.event.pull_request.base.repo.licenseobject or nullrequired
github.event.pull_request.base.repo.license.spdx_idstringrequired
github.event.pull_request.base.repo.merge_commit_messagePR_BODY, PR_TITLE, BLANKoptional

The default value for a merge commit message.

  • PR_TITLE - default to the pull request’s title.
  • PR_BODY - default to the pull request’s body.
  • BLANK - default to a blank commit message.
github.event.pull_request.base.repo.merge_commit_titlePR_TITLE, MERGE_MESSAGEoptional

The default value for a merge commit title.

  • PR_TITLE - default to the pull request’s title.
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
github.event.pull_request.base.repo.organizationstringoptional
github.event.pull_request.base.repo.ownerobject or nullrequired
github.event.pull_request.base.repo.owner.avatar_urlstringoptional
github.event.pull_request.base.repo.owner.deletedbooleanoptional
github.event.pull_request.base.repo.owner.emailstring or nulloptional
github.event.pull_request.base.repo.owner.events_urlstringoptional
github.event.pull_request.base.repo.owner.followers_urlstringoptional
github.event.pull_request.base.repo.owner.following_urlstringoptional
github.event.pull_request.base.repo.owner.gists_urlstringoptional
github.event.pull_request.base.repo.owner.gravatar_idstringoptional
github.event.pull_request.base.repo.owner.html_urlstringoptional
github.event.pull_request.base.repo.owner.namestringoptional
github.event.pull_request.base.repo.owner.node_idstringoptional
github.event.pull_request.base.repo.owner.organizations_urlstringoptional
github.event.pull_request.base.repo.owner.received_events_urlstringoptional
github.event.pull_request.base.repo.owner.repos_urlstringoptional
github.event.pull_request.base.repo.owner.site_adminbooleanoptional
github.event.pull_request.base.repo.owner.starred_urlstringoptional
github.event.pull_request.base.repo.owner.subscriptions_urlstringoptional
github.event.pull_request.base.repo.owner.typeBot, User, Organizationoptional
github.event.pull_request.base.repo.owner.urlstringoptional
github.event.pull_request.base.repo.publicbooleanoptional
github.event.pull_request.base.repo.pushed_atnull or integer or stringrequired
github.event.pull_request.base.repo.role_namestring or nulloptional
github.event.pull_request.base.repo.squash_merge_commit_messagePR_BODY, COMMIT_MESSAGES, BLANKoptional

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request’s body.
  • COMMIT_MESSAGES - default to the branch’s commit messages.
  • BLANK - default to a blank commit message.
github.event.pull_request.base.repo.squash_merge_commit_titlePR_TITLE, COMMIT_OR_PR_TITLEoptional

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request’s title.
  • COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
github.event.pull_request.base.repo.stargazersintegeroptional
github.event.pull_request.base.repo.topicsarray of stringsrequired
github.event.pull_request.base.repo.use_squash_pr_title_as_defaultbooleanoptional

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

github.event.pull_request.base.repo.visibilitypublic, private, internalrequired
github.event.pull_request.base.userobject or nullrequired
github.event.pull_request.base.user.avatar_urlstringoptional
github.event.pull_request.base.user.deletedbooleanoptional
github.event.pull_request.base.user.emailstring or nulloptional
github.event.pull_request.base.user.events_urlstringoptional
github.event.pull_request.base.user.followers_urlstringoptional
github.event.pull_request.base.user.following_urlstringoptional
github.event.pull_request.base.user.gists_urlstringoptional
github.event.pull_request.base.user.gravatar_idstringoptional
github.event.pull_request.base.user.html_urlstringoptional
github.event.pull_request.base.user.namestringoptional
github.event.pull_request.base.user.node_idstringoptional
github.event.pull_request.base.user.organizations_urlstringoptional
github.event.pull_request.base.user.received_events_urlstringoptional
github.event.pull_request.base.user.repos_urlstringoptional
github.event.pull_request.base.user.site_adminbooleanoptional
github.event.pull_request.base.user.starred_urlstringoptional
github.event.pull_request.base.user.subscriptions_urlstringoptional
github.event.pull_request.base.user.typeBot, User, Organizationoptional
github.event.pull_request.base.user.urlstringoptional
github.event.pull_request.changed_filesintegeroptional
github.event.pull_request.commentsintegeroptional
github.event.pull_request.commitsintegeroptional
github.event.pull_request.deletionsintegeroptional
github.event.pull_request.draftbooleanrequired

Indicates whether or not the pull request is a draft.

github.event.pull_request.head.labelstringrequired
github.event.pull_request.head.repoobjectrequired

A git repository

github.event.pull_request.head.repo.allow_auto_mergebooleanoptional

Whether to allow auto-merge for pull requests.

github.event.pull_request.head.repo.allow_update_branchbooleanoptional
github.event.pull_request.head.repo.created_atinteger or stringrequired
github.event.pull_request.head.repo.delete_branch_on_mergebooleanoptional

Whether to delete head branches when pull requests are merged

github.event.pull_request.head.repo.disabledbooleanoptional

Returns whether or not this repository is disabled.

github.event.pull_request.head.repo.license.spdx_idstringrequired
github.event.pull_request.head.repo.merge_commit_messagePR_BODY, PR_TITLE, BLANKoptional

The default value for a merge commit message.

  • PR_TITLE - default to the pull request’s title.
  • PR_BODY - default to the pull request’s body.
  • BLANK - default to a blank commit message.
github.event.pull_request.head.repo.merge_commit_titlePR_TITLE, MERGE_MESSAGEoptional

The default value for a merge commit title.

  • PR_TITLE - default to the pull request’s title.
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
github.event.pull_request.head.repo.organizationstringoptional
github.event.pull_request.head.repo.ownerobject or nullrequired
github.event.pull_request.head.repo.owner.avatar_urlstringoptional
github.event.pull_request.head.repo.owner.deletedbooleanoptional
github.event.pull_request.head.repo.owner.emailstring or nulloptional
github.event.pull_request.head.repo.owner.events_urlstringoptional
github.event.pull_request.head.repo.owner.followers_urlstringoptional
github.event.pull_request.head.repo.owner.following_urlstringoptional
github.event.pull_request.head.repo.owner.gists_urlstringoptional
github.event.pull_request.head.repo.owner.gravatar_idstringoptional
github.event.pull_request.head.repo.owner.html_urlstringoptional
github.event.pull_request.head.repo.owner.namestringoptional
github.event.pull_request.head.repo.owner.node_idstringoptional
github.event.pull_request.head.repo.owner.organizations_urlstringoptional
github.event.pull_request.head.repo.owner.received_events_urlstringoptional
github.event.pull_request.head.repo.owner.repos_urlstringoptional
github.event.pull_request.head.repo.owner.site_adminbooleanoptional
github.event.pull_request.head.repo.owner.starred_urlstringoptional
github.event.pull_request.head.repo.owner.subscriptions_urlstringoptional
github.event.pull_request.head.repo.owner.typeBot, User, Organizationoptional
github.event.pull_request.head.repo.owner.urlstringoptional
github.event.pull_request.head.repo.publicbooleanoptional
github.event.pull_request.head.repo.pushed_atnull or integer or stringrequired
github.event.pull_request.head.repo.role_namestring or nulloptional
github.event.pull_request.head.repo.squash_merge_commit_messagePR_BODY, COMMIT_MESSAGES, BLANKoptional

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request’s body.
  • COMMIT_MESSAGES - default to the branch’s commit messages.
  • BLANK - default to a blank commit message.
github.event.pull_request.head.repo.squash_merge_commit_titlePR_TITLE, COMMIT_OR_PR_TITLEoptional

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request’s title.
  • COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
github.event.pull_request.head.repo.stargazersintegeroptional
github.event.pull_request.head.repo.topicsarray of stringsrequired
github.event.pull_request.head.repo.use_squash_pr_title_as_defaultbooleanoptional

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

github.event.pull_request.head.repo.visibilitypublic, private, internalrequired
github.event.pull_request.head.userobject or nullrequired
github.event.pull_request.head.user.avatar_urlstringoptional
github.event.pull_request.head.user.deletedbooleanoptional
github.event.pull_request.head.user.emailstring or nulloptional
github.event.pull_request.head.user.events_urlstringoptional
github.event.pull_request.head.user.followers_urlstringoptional
github.event.pull_request.head.user.following_urlstringoptional
github.event.pull_request.head.user.gists_urlstringoptional
github.event.pull_request.head.user.gravatar_idstringoptional
github.event.pull_request.head.user.html_urlstringoptional
github.event.pull_request.head.user.namestringoptional
github.event.pull_request.head.user.node_idstringoptional
github.event.pull_request.head.user.organizations_urlstringoptional
github.event.pull_request.head.user.received_events_urlstringoptional
github.event.pull_request.head.user.repos_urlstringoptional
github.event.pull_request.head.user.site_adminbooleanoptional
github.event.pull_request.head.user.starred_urlstringoptional
github.event.pull_request.head.user.subscriptions_urlstringoptional
github.event.pull_request.head.user.typeBot, User, Organizationoptional
github.event.pull_request.head.user.urlstringoptional
github.event.pull_request.maintainer_can_modifybooleanoptional

Indicates whether maintainers can modify the pull request.

github.event.pull_request.mergeableboolean or nulloptional
github.event.pull_request.mergeable_statestringoptional
github.event.pull_request.mergedboolean or nulloptional
github.event.pull_request.merged_byobject or nulloptional
github.event.pull_request.merged_by.avatar_urlstringoptional
github.event.pull_request.merged_by.deletedbooleanoptional
github.event.pull_request.merged_by.events_urlstringoptional
github.event.pull_request.merged_by.followers_urlstringoptional
github.event.pull_request.merged_by.following_urlstringoptional
github.event.pull_request.merged_by.gists_urlstringoptional
github.event.pull_request.merged_by.gravatar_idstringoptional
github.event.pull_request.merged_by.html_urlstringoptional
github.event.pull_request.merged_by.namestringoptional
github.event.pull_request.merged_by.node_idstringoptional
github.event.pull_request.merged_by.organizations_urlstringoptional
github.event.pull_request.merged_by.received_events_urlstringoptional
github.event.pull_request.merged_by.repos_urlstringoptional
github.event.pull_request.merged_by.site_adminbooleanoptional
github.event.pull_request.merged_by.starred_urlstringoptional
github.event.pull_request.merged_by.subscriptions_urlstringoptional
github.event.pull_request.merged_by.typeBot, User, Organizationoptional
github.event.pull_request.merged_by.urlstringoptional
github.event.pull_request.milestoneobject or nullrequired

A collection of related issues and pull requests.

github.event.pull_request.milestone.creatorobject or nullrequired
github.event.pull_request.milestone.creator.avatar_urlstringoptional
github.event.pull_request.milestone.creator.deletedbooleanoptional
github.event.pull_request.milestone.creator.events_urlstringoptional
github.event.pull_request.milestone.creator.followers_urlstringoptional
github.event.pull_request.milestone.creator.following_urlstringoptional
github.event.pull_request.milestone.creator.gists_urlstringoptional
github.event.pull_request.milestone.creator.gravatar_idstringoptional
github.event.pull_request.milestone.creator.html_urlstringoptional
github.event.pull_request.milestone.creator.namestringoptional
github.event.pull_request.milestone.creator.node_idstringoptional
github.event.pull_request.milestone.creator.organizations_urlstringoptional
github.event.pull_request.milestone.creator.received_events_urlstringoptional
github.event.pull_request.milestone.creator.repos_urlstringoptional
github.event.pull_request.milestone.creator.site_adminbooleanoptional
github.event.pull_request.milestone.creator.starred_urlstringoptional
github.event.pull_request.milestone.creator.subscriptions_urlstringoptional
github.event.pull_request.milestone.creator.typeBot, User, Organization, Mannequinoptional
github.event.pull_request.milestone.creator.urlstringoptional
github.event.pull_request.requested_reviewersarrayrequired
github.event.pull_request.requested_teamsarray of objectsrequired
github.event.pull_request.requested_teams.deletedbooleanoptional
github.event.pull_request.requested_teams.descriptionstring or nulloptional

Description of the team

github.event.pull_request.requested_teams.html_urlstringoptional
github.event.pull_request.requested_teams.members_urlstringoptional
github.event.pull_request.requested_teams.node_idstringoptional
github.event.pull_request.requested_teams.parentobject or nulloptional
github.event.pull_request.requested_teams.parent.descriptionstring or nullrequired

Description of the team

github.event.pull_request.requested_teams.parent.html_urlstringrequired
github.event.pull_request.requested_teams.parent.idintegerrequired

Unique identifier of the team

github.event.pull_request.requested_teams.parent.members_urlstringrequired
github.event.pull_request.requested_teams.parent.namestringrequired

Name of the team

github.event.pull_request.requested_teams.parent.node_idstringrequired
github.event.pull_request.requested_teams.parent.permissionstringrequired

Permission that the team will have for its repositories

github.event.pull_request.requested_teams.parent.privacyopen, closed, secretrequired
github.event.pull_request.requested_teams.parent.repositories_urlstringrequired
github.event.pull_request.requested_teams.parent.slugstringrequired
github.event.pull_request.requested_teams.parent.urlstringrequired

URL for the team

github.event.pull_request.requested_teams.permissionstringoptional

Permission that the team will have for its repositories

github.event.pull_request.requested_teams.privacyopen, closed, secretoptional
github.event.pull_request.requested_teams.repositories_urlstringoptional
github.event.pull_request.requested_teams.slugstringoptional
github.event.pull_request.requested_teams.urlstringoptional

URL for the team

github.event.pull_request.review_commentsintegeroptional
github.event.pull_request.userobject or nullrequired
github.event.pull_request.user.avatar_urlstringoptional
github.event.pull_request.user.deletedbooleanoptional
github.event.pull_request.user.events_urlstringoptional
github.event.pull_request.user.followers_urlstringoptional
github.event.pull_request.user.following_urlstringoptional
github.event.pull_request.user.gists_urlstringoptional
github.event.pull_request.user.gravatar_idstringoptional
github.event.pull_request.user.html_urlstringoptional
github.event.pull_request.user.namestringoptional
github.event.pull_request.user.node_idstringoptional
github.event.pull_request.user.organizations_urlstringoptional
github.event.pull_request.user.received_events_urlstringoptional
github.event.pull_request.user.repos_urlstringoptional
github.event.pull_request.user.site_adminbooleanoptional
github.event.pull_request.user.starred_urlstringoptional
github.event.pull_request.user.subscriptions_urlstringoptional
github.event.pull_request.user.typeBot, User, Organization, Mannequinoptional
github.event.pull_request.user.urlstringoptional
github.event.senderobjectrequired

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.

fieldtyperequireddescription
github.event.actionlabeledrequired
github.event.installationobjectoptional

The GitHub App installation. Webhook payloads contain the installation property when the event is configured for and sent to a GitHub App. For more information, see “Using webhooks with GitHub Apps."

github.event.labelobjectoptional
github.event.label.colorstringrequired

6-character hex code, without the leading #, identifying the color

github.event.label.defaultbooleanrequired
github.event.label.descriptionstring or nullrequired
github.event.label.idintegerrequired
github.event.label.namestringrequired

The name of the label.

github.event.label.node_idstringrequired
github.event.label.urlstringrequired

URL for the label

github.event.pull_request.active_lock_reasonresolved, off-topic, too heated, spam, Nonerequired
github.event.pull_request.additionsintegeroptional
github.event.pull_request.assigneeobject or nullrequired
github.event.pull_request.assignee.avatar_urlstringoptional
github.event.pull_request.assignee.deletedbooleanoptional
github.event.pull_request.assignee.events_urlstringoptional
github.event.pull_request.assignee.followers_urlstringoptional
github.event.pull_request.assignee.following_urlstringoptional
github.event.pull_request.assignee.gists_urlstringoptional
github.event.pull_request.assignee.gravatar_idstringoptional
github.event.pull_request.assignee.html_urlstringoptional
github.event.pull_request.assignee.namestringoptional
github.event.pull_request.assignee.node_idstringoptional
github.event.pull_request.assignee.organizations_urlstringoptional
github.event.pull_request.assignee.received_events_urlstringoptional
github.event.pull_request.assignee.repos_urlstringoptional
github.event.pull_request.assignee.site_adminbooleanoptional
github.event.pull_request.assignee.starred_urlstringoptional
github.event.pull_request.assignee.subscriptions_urlstringoptional
github.event.pull_request.assignee.typeBot, User, Organization, Mannequinoptional
github.event.pull_request.assignee.urlstringoptional
github.event.pull_request.assigneesarray of object,nullsrequired
github.event.pull_request.auto_merge.commit_messagestring or nullrequired

Commit message for the merge commit.

github.event.pull_request.auto_merge.commit_titlestring or nullrequired

Title for the merge commit message.

github.event.pull_request.auto_merge.enabled_byobject or nullrequired
github.event.pull_request.auto_merge.enabled_by.avatar_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.deletedbooleanoptional
github.event.pull_request.auto_merge.enabled_by.events_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.followers_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.following_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.gists_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.gravatar_idstringoptional
github.event.pull_request.auto_merge.enabled_by.html_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.namestringoptional
github.event.pull_request.auto_merge.enabled_by.node_idstringoptional
github.event.pull_request.auto_merge.enabled_by.organizations_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.received_events_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.repos_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.site_adminbooleanoptional
github.event.pull_request.auto_merge.enabled_by.starred_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.subscriptions_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.typeBot, User, Organizationoptional
github.event.pull_request.auto_merge.enabled_by.urlstringoptional
github.event.pull_request.base.labelstringrequired
github.event.pull_request.base.repo.allow_auto_mergebooleanoptional

Whether to allow auto-merge for pull requests.

github.event.pull_request.base.repo.allow_update_branchbooleanoptional
github.event.pull_request.base.repo.created_atinteger or stringrequired
github.event.pull_request.base.repo.delete_branch_on_mergebooleanoptional

Whether to delete head branches when pull requests are merged

github.event.pull_request.base.repo.disabledbooleanoptional

Returns whether or not this repository is disabled.

github.event.pull_request.base.repo.licenseobject or nullrequired
github.event.pull_request.base.repo.license.spdx_idstringrequired
github.event.pull_request.base.repo.merge_commit_messagePR_BODY, PR_TITLE, BLANKoptional

The default value for a merge commit message.

  • PR_TITLE - default to the pull request’s title.
  • PR_BODY - default to the pull request’s body.
  • BLANK - default to a blank commit message.
github.event.pull_request.base.repo.merge_commit_titlePR_TITLE, MERGE_MESSAGEoptional

The default value for a merge commit title.

  • PR_TITLE - default to the pull request’s title.
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
github.event.pull_request.base.repo.organizationstringoptional
github.event.pull_request.base.repo.ownerobject or nullrequired
github.event.pull_request.base.repo.owner.avatar_urlstringoptional
github.event.pull_request.base.repo.owner.deletedbooleanoptional
github.event.pull_request.base.repo.owner.emailstring or nulloptional
github.event.pull_request.base.repo.owner.events_urlstringoptional
github.event.pull_request.base.repo.owner.followers_urlstringoptional
github.event.pull_request.base.repo.owner.following_urlstringoptional
github.event.pull_request.base.repo.owner.gists_urlstringoptional
github.event.pull_request.base.repo.owner.gravatar_idstringoptional
github.event.pull_request.base.repo.owner.html_urlstringoptional
github.event.pull_request.base.repo.owner.namestringoptional
github.event.pull_request.base.repo.owner.node_idstringoptional
github.event.pull_request.base.repo.owner.organizations_urlstringoptional
github.event.pull_request.base.repo.owner.received_events_urlstringoptional
github.event.pull_request.base.repo.owner.repos_urlstringoptional
github.event.pull_request.base.repo.owner.site_adminbooleanoptional
github.event.pull_request.base.repo.owner.starred_urlstringoptional
github.event.pull_request.base.repo.owner.subscriptions_urlstringoptional
github.event.pull_request.base.repo.owner.typeBot, User, Organizationoptional
github.event.pull_request.base.repo.owner.urlstringoptional
github.event.pull_request.base.repo.publicbooleanoptional
github.event.pull_request.base.repo.pushed_atnull or integer or stringrequired
github.event.pull_request.base.repo.role_namestring or nulloptional
github.event.pull_request.base.repo.squash_merge_commit_messagePR_BODY, COMMIT_MESSAGES, BLANKoptional

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request’s body.
  • COMMIT_MESSAGES - default to the branch’s commit messages.
  • BLANK - default to a blank commit message.
github.event.pull_request.base.repo.squash_merge_commit_titlePR_TITLE, COMMIT_OR_PR_TITLEoptional

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request’s title.
  • COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
github.event.pull_request.base.repo.stargazersintegeroptional
github.event.pull_request.base.repo.topicsarray of stringsrequired
github.event.pull_request.base.repo.use_squash_pr_title_as_defaultbooleanoptional

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

github.event.pull_request.base.repo.visibilitypublic, private, internalrequired
github.event.pull_request.base.userobject or nullrequired
github.event.pull_request.base.user.avatar_urlstringoptional
github.event.pull_request.base.user.deletedbooleanoptional
github.event.pull_request.base.user.emailstring or nulloptional
github.event.pull_request.base.user.events_urlstringoptional
github.event.pull_request.base.user.followers_urlstringoptional
github.event.pull_request.base.user.following_urlstringoptional
github.event.pull_request.base.user.gists_urlstringoptional
github.event.pull_request.base.user.gravatar_idstringoptional
github.event.pull_request.base.user.html_urlstringoptional
github.event.pull_request.base.user.namestringoptional
github.event.pull_request.base.user.node_idstringoptional
github.event.pull_request.base.user.organizations_urlstringoptional
github.event.pull_request.base.user.received_events_urlstringoptional
github.event.pull_request.base.user.repos_urlstringoptional
github.event.pull_request.base.user.site_adminbooleanoptional
github.event.pull_request.base.user.starred_urlstringoptional
github.event.pull_request.base.user.subscriptions_urlstringoptional
github.event.pull_request.base.user.typeBot, User, Organizationoptional
github.event.pull_request.base.user.urlstringoptional
github.event.pull_request.changed_filesintegeroptional
github.event.pull_request.commentsintegeroptional
github.event.pull_request.commitsintegeroptional
github.event.pull_request.deletionsintegeroptional
github.event.pull_request.draftbooleanrequired

Indicates whether or not the pull request is a draft.

github.event.pull_request.head.labelstring or nullrequired
github.event.pull_request.head.repoobject or nullrequired

A git repository

github.event.pull_request.head.repo.allow_auto_mergebooleanoptional

Whether to allow auto-merge for pull requests.

github.event.pull_request.head.repo.allow_update_branchbooleanoptional
github.event.pull_request.head.repo.created_atinteger or stringrequired
github.event.pull_request.head.repo.delete_branch_on_mergebooleanoptional

Whether to delete head branches when pull requests are merged

github.event.pull_request.head.repo.disabledbooleanoptional

Returns whether or not this repository is disabled.

github.event.pull_request.head.repo.license.spdx_idstringrequired
github.event.pull_request.head.repo.merge_commit_messagePR_BODY, PR_TITLE, BLANKoptional

The default value for a merge commit message.

  • PR_TITLE - default to the pull request’s title.
  • PR_BODY - default to the pull request’s body.
  • BLANK - default to a blank commit message.
github.event.pull_request.head.repo.merge_commit_titlePR_TITLE, MERGE_MESSAGEoptional

The default value for a merge commit title.

  • PR_TITLE - default to the pull request’s title.
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
github.event.pull_request.head.repo.organizationstringoptional
github.event.pull_request.head.repo.ownerobject or nullrequired
github.event.pull_request.head.repo.owner.avatar_urlstringoptional
github.event.pull_request.head.repo.owner.deletedbooleanoptional
github.event.pull_request.head.repo.owner.emailstring or nulloptional
github.event.pull_request.head.repo.owner.events_urlstringoptional
github.event.pull_request.head.repo.owner.followers_urlstringoptional
github.event.pull_request.head.repo.owner.following_urlstringoptional
github.event.pull_request.head.repo.owner.gists_urlstringoptional
github.event.pull_request.head.repo.owner.gravatar_idstringoptional
github.event.pull_request.head.repo.owner.html_urlstringoptional
github.event.pull_request.head.repo.owner.namestringoptional
github.event.pull_request.head.repo.owner.node_idstringoptional
github.event.pull_request.head.repo.owner.organizations_urlstringoptional
github.event.pull_request.head.repo.owner.received_events_urlstringoptional
github.event.pull_request.head.repo.owner.repos_urlstringoptional
github.event.pull_request.head.repo.owner.site_adminbooleanoptional
github.event.pull_request.head.repo.owner.starred_urlstringoptional
github.event.pull_request.head.repo.owner.subscriptions_urlstringoptional
github.event.pull_request.head.repo.owner.typeBot, User, Organizationoptional
github.event.pull_request.head.repo.owner.urlstringoptional
github.event.pull_request.head.repo.publicbooleanoptional
github.event.pull_request.head.repo.pushed_atnull or integer or stringrequired
github.event.pull_request.head.repo.role_namestring or nulloptional
github.event.pull_request.head.repo.squash_merge_commit_messagePR_BODY, COMMIT_MESSAGES, BLANKoptional

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request’s body.
  • COMMIT_MESSAGES - default to the branch’s commit messages.
  • BLANK - default to a blank commit message.
github.event.pull_request.head.repo.squash_merge_commit_titlePR_TITLE, COMMIT_OR_PR_TITLEoptional

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request’s title.
  • COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
github.event.pull_request.head.repo.stargazersintegeroptional
github.event.pull_request.head.repo.topicsarray of stringsrequired
github.event.pull_request.head.repo.use_squash_pr_title_as_defaultbooleanoptional

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

github.event.pull_request.head.repo.visibilitypublic, private, internalrequired
github.event.pull_request.head.userobject or nullrequired
github.event.pull_request.head.user.avatar_urlstringoptional
github.event.pull_request.head.user.deletedbooleanoptional
github.event.pull_request.head.user.emailstring or nulloptional
github.event.pull_request.head.user.events_urlstringoptional
github.event.pull_request.head.user.followers_urlstringoptional
github.event.pull_request.head.user.following_urlstringoptional
github.event.pull_request.head.user.gists_urlstringoptional
github.event.pull_request.head.user.gravatar_idstringoptional
github.event.pull_request.head.user.html_urlstringoptional
github.event.pull_request.head.user.namestringoptional
github.event.pull_request.head.user.node_idstringoptional
github.event.pull_request.head.user.organizations_urlstringoptional
github.event.pull_request.head.user.received_events_urlstringoptional
github.event.pull_request.head.user.repos_urlstringoptional
github.event.pull_request.head.user.site_adminbooleanoptional
github.event.pull_request.head.user.starred_urlstringoptional
github.event.pull_request.head.user.subscriptions_urlstringoptional
github.event.pull_request.head.user.typeBot, User, Organizationoptional
github.event.pull_request.head.user.urlstringoptional
github.event.pull_request.maintainer_can_modifybooleanoptional

Indicates whether maintainers can modify the pull request.

github.event.pull_request.mergeableboolean or nulloptional
github.event.pull_request.mergeable_statestringoptional
github.event.pull_request.mergedboolean or nulloptional
github.event.pull_request.merged_byobject or nulloptional
github.event.pull_request.merged_by.avatar_urlstringoptional
github.event.pull_request.merged_by.deletedbooleanoptional
github.event.pull_request.merged_by.events_urlstringoptional
github.event.pull_request.merged_by.followers_urlstringoptional
github.event.pull_request.merged_by.following_urlstringoptional
github.event.pull_request.merged_by.gists_urlstringoptional
github.event.pull_request.merged_by.gravatar_idstringoptional
github.event.pull_request.merged_by.html_urlstringoptional
github.event.pull_request.merged_by.namestringoptional
github.event.pull_request.merged_by.node_idstringoptional
github.event.pull_request.merged_by.organizations_urlstringoptional
github.event.pull_request.merged_by.received_events_urlstringoptional
github.event.pull_request.merged_by.repos_urlstringoptional
github.event.pull_request.merged_by.site_adminbooleanoptional
github.event.pull_request.merged_by.starred_urlstringoptional
github.event.pull_request.merged_by.subscriptions_urlstringoptional
github.event.pull_request.merged_by.typeBot, User, Organization, Mannequinoptional
github.event.pull_request.merged_by.urlstringoptional
github.event.pull_request.milestoneobject or nullrequired

A collection of related issues and pull requests.

github.event.pull_request.milestone.creatorobject or nullrequired
github.event.pull_request.milestone.creator.avatar_urlstringoptional
github.event.pull_request.milestone.creator.deletedbooleanoptional
github.event.pull_request.milestone.creator.events_urlstringoptional
github.event.pull_request.milestone.creator.followers_urlstringoptional
github.event.pull_request.milestone.creator.following_urlstringoptional
github.event.pull_request.milestone.creator.gists_urlstringoptional
github.event.pull_request.milestone.creator.gravatar_idstringoptional
github.event.pull_request.milestone.creator.html_urlstringoptional
github.event.pull_request.milestone.creator.namestringoptional
github.event.pull_request.milestone.creator.node_idstringoptional
github.event.pull_request.milestone.creator.organizations_urlstringoptional
github.event.pull_request.milestone.creator.received_events_urlstringoptional
github.event.pull_request.milestone.creator.repos_urlstringoptional
github.event.pull_request.milestone.creator.site_adminbooleanoptional
github.event.pull_request.milestone.creator.starred_urlstringoptional
github.event.pull_request.milestone.creator.subscriptions_urlstringoptional
github.event.pull_request.milestone.creator.typeBot, User, Organization, Mannequinoptional
github.event.pull_request.milestone.creator.urlstringoptional
github.event.pull_request.requested_reviewersarrayrequired
github.event.pull_request.requested_teamsarray of objectsrequired
github.event.pull_request.requested_teams.deletedbooleanoptional
github.event.pull_request.requested_teams.descriptionstring or nulloptional

Description of the team

github.event.pull_request.requested_teams.html_urlstringoptional
github.event.pull_request.requested_teams.members_urlstringoptional
github.event.pull_request.requested_teams.node_idstringoptional
github.event.pull_request.requested_teams.parentobject or nulloptional
github.event.pull_request.requested_teams.parent.descriptionstring or nullrequired

Description of the team

github.event.pull_request.requested_teams.parent.html_urlstringrequired
github.event.pull_request.requested_teams.parent.idintegerrequired

Unique identifier of the team

github.event.pull_request.requested_teams.parent.members_urlstringrequired
github.event.pull_request.requested_teams.parent.namestringrequired

Name of the team

github.event.pull_request.requested_teams.parent.node_idstringrequired
github.event.pull_request.requested_teams.parent.permissionstringrequired

Permission that the team will have for its repositories

github.event.pull_request.requested_teams.parent.privacyopen, closed, secretrequired
github.event.pull_request.requested_teams.parent.repositories_urlstringrequired
github.event.pull_request.requested_teams.parent.slugstringrequired
github.event.pull_request.requested_teams.parent.urlstringrequired

URL for the team

github.event.pull_request.requested_teams.permissionstringoptional

Permission that the team will have for its repositories

github.event.pull_request.requested_teams.privacyopen, closed, secretoptional
github.event.pull_request.requested_teams.repositories_urlstringoptional
github.event.pull_request.requested_teams.slugstringoptional
github.event.pull_request.requested_teams.urlstringoptional

URL for the team

github.event.pull_request.review_commentsintegeroptional
github.event.pull_request.userobject or nullrequired
github.event.pull_request.user.avatar_urlstringoptional
github.event.pull_request.user.deletedbooleanoptional
github.event.pull_request.user.events_urlstringoptional
github.event.pull_request.user.followers_urlstringoptional
github.event.pull_request.user.following_urlstringoptional
github.event.pull_request.user.gists_urlstringoptional
github.event.pull_request.user.gravatar_idstringoptional
github.event.pull_request.user.html_urlstringoptional
github.event.pull_request.user.namestringoptional
github.event.pull_request.user.node_idstringoptional
github.event.pull_request.user.organizations_urlstringoptional
github.event.pull_request.user.received_events_urlstringoptional
github.event.pull_request.user.repos_urlstringoptional
github.event.pull_request.user.site_adminbooleanoptional
github.event.pull_request.user.starred_urlstringoptional
github.event.pull_request.user.subscriptions_urlstringoptional
github.event.pull_request.user.typeBot, User, Organization, Mannequinoptional
github.event.pull_request.user.urlstringoptional
github.event.senderobjectrequired

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.

fieldtyperequireddescription
github.event.actionlockedrequired
github.event.installationobjectoptional

The GitHub App installation. Webhook payloads contain the installation property when the event is configured for and sent to a GitHub App. For more information, see “Using webhooks with GitHub Apps."

github.event.pull_request.active_lock_reasonresolved, off-topic, too heated, spam, Nonerequired
github.event.pull_request.additionsintegeroptional
github.event.pull_request.assigneeobject or nullrequired
github.event.pull_request.assignee.avatar_urlstringoptional
github.event.pull_request.assignee.deletedbooleanoptional
github.event.pull_request.assignee.events_urlstringoptional
github.event.pull_request.assignee.followers_urlstringoptional
github.event.pull_request.assignee.following_urlstringoptional
github.event.pull_request.assignee.gists_urlstringoptional
github.event.pull_request.assignee.gravatar_idstringoptional
github.event.pull_request.assignee.html_urlstringoptional
github.event.pull_request.assignee.namestringoptional
github.event.pull_request.assignee.node_idstringoptional
github.event.pull_request.assignee.organizations_urlstringoptional
github.event.pull_request.assignee.received_events_urlstringoptional
github.event.pull_request.assignee.repos_urlstringoptional
github.event.pull_request.assignee.site_adminbooleanoptional
github.event.pull_request.assignee.starred_urlstringoptional
github.event.pull_request.assignee.subscriptions_urlstringoptional
github.event.pull_request.assignee.typeBot, User, Organizationoptional
github.event.pull_request.assignee.urlstringoptional
github.event.pull_request.assigneesarray of object,nullsrequired
github.event.pull_request.auto_merge.commit_messagestring or nullrequired

Commit message for the merge commit.

github.event.pull_request.auto_merge.commit_titlestring or nullrequired

Title for the merge commit message.

github.event.pull_request.auto_merge.enabled_byobject or nullrequired
github.event.pull_request.auto_merge.enabled_by.avatar_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.deletedbooleanoptional
github.event.pull_request.auto_merge.enabled_by.events_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.followers_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.following_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.gists_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.gravatar_idstringoptional
github.event.pull_request.auto_merge.enabled_by.html_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.namestringoptional
github.event.pull_request.auto_merge.enabled_by.node_idstringoptional
github.event.pull_request.auto_merge.enabled_by.organizations_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.received_events_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.repos_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.site_adminbooleanoptional
github.event.pull_request.auto_merge.enabled_by.starred_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.subscriptions_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.typeBot, User, Organizationoptional
github.event.pull_request.auto_merge.enabled_by.urlstringoptional
github.event.pull_request.base.labelstringrequired
github.event.pull_request.base.repo.allow_auto_mergebooleanoptional

Whether to allow auto-merge for pull requests.

github.event.pull_request.base.repo.allow_update_branchbooleanoptional
github.event.pull_request.base.repo.created_atinteger or stringrequired
github.event.pull_request.base.repo.delete_branch_on_mergebooleanoptional

Whether to delete head branches when pull requests are merged

github.event.pull_request.base.repo.disabledbooleanoptional

Returns whether or not this repository is disabled.

github.event.pull_request.base.repo.licenseobject or nullrequired
github.event.pull_request.base.repo.license.spdx_idstringrequired
github.event.pull_request.base.repo.merge_commit_messagePR_BODY, PR_TITLE, BLANKoptional

The default value for a merge commit message.

  • PR_TITLE - default to the pull request’s title.
  • PR_BODY - default to the pull request’s body.
  • BLANK - default to a blank commit message.
github.event.pull_request.base.repo.merge_commit_titlePR_TITLE, MERGE_MESSAGEoptional

The default value for a merge commit title.

  • PR_TITLE - default to the pull request’s title.
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
github.event.pull_request.base.repo.organizationstringoptional
github.event.pull_request.base.repo.ownerobject or nullrequired
github.event.pull_request.base.repo.owner.avatar_urlstringoptional
github.event.pull_request.base.repo.owner.deletedbooleanoptional
github.event.pull_request.base.repo.owner.emailstring or nulloptional
github.event.pull_request.base.repo.owner.events_urlstringoptional
github.event.pull_request.base.repo.owner.followers_urlstringoptional
github.event.pull_request.base.repo.owner.following_urlstringoptional
github.event.pull_request.base.repo.owner.gists_urlstringoptional
github.event.pull_request.base.repo.owner.gravatar_idstringoptional
github.event.pull_request.base.repo.owner.html_urlstringoptional
github.event.pull_request.base.repo.owner.namestringoptional
github.event.pull_request.base.repo.owner.node_idstringoptional
github.event.pull_request.base.repo.owner.organizations_urlstringoptional
github.event.pull_request.base.repo.owner.received_events_urlstringoptional
github.event.pull_request.base.repo.owner.repos_urlstringoptional
github.event.pull_request.base.repo.owner.site_adminbooleanoptional
github.event.pull_request.base.repo.owner.starred_urlstringoptional
github.event.pull_request.base.repo.owner.subscriptions_urlstringoptional
github.event.pull_request.base.repo.owner.typeBot, User, Organizationoptional
github.event.pull_request.base.repo.owner.urlstringoptional
github.event.pull_request.base.repo.publicbooleanoptional
github.event.pull_request.base.repo.pushed_atnull or integer or stringrequired
github.event.pull_request.base.repo.role_namestring or nulloptional
github.event.pull_request.base.repo.squash_merge_commit_messagePR_BODY, COMMIT_MESSAGES, BLANKoptional

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request’s body.
  • COMMIT_MESSAGES - default to the branch’s commit messages.
  • BLANK - default to a blank commit message.
github.event.pull_request.base.repo.squash_merge_commit_titlePR_TITLE, COMMIT_OR_PR_TITLEoptional

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request’s title.
  • COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
github.event.pull_request.base.repo.stargazersintegeroptional
github.event.pull_request.base.repo.topicsarray of stringsrequired
github.event.pull_request.base.repo.use_squash_pr_title_as_defaultbooleanoptional

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

github.event.pull_request.base.repo.visibilitypublic, private, internalrequired
github.event.pull_request.base.userobject or nullrequired
github.event.pull_request.base.user.avatar_urlstringoptional
github.event.pull_request.base.user.deletedbooleanoptional
github.event.pull_request.base.user.emailstring or nulloptional
github.event.pull_request.base.user.events_urlstringoptional
github.event.pull_request.base.user.followers_urlstringoptional
github.event.pull_request.base.user.following_urlstringoptional
github.event.pull_request.base.user.gists_urlstringoptional
github.event.pull_request.base.user.gravatar_idstringoptional
github.event.pull_request.base.user.html_urlstringoptional
github.event.pull_request.base.user.namestringoptional
github.event.pull_request.base.user.node_idstringoptional
github.event.pull_request.base.user.organizations_urlstringoptional
github.event.pull_request.base.user.received_events_urlstringoptional
github.event.pull_request.base.user.repos_urlstringoptional
github.event.pull_request.base.user.site_adminbooleanoptional
github.event.pull_request.base.user.starred_urlstringoptional
github.event.pull_request.base.user.subscriptions_urlstringoptional
github.event.pull_request.base.user.typeBot, User, Organizationoptional
github.event.pull_request.base.user.urlstringoptional
github.event.pull_request.changed_filesintegeroptional
github.event.pull_request.commentsintegeroptional
github.event.pull_request.commitsintegeroptional
github.event.pull_request.deletionsintegeroptional
github.event.pull_request.draftbooleanrequired

Indicates whether or not the pull request is a draft.

github.event.pull_request.head.labelstring or nullrequired
github.event.pull_request.head.repoobject or nullrequired

A git repository

github.event.pull_request.head.repo.allow_auto_mergebooleanoptional

Whether to allow auto-merge for pull requests.

github.event.pull_request.head.repo.allow_update_branchbooleanoptional
github.event.pull_request.head.repo.created_atinteger or stringrequired
github.event.pull_request.head.repo.delete_branch_on_mergebooleanoptional

Whether to delete head branches when pull requests are merged

github.event.pull_request.head.repo.disabledbooleanoptional

Returns whether or not this repository is disabled.

github.event.pull_request.head.repo.license.spdx_idstringrequired
github.event.pull_request.head.repo.merge_commit_messagePR_BODY, PR_TITLE, BLANKoptional

The default value for a merge commit message.

  • PR_TITLE - default to the pull request’s title.
  • PR_BODY - default to the pull request’s body.
  • BLANK - default to a blank commit message.
github.event.pull_request.head.repo.merge_commit_titlePR_TITLE, MERGE_MESSAGEoptional

The default value for a merge commit title.

  • PR_TITLE - default to the pull request’s title.
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
github.event.pull_request.head.repo.organizationstringoptional
github.event.pull_request.head.repo.ownerobject or nullrequired
github.event.pull_request.head.repo.owner.avatar_urlstringoptional
github.event.pull_request.head.repo.owner.deletedbooleanoptional
github.event.pull_request.head.repo.owner.emailstring or nulloptional
github.event.pull_request.head.repo.owner.events_urlstringoptional
github.event.pull_request.head.repo.owner.followers_urlstringoptional
github.event.pull_request.head.repo.owner.following_urlstringoptional
github.event.pull_request.head.repo.owner.gists_urlstringoptional
github.event.pull_request.head.repo.owner.gravatar_idstringoptional
github.event.pull_request.head.repo.owner.html_urlstringoptional
github.event.pull_request.head.repo.owner.namestringoptional
github.event.pull_request.head.repo.owner.node_idstringoptional
github.event.pull_request.head.repo.owner.organizations_urlstringoptional
github.event.pull_request.head.repo.owner.received_events_urlstringoptional
github.event.pull_request.head.repo.owner.repos_urlstringoptional
github.event.pull_request.head.repo.owner.site_adminbooleanoptional
github.event.pull_request.head.repo.owner.starred_urlstringoptional
github.event.pull_request.head.repo.owner.subscriptions_urlstringoptional
github.event.pull_request.head.repo.owner.typeBot, User, Organizationoptional
github.event.pull_request.head.repo.owner.urlstringoptional
github.event.pull_request.head.repo.publicbooleanoptional
github.event.pull_request.head.repo.pushed_atnull or integer or stringrequired
github.event.pull_request.head.repo.role_namestring or nulloptional
github.event.pull_request.head.repo.squash_merge_commit_messagePR_BODY, COMMIT_MESSAGES, BLANKoptional

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request’s body.
  • COMMIT_MESSAGES - default to the branch’s commit messages.
  • BLANK - default to a blank commit message.
github.event.pull_request.head.repo.squash_merge_commit_titlePR_TITLE, COMMIT_OR_PR_TITLEoptional

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request’s title.
  • COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
github.event.pull_request.head.repo.stargazersintegeroptional
github.event.pull_request.head.repo.topicsarray of stringsrequired
github.event.pull_request.head.repo.use_squash_pr_title_as_defaultbooleanoptional

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

github.event.pull_request.head.repo.visibilitypublic, private, internalrequired
github.event.pull_request.head.userobject or nullrequired
github.event.pull_request.head.user.avatar_urlstringoptional
github.event.pull_request.head.user.deletedbooleanoptional
github.event.pull_request.head.user.emailstring or nulloptional
github.event.pull_request.head.user.events_urlstringoptional
github.event.pull_request.head.user.followers_urlstringoptional
github.event.pull_request.head.user.following_urlstringoptional
github.event.pull_request.head.user.gists_urlstringoptional
github.event.pull_request.head.user.gravatar_idstringoptional
github.event.pull_request.head.user.html_urlstringoptional
github.event.pull_request.head.user.namestringoptional
github.event.pull_request.head.user.node_idstringoptional
github.event.pull_request.head.user.organizations_urlstringoptional
github.event.pull_request.head.user.received_events_urlstringoptional
github.event.pull_request.head.user.repos_urlstringoptional
github.event.pull_request.head.user.site_adminbooleanoptional
github.event.pull_request.head.user.starred_urlstringoptional
github.event.pull_request.head.user.subscriptions_urlstringoptional
github.event.pull_request.head.user.typeBot, User, Organizationoptional
github.event.pull_request.head.user.urlstringoptional
github.event.pull_request.maintainer_can_modifybooleanoptional

Indicates whether maintainers can modify the pull request.

github.event.pull_request.mergeableboolean or nulloptional
github.event.pull_request.mergeable_statestringoptional
github.event.pull_request.mergedboolean or nulloptional
github.event.pull_request.merged_byobject or nulloptional
github.event.pull_request.merged_by.avatar_urlstringoptional
github.event.pull_request.merged_by.deletedbooleanoptional
github.event.pull_request.merged_by.events_urlstringoptional
github.event.pull_request.merged_by.followers_urlstringoptional
github.event.pull_request.merged_by.following_urlstringoptional
github.event.pull_request.merged_by.gists_urlstringoptional
github.event.pull_request.merged_by.gravatar_idstringoptional
github.event.pull_request.merged_by.html_urlstringoptional
github.event.pull_request.merged_by.namestringoptional
github.event.pull_request.merged_by.node_idstringoptional
github.event.pull_request.merged_by.organizations_urlstringoptional
github.event.pull_request.merged_by.received_events_urlstringoptional
github.event.pull_request.merged_by.repos_urlstringoptional
github.event.pull_request.merged_by.site_adminbooleanoptional
github.event.pull_request.merged_by.starred_urlstringoptional
github.event.pull_request.merged_by.subscriptions_urlstringoptional
github.event.pull_request.merged_by.typeBot, User, Organization, Mannequinoptional
github.event.pull_request.merged_by.urlstringoptional
github.event.pull_request.milestoneobject or nullrequired

A collection of related issues and pull requests.

github.event.pull_request.milestone.creatorobject or nullrequired
github.event.pull_request.milestone.creator.avatar_urlstringoptional
github.event.pull_request.milestone.creator.deletedbooleanoptional
github.event.pull_request.milestone.creator.events_urlstringoptional
github.event.pull_request.milestone.creator.followers_urlstringoptional
github.event.pull_request.milestone.creator.following_urlstringoptional
github.event.pull_request.milestone.creator.gists_urlstringoptional
github.event.pull_request.milestone.creator.gravatar_idstringoptional
github.event.pull_request.milestone.creator.html_urlstringoptional
github.event.pull_request.milestone.creator.namestringoptional
github.event.pull_request.milestone.creator.node_idstringoptional
github.event.pull_request.milestone.creator.organizations_urlstringoptional
github.event.pull_request.milestone.creator.received_events_urlstringoptional
github.event.pull_request.milestone.creator.repos_urlstringoptional
github.event.pull_request.milestone.creator.site_adminbooleanoptional
github.event.pull_request.milestone.creator.starred_urlstringoptional
github.event.pull_request.milestone.creator.subscriptions_urlstringoptional
github.event.pull_request.milestone.creator.typeBot, User, Organizationoptional
github.event.pull_request.milestone.creator.urlstringoptional
github.event.pull_request.requested_reviewersarrayrequired
github.event.pull_request.requested_teamsarray of objectsrequired
github.event.pull_request.requested_teams.deletedbooleanoptional
github.event.pull_request.requested_teams.descriptionstring or nulloptional

Description of the team

github.event.pull_request.requested_teams.html_urlstringoptional
github.event.pull_request.requested_teams.members_urlstringoptional
github.event.pull_request.requested_teams.node_idstringoptional
github.event.pull_request.requested_teams.parentobject or nulloptional
github.event.pull_request.requested_teams.parent.descriptionstring or nullrequired

Description of the team

github.event.pull_request.requested_teams.parent.html_urlstringrequired
github.event.pull_request.requested_teams.parent.idintegerrequired

Unique identifier of the team

github.event.pull_request.requested_teams.parent.members_urlstringrequired
github.event.pull_request.requested_teams.parent.namestringrequired

Name of the team

github.event.pull_request.requested_teams.parent.node_idstringrequired
github.event.pull_request.requested_teams.parent.permissionstringrequired

Permission that the team will have for its repositories

github.event.pull_request.requested_teams.parent.privacyopen, closed, secretrequired
github.event.pull_request.requested_teams.parent.repositories_urlstringrequired
github.event.pull_request.requested_teams.parent.slugstringrequired
github.event.pull_request.requested_teams.parent.urlstringrequired

URL for the team

github.event.pull_request.requested_teams.permissionstringoptional

Permission that the team will have for its repositories

github.event.pull_request.requested_teams.privacyopen, closed, secretoptional
github.event.pull_request.requested_teams.repositories_urlstringoptional
github.event.pull_request.requested_teams.slugstringoptional
github.event.pull_request.requested_teams.urlstringoptional

URL for the team

github.event.pull_request.review_commentsintegeroptional
github.event.pull_request.userobject or nullrequired
github.event.pull_request.user.avatar_urlstringoptional
github.event.pull_request.user.deletedbooleanoptional
github.event.pull_request.user.events_urlstringoptional
github.event.pull_request.user.followers_urlstringoptional
github.event.pull_request.user.following_urlstringoptional
github.event.pull_request.user.gists_urlstringoptional
github.event.pull_request.user.gravatar_idstringoptional
github.event.pull_request.user.html_urlstringoptional
github.event.pull_request.user.namestringoptional
github.event.pull_request.user.node_idstringoptional
github.event.pull_request.user.organizations_urlstringoptional
github.event.pull_request.user.received_events_urlstringoptional
github.event.pull_request.user.repos_urlstringoptional
github.event.pull_request.user.site_adminbooleanoptional
github.event.pull_request.user.starred_urlstringoptional
github.event.pull_request.user.subscriptions_urlstringoptional
github.event.pull_request.user.typeBot, User, Organization, Mannequinoptional
github.event.pull_request.user.urlstringoptional
github.event.senderobjectrequired

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.

fieldtyperequireddescription
github.event.actionmilestonedrequired
github.event.milestoneobjectoptional

A collection of related issues and pull requests.

github.event.milestone.urlstringrequired
github.event.milestone.html_urlstringrequired
github.event.milestone.labels_urlstringrequired
github.event.milestone.idintegerrequired
github.event.milestone.node_idstringrequired
github.event.milestone.numberintegerrequired

The number of the milestone.

github.event.milestone.stateopen, closedrequired

The state of the milestone.

github.event.milestone.titlestringrequired

The title of the milestone.

github.event.milestone.descriptionstring or nullrequired
github.event.milestone.creatorobjectrequired

A GitHub user.

github.event.milestone.creator.namestring or nulloptional
github.event.milestone.creator.emailstring or nulloptional
github.event.milestone.creator.loginstringrequired
github.event.milestone.creator.idintegerrequired
github.event.milestone.creator.node_idstringrequired
github.event.milestone.creator.avatar_urlstringrequired
github.event.milestone.creator.gravatar_idstring or nullrequired
github.event.milestone.creator.urlstringrequired
github.event.milestone.creator.html_urlstringrequired
github.event.milestone.creator.followers_urlstringrequired
github.event.milestone.creator.following_urlstringrequired
github.event.milestone.creator.gists_urlstringrequired
github.event.milestone.creator.starred_urlstringrequired
github.event.milestone.creator.subscriptions_urlstringrequired
github.event.milestone.creator.organizations_urlstringrequired
github.event.milestone.creator.repos_urlstringrequired
github.event.milestone.creator.events_urlstringrequired
github.event.milestone.creator.received_events_urlstringrequired
github.event.milestone.creator.typestringrequired
github.event.milestone.creator.site_adminbooleanrequired
github.event.milestone.creator.starred_atstringoptional
github.event.milestone.open_issuesintegerrequired
github.event.milestone.closed_issuesintegerrequired
github.event.milestone.created_atstringrequired
github.event.milestone.updated_atstringrequired
github.event.milestone.closed_atstring or nullrequired
github.event.milestone.due_onstring or nullrequired
github.event.pull_request.active_lock_reasonresolved, off-topic, too heated, spam, Nonerequired
github.event.pull_request.additionsintegeroptional
github.event.pull_request.assigneeobject or nullrequired
github.event.pull_request.assignee.avatar_urlstringoptional
github.event.pull_request.assignee.deletedbooleanoptional
github.event.pull_request.assignee.events_urlstringoptional
github.event.pull_request.assignee.followers_urlstringoptional
github.event.pull_request.assignee.following_urlstringoptional
github.event.pull_request.assignee.gists_urlstringoptional
github.event.pull_request.assignee.gravatar_idstringoptional
github.event.pull_request.assignee.html_urlstringoptional
github.event.pull_request.assignee.namestringoptional
github.event.pull_request.assignee.node_idstringoptional
github.event.pull_request.assignee.organizations_urlstringoptional
github.event.pull_request.assignee.received_events_urlstringoptional
github.event.pull_request.assignee.repos_urlstringoptional
github.event.pull_request.assignee.site_adminbooleanoptional
github.event.pull_request.assignee.starred_urlstringoptional
github.event.pull_request.assignee.subscriptions_urlstringoptional
github.event.pull_request.assignee.typeBot, User, Organization, Mannequinoptional
github.event.pull_request.assignee.urlstringoptional
github.event.pull_request.assigneesarray of object,nullsrequired
github.event.pull_request.auto_merge.commit_messagestring or nullrequired

Commit message for the merge commit.

github.event.pull_request.auto_merge.commit_titlestring or nullrequired

Title for the merge commit message.

github.event.pull_request.auto_merge.enabled_byobject or nullrequired
github.event.pull_request.auto_merge.enabled_by.avatar_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.deletedbooleanoptional
github.event.pull_request.auto_merge.enabled_by.events_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.followers_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.following_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.gists_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.gravatar_idstringoptional
github.event.pull_request.auto_merge.enabled_by.html_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.namestringoptional
github.event.pull_request.auto_merge.enabled_by.node_idstringoptional
github.event.pull_request.auto_merge.enabled_by.organizations_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.received_events_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.repos_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.site_adminbooleanoptional
github.event.pull_request.auto_merge.enabled_by.starred_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.subscriptions_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.typeBot, User, Organizationoptional
github.event.pull_request.auto_merge.enabled_by.urlstringoptional
github.event.pull_request.base.labelstringrequired
github.event.pull_request.base.repo.allow_auto_mergebooleanoptional

Whether to allow auto-merge for pull requests.

github.event.pull_request.base.repo.allow_update_branchbooleanoptional
github.event.pull_request.base.repo.created_atinteger or stringrequired
github.event.pull_request.base.repo.delete_branch_on_mergebooleanoptional

Whether to delete head branches when pull requests are merged

github.event.pull_request.base.repo.disabledbooleanoptional

Returns whether or not this repository is disabled.

github.event.pull_request.base.repo.licenseobject or nullrequired
github.event.pull_request.base.repo.license.spdx_idstringrequired
github.event.pull_request.base.repo.merge_commit_messagePR_BODY, PR_TITLE, BLANKoptional

The default value for a merge commit message.

  • PR_TITLE - default to the pull request’s title.
  • PR_BODY - default to the pull request’s body.
  • BLANK - default to a blank commit message.
github.event.pull_request.base.repo.merge_commit_titlePR_TITLE, MERGE_MESSAGEoptional

The default value for a merge commit title.

  • PR_TITLE - default to the pull request’s title.
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
github.event.pull_request.base.repo.organizationstringoptional
github.event.pull_request.base.repo.ownerobject or nullrequired
github.event.pull_request.base.repo.owner.avatar_urlstringoptional
github.event.pull_request.base.repo.owner.deletedbooleanoptional
github.event.pull_request.base.repo.owner.emailstring or nulloptional
github.event.pull_request.base.repo.owner.events_urlstringoptional
github.event.pull_request.base.repo.owner.followers_urlstringoptional
github.event.pull_request.base.repo.owner.following_urlstringoptional
github.event.pull_request.base.repo.owner.gists_urlstringoptional
github.event.pull_request.base.repo.owner.gravatar_idstringoptional
github.event.pull_request.base.repo.owner.html_urlstringoptional
github.event.pull_request.base.repo.owner.namestringoptional
github.event.pull_request.base.repo.owner.node_idstringoptional
github.event.pull_request.base.repo.owner.organizations_urlstringoptional
github.event.pull_request.base.repo.owner.received_events_urlstringoptional
github.event.pull_request.base.repo.owner.repos_urlstringoptional
github.event.pull_request.base.repo.owner.site_adminbooleanoptional
github.event.pull_request.base.repo.owner.starred_urlstringoptional
github.event.pull_request.base.repo.owner.subscriptions_urlstringoptional
github.event.pull_request.base.repo.owner.typeBot, User, Organizationoptional
github.event.pull_request.base.repo.owner.urlstringoptional
github.event.pull_request.base.repo.publicbooleanoptional
github.event.pull_request.base.repo.pushed_atnull or integer or stringrequired
github.event.pull_request.base.repo.role_namestring or nulloptional
github.event.pull_request.base.repo.squash_merge_commit_messagePR_BODY, COMMIT_MESSAGES, BLANKoptional

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request’s body.
  • COMMIT_MESSAGES - default to the branch’s commit messages.
  • BLANK - default to a blank commit message.
github.event.pull_request.base.repo.squash_merge_commit_titlePR_TITLE, COMMIT_OR_PR_TITLEoptional

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request’s title.
  • COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
github.event.pull_request.base.repo.stargazersintegeroptional
github.event.pull_request.base.repo.topicsarray of stringsrequired
github.event.pull_request.base.repo.use_squash_pr_title_as_defaultbooleanoptional

Whether a squash merge commit can use the pull request title as default.

github.event.pull_request.base.repo.visibilitypublic, private, internalrequired
github.event.pull_request.base.userobject or nullrequired
github.event.pull_request.base.user.avatar_urlstringoptional
github.event.pull_request.base.user.deletedbooleanoptional
github.event.pull_request.base.user.emailstring or nulloptional
github.event.pull_request.base.user.events_urlstringoptional
github.event.pull_request.base.user.followers_urlstringoptional
github.event.pull_request.base.user.following_urlstringoptional
github.event.pull_request.base.user.gists_urlstringoptional
github.event.pull_request.base.user.gravatar_idstringoptional
github.event.pull_request.base.user.html_urlstringoptional
github.event.pull_request.base.user.namestringoptional
github.event.pull_request.base.user.node_idstringoptional
github.event.pull_request.base.user.organizations_urlstringoptional
github.event.pull_request.base.user.received_events_urlstringoptional
github.event.pull_request.base.user.repos_urlstringoptional
github.event.pull_request.base.user.site_adminbooleanoptional
github.event.pull_request.base.user.starred_urlstringoptional
github.event.pull_request.base.user.subscriptions_urlstringoptional
github.event.pull_request.base.user.typeBot, User, Organizationoptional
github.event.pull_request.base.user.urlstringoptional
github.event.pull_request.changed_filesintegeroptional
github.event.pull_request.commentsintegeroptional
github.event.pull_request.commitsintegeroptional
github.event.pull_request.deletionsintegeroptional
github.event.pull_request.draftbooleanrequired

Indicates whether or not the pull request is a draft.

github.event.pull_request.head.labelstringrequired
github.event.pull_request.head.repoobjectrequired

A git repository

github.event.pull_request.head.repo.allow_auto_mergebooleanoptional

Whether to allow auto-merge for pull requests.

github.event.pull_request.head.repo.allow_update_branchbooleanoptional
github.event.pull_request.head.repo.created_atinteger or stringrequired
github.event.pull_request.head.repo.delete_branch_on_mergebooleanoptional

Whether to delete head branches when pull requests are merged

github.event.pull_request.head.repo.disabledbooleanoptional

Returns whether or not this repository is disabled.

github.event.pull_request.head.repo.license.spdx_idstringrequired
github.event.pull_request.head.repo.merge_commit_messagePR_BODY, PR_TITLE, BLANKoptional

The default value for a merge commit message.

  • PR_TITLE - default to the pull request’s title.
  • PR_BODY - default to the pull request’s body.
  • BLANK - default to a blank commit message.
github.event.pull_request.head.repo.merge_commit_titlePR_TITLE, MERGE_MESSAGEoptional

The default value for a merge commit title.

  • PR_TITLE - default to the pull request’s title.
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
github.event.pull_request.head.repo.organizationstringoptional
github.event.pull_request.head.repo.ownerobject or nullrequired
github.event.pull_request.head.repo.owner.avatar_urlstringoptional
github.event.pull_request.head.repo.owner.deletedbooleanoptional
github.event.pull_request.head.repo.owner.emailstring or nulloptional
github.event.pull_request.head.repo.owner.events_urlstringoptional
github.event.pull_request.head.repo.owner.followers_urlstringoptional
github.event.pull_request.head.repo.owner.following_urlstringoptional
github.event.pull_request.head.repo.owner.gists_urlstringoptional
github.event.pull_request.head.repo.owner.gravatar_idstringoptional
github.event.pull_request.head.repo.owner.html_urlstringoptional
github.event.pull_request.head.repo.owner.namestringoptional
github.event.pull_request.head.repo.owner.node_idstringoptional
github.event.pull_request.head.repo.owner.organizations_urlstringoptional
github.event.pull_request.head.repo.owner.received_events_urlstringoptional
github.event.pull_request.head.repo.owner.repos_urlstringoptional
github.event.pull_request.head.repo.owner.site_adminbooleanoptional
github.event.pull_request.head.repo.owner.starred_urlstringoptional
github.event.pull_request.head.repo.owner.subscriptions_urlstringoptional
github.event.pull_request.head.repo.owner.typeBot, User, Organizationoptional
github.event.pull_request.head.repo.owner.urlstringoptional
github.event.pull_request.head.repo.publicbooleanoptional
github.event.pull_request.head.repo.pushed_atnull or integer or stringrequired
github.event.pull_request.head.repo.role_namestring or nulloptional
github.event.pull_request.head.repo.squash_merge_commit_messagePR_BODY, COMMIT_MESSAGES, BLANKoptional

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request’s body.
  • COMMIT_MESSAGES - default to the branch’s commit messages.
  • BLANK - default to a blank commit message.
github.event.pull_request.head.repo.squash_merge_commit_titlePR_TITLE, COMMIT_OR_PR_TITLEoptional

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request’s title.
  • COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
github.event.pull_request.head.repo.stargazersintegeroptional
github.event.pull_request.head.repo.topicsarray of stringsrequired
github.event.pull_request.head.repo.use_squash_pr_title_as_defaultbooleanoptional

Whether a squash merge commit can use the pull request title as default.

github.event.pull_request.head.repo.visibilitypublic, private, internalrequired
github.event.pull_request.head.userobject or nullrequired
github.event.pull_request.head.user.avatar_urlstringoptional
github.event.pull_request.head.user.deletedbooleanoptional
github.event.pull_request.head.user.emailstring or nulloptional
github.event.pull_request.head.user.events_urlstringoptional
github.event.pull_request.head.user.followers_urlstringoptional
github.event.pull_request.head.user.following_urlstringoptional
github.event.pull_request.head.user.gists_urlstringoptional
github.event.pull_request.head.user.gravatar_idstringoptional
github.event.pull_request.head.user.html_urlstringoptional
github.event.pull_request.head.user.namestringoptional
github.event.pull_request.head.user.node_idstringoptional
github.event.pull_request.head.user.organizations_urlstringoptional
github.event.pull_request.head.user.received_events_urlstringoptional
github.event.pull_request.head.user.repos_urlstringoptional
github.event.pull_request.head.user.site_adminbooleanoptional
github.event.pull_request.head.user.starred_urlstringoptional
github.event.pull_request.head.user.subscriptions_urlstringoptional
github.event.pull_request.head.user.typeBot, User, Organizationoptional
github.event.pull_request.head.user.urlstringoptional
github.event.pull_request.maintainer_can_modifybooleanoptional

Indicates whether maintainers can modify the pull request.

github.event.pull_request.mergeableboolean or nulloptional
github.event.pull_request.mergeable_statestringoptional
github.event.pull_request.mergedboolean or nulloptional
github.event.pull_request.merged_byobject or nulloptional
github.event.pull_request.merged_by.avatar_urlstringoptional
github.event.pull_request.merged_by.deletedbooleanoptional
github.event.pull_request.merged_by.events_urlstringoptional
github.event.pull_request.merged_by.followers_urlstringoptional
github.event.pull_request.merged_by.following_urlstringoptional
github.event.pull_request.merged_by.gists_urlstringoptional
github.event.pull_request.merged_by.gravatar_idstringoptional
github.event.pull_request.merged_by.html_urlstringoptional
github.event.pull_request.merged_by.namestringoptional
github.event.pull_request.merged_by.node_idstringoptional
github.event.pull_request.merged_by.organizations_urlstringoptional
github.event.pull_request.merged_by.received_events_urlstringoptional
github.event.pull_request.merged_by.repos_urlstringoptional
github.event.pull_request.merged_by.site_adminbooleanoptional
github.event.pull_request.merged_by.starred_urlstringoptional
github.event.pull_request.merged_by.subscriptions_urlstringoptional
github.event.pull_request.merged_by.typeBot, User, Organization, Mannequinoptional
github.event.pull_request.merged_by.urlstringoptional
github.event.pull_request.milestoneobject or nullrequired

A collection of related issues and pull requests.

github.event.pull_request.milestone.creatorobject or nullrequired
github.event.pull_request.milestone.creator.avatar_urlstringoptional
github.event.pull_request.milestone.creator.deletedbooleanoptional
github.event.pull_request.milestone.creator.events_urlstringoptional
github.event.pull_request.milestone.creator.followers_urlstringoptional
github.event.pull_request.milestone.creator.following_urlstringoptional
github.event.pull_request.milestone.creator.gists_urlstringoptional
github.event.pull_request.milestone.creator.gravatar_idstringoptional
github.event.pull_request.milestone.creator.html_urlstringoptional
github.event.pull_request.milestone.creator.namestringoptional
github.event.pull_request.milestone.creator.node_idstringoptional
github.event.pull_request.milestone.creator.organizations_urlstringoptional
github.event.pull_request.milestone.creator.received_events_urlstringoptional
github.event.pull_request.milestone.creator.repos_urlstringoptional
github.event.pull_request.milestone.creator.site_adminbooleanoptional
github.event.pull_request.milestone.creator.starred_urlstringoptional
github.event.pull_request.milestone.creator.subscriptions_urlstringoptional
github.event.pull_request.milestone.creator.typeBot, User, Organization, Mannequinoptional
github.event.pull_request.milestone.creator.urlstringoptional
github.event.pull_request.requested_reviewersarrayrequired
github.event.pull_request.requested_teamsarray of objectsrequired
github.event.pull_request.requested_teams.deletedbooleanoptional
github.event.pull_request.requested_teams.descriptionstring or nulloptional

Description of the team

github.event.pull_request.requested_teams.html_urlstringoptional
github.event.pull_request.requested_teams.members_urlstringoptional
github.event.pull_request.requested_teams.node_idstringoptional
github.event.pull_request.requested_teams.parentobject or nulloptional
github.event.pull_request.requested_teams.parent.descriptionstring or nullrequired

Description of the team

github.event.pull_request.requested_teams.parent.html_urlstringrequired
github.event.pull_request.requested_teams.parent.idintegerrequired

Unique identifier of the team

github.event.pull_request.requested_teams.parent.members_urlstringrequired
github.event.pull_request.requested_teams.parent.namestringrequired

Name of the team

github.event.pull_request.requested_teams.parent.node_idstringrequired
github.event.pull_request.requested_teams.parent.permissionstringrequired

Permission that the team will have for its repositories

github.event.pull_request.requested_teams.parent.privacyopen, closed, secretrequired
github.event.pull_request.requested_teams.parent.repositories_urlstringrequired
github.event.pull_request.requested_teams.parent.slugstringrequired
github.event.pull_request.requested_teams.parent.urlstringrequired

URL for the team

github.event.pull_request.requested_teams.permissionstringoptional

Permission that the team will have for its repositories

github.event.pull_request.requested_teams.privacyopen, closed, secretoptional
github.event.pull_request.requested_teams.repositories_urlstringoptional
github.event.pull_request.requested_teams.slugstringoptional
github.event.pull_request.requested_teams.urlstringoptional

URL for the team

github.event.pull_request.review_commentsintegeroptional
github.event.pull_request.userobject or nullrequired
github.event.pull_request.user.avatar_urlstringoptional
github.event.pull_request.user.deletedbooleanoptional
github.event.pull_request.user.events_urlstringoptional
github.event.pull_request.user.followers_urlstringoptional
github.event.pull_request.user.following_urlstringoptional
github.event.pull_request.user.gists_urlstringoptional
github.event.pull_request.user.gravatar_idstringoptional
github.event.pull_request.user.html_urlstringoptional
github.event.pull_request.user.namestringoptional
github.event.pull_request.user.node_idstringoptional
github.event.pull_request.user.organizations_urlstringoptional
github.event.pull_request.user.received_events_urlstringoptional
github.event.pull_request.user.repos_urlstringoptional
github.event.pull_request.user.site_adminbooleanoptional
github.event.pull_request.user.starred_urlstringoptional
github.event.pull_request.user.subscriptions_urlstringoptional
github.event.pull_request.user.typeBot, User, Organization, Mannequinoptional
github.event.pull_request.user.urlstringoptional
github.event.senderobjectoptional

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.

fieldtyperequireddescription
github.event.actionopenedrequired
github.event.installationobjectoptional

The GitHub App installation. Webhook payloads contain the installation property when the event is configured for and sent to a GitHub App. For more information, see “Using webhooks with GitHub Apps."

github.event.pull_request.userobjectrequired

A GitHub user.

github.event.pull_request.user.namestring or nulloptional
github.event.pull_request.user.node_idstringrequired
github.event.pull_request.user.avatar_urlstringrequired
github.event.pull_request.user.gravatar_idstring or nullrequired
github.event.pull_request.user.urlstringrequired
github.event.pull_request.user.html_urlstringrequired
github.event.pull_request.user.followers_urlstringrequired
github.event.pull_request.user.following_urlstringrequired
github.event.pull_request.user.gists_urlstringrequired
github.event.pull_request.user.starred_urlstringrequired
github.event.pull_request.user.subscriptions_urlstringrequired
github.event.pull_request.user.organizations_urlstringrequired
github.event.pull_request.user.repos_urlstringrequired
github.event.pull_request.user.events_urlstringrequired
github.event.pull_request.user.received_events_urlstringrequired
github.event.pull_request.user.typestringrequired
github.event.pull_request.user.site_adminbooleanrequired
github.event.pull_request.user.starred_atstringoptional
github.event.pull_request.milestoneobjectrequired

A collection of related issues and pull requests.

github.event.pull_request.milestone.creatorobjectrequired

A GitHub user.

github.event.pull_request.milestone.creator.namestring or nulloptional
github.event.pull_request.milestone.creator.node_idstringrequired
github.event.pull_request.milestone.creator.avatar_urlstringrequired
github.event.pull_request.milestone.creator.gravatar_idstring or nullrequired
github.event.pull_request.milestone.creator.urlstringrequired
github.event.pull_request.milestone.creator.html_urlstringrequired
github.event.pull_request.milestone.creator.followers_urlstringrequired
github.event.pull_request.milestone.creator.following_urlstringrequired
github.event.pull_request.milestone.creator.gists_urlstringrequired
github.event.pull_request.milestone.creator.starred_urlstringrequired
github.event.pull_request.milestone.creator.subscriptions_urlstringrequired
github.event.pull_request.milestone.creator.organizations_urlstringrequired
github.event.pull_request.milestone.creator.repos_urlstringrequired
github.event.pull_request.milestone.creator.events_urlstringrequired
github.event.pull_request.milestone.creator.received_events_urlstringrequired
github.event.pull_request.milestone.creator.typestringrequired
github.event.pull_request.milestone.creator.site_adminbooleanrequired
github.event.pull_request.milestone.creator.starred_atstringoptional
github.event.pull_request.active_lock_reasonstring or nulloptional
github.event.pull_request.assigneeobjectrequired

A GitHub user.

github.event.pull_request.assignee.namestring or nulloptional
github.event.pull_request.assignee.node_idstringrequired
github.event.pull_request.assignee.avatar_urlstringrequired
github.event.pull_request.assignee.gravatar_idstring or nullrequired
github.event.pull_request.assignee.urlstringrequired
github.event.pull_request.assignee.html_urlstringrequired
github.event.pull_request.assignee.followers_urlstringrequired
github.event.pull_request.assignee.following_urlstringrequired
github.event.pull_request.assignee.gists_urlstringrequired
github.event.pull_request.assignee.starred_urlstringrequired
github.event.pull_request.assignee.subscriptions_urlstringrequired
github.event.pull_request.assignee.organizations_urlstringrequired
github.event.pull_request.assignee.repos_urlstringrequired
github.event.pull_request.assignee.events_urlstringrequired
github.event.pull_request.assignee.received_events_urlstringrequired
github.event.pull_request.assignee.typestringrequired
github.event.pull_request.assignee.site_adminbooleanrequired
github.event.pull_request.assignee.starred_atstringoptional
github.event.pull_request.assigneesarray of objects or nulloptional
github.event.pull_request.assignees.namestring or nulloptional
github.event.pull_request.assignees.emailstring or nulloptional
github.event.pull_request.assignees.loginstringrequired
github.event.pull_request.assignees.idintegerrequired
github.event.pull_request.assignees.node_idstringrequired
github.event.pull_request.assignees.avatar_urlstringrequired
github.event.pull_request.assignees.gravatar_idstring or nullrequired
github.event.pull_request.assignees.urlstringrequired
github.event.pull_request.assignees.html_urlstringrequired
github.event.pull_request.assignees.followers_urlstringrequired
github.event.pull_request.assignees.following_urlstringrequired
github.event.pull_request.assignees.gists_urlstringrequired
github.event.pull_request.assignees.starred_urlstringrequired
github.event.pull_request.assignees.subscriptions_urlstringrequired
github.event.pull_request.assignees.organizations_urlstringrequired
github.event.pull_request.assignees.repos_urlstringrequired
github.event.pull_request.assignees.events_urlstringrequired
github.event.pull_request.assignees.received_events_urlstringrequired
github.event.pull_request.assignees.typestringrequired
github.event.pull_request.assignees.site_adminbooleanrequired
github.event.pull_request.assignees.starred_atstringoptional
github.event.pull_request.requested_reviewersarray of objects or nulloptional
github.event.pull_request.requested_reviewers.namestring or nulloptional
github.event.pull_request.requested_reviewers.emailstring or nulloptional
github.event.pull_request.requested_reviewers.loginstringrequired
github.event.pull_request.requested_reviewers.idintegerrequired
github.event.pull_request.requested_reviewers.node_idstringrequired
github.event.pull_request.requested_reviewers.avatar_urlstringrequired
github.event.pull_request.requested_reviewers.gravatar_idstring or nullrequired
github.event.pull_request.requested_reviewers.urlstringrequired
github.event.pull_request.requested_reviewers.html_urlstringrequired
github.event.pull_request.requested_reviewers.followers_urlstringrequired
github.event.pull_request.requested_reviewers.following_urlstringrequired
github.event.pull_request.requested_reviewers.gists_urlstringrequired
github.event.pull_request.requested_reviewers.starred_urlstringrequired
github.event.pull_request.requested_reviewers.subscriptions_urlstringrequired
github.event.pull_request.requested_reviewers.organizations_urlstringrequired
github.event.pull_request.requested_reviewers.repos_urlstringrequired
github.event.pull_request.requested_reviewers.events_urlstringrequired
github.event.pull_request.requested_reviewers.received_events_urlstringrequired
github.event.pull_request.requested_reviewers.typestringrequired
github.event.pull_request.requested_reviewers.site_adminbooleanrequired
github.event.pull_request.requested_reviewers.starred_atstringoptional
github.event.pull_request.requested_teamsarray of objects or nulloptional
github.event.pull_request.requested_teams.node_idstringrequired
github.event.pull_request.requested_teams.urlstringrequired

URL for the team

github.event.pull_request.requested_teams.members_urlstringrequired
github.event.pull_request.requested_teams.descriptionstring or nullrequired

Description of the team

github.event.pull_request.requested_teams.permissionstringrequired

Permission that the team will have for its repositories

github.event.pull_request.requested_teams.privacystringoptional

The level of privacy this team should have

github.event.pull_request.requested_teams.notification_settingstringoptional

The notification setting the team has set

github.event.pull_request.requested_teams.html_urlstringrequired
github.event.pull_request.requested_teams.repositories_urlstringrequired
github.event.pull_request.requested_teams.slugstringrequired
github.event.pull_request.requested_teams.ldap_dnstringoptional

Distinguished Name (DN) that team maps to within LDAP environment

github.event.pull_request.head.labelstringrequired
github.event.pull_request.head.repoobject or nullrequired
github.event.pull_request.head.repo.ownerobjectrequired
github.event.pull_request.head.repo.owner.avatar_urlstringrequired
github.event.pull_request.head.repo.owner.events_urlstringrequired
github.event.pull_request.head.repo.owner.followers_urlstringrequired
github.event.pull_request.head.repo.owner.following_urlstringrequired
github.event.pull_request.head.repo.owner.gists_urlstringrequired
github.event.pull_request.head.repo.owner.gravatar_idstring or nullrequired
github.event.pull_request.head.repo.owner.html_urlstringrequired
github.event.pull_request.head.repo.owner.node_idstringrequired
github.event.pull_request.head.repo.owner.organizations_urlstringrequired
github.event.pull_request.head.repo.owner.received_events_urlstringrequired
github.event.pull_request.head.repo.owner.repos_urlstringrequired
github.event.pull_request.head.repo.owner.site_adminbooleanrequired
github.event.pull_request.head.repo.owner.starred_urlstringrequired
github.event.pull_request.head.repo.owner.subscriptions_urlstringrequired
github.event.pull_request.head.repo.owner.typestringrequired
github.event.pull_request.head.repo.owner.urlstringrequired
github.event.pull_request.head.repo.disabledbooleanrequired
github.event.pull_request.head.repo.visibilitystringoptional

The repository visibility: public, private, or internal.

github.event.pull_request.head.repo.temp_clone_tokenstringoptional
github.event.pull_request.head.repo.license.spdx_idstring or nullrequired
github.event.pull_request.head.repo.pushed_atstringrequired
github.event.pull_request.head.repo.topicsarray of stringsoptional
github.event.pull_request.head.repo.created_atstringrequired
github.event.pull_request.head.userobjectrequired
github.event.pull_request.head.user.avatar_urlstringrequired
github.event.pull_request.head.user.events_urlstringrequired
github.event.pull_request.head.user.followers_urlstringrequired
github.event.pull_request.head.user.following_urlstringrequired
github.event.pull_request.head.user.gists_urlstringrequired
github.event.pull_request.head.user.gravatar_idstring or nullrequired
github.event.pull_request.head.user.html_urlstringrequired
github.event.pull_request.head.user.node_idstringrequired
github.event.pull_request.head.user.organizations_urlstringrequired
github.event.pull_request.head.user.received_events_urlstringrequired
github.event.pull_request.head.user.repos_urlstringrequired
github.event.pull_request.head.user.site_adminbooleanrequired
github.event.pull_request.head.user.starred_urlstringrequired
github.event.pull_request.head.user.subscriptions_urlstringrequired
github.event.pull_request.head.user.typestringrequired
github.event.pull_request.head.user.urlstringrequired
github.event.pull_request.base.labelstringrequired
github.event.pull_request.base.repo.ownerobjectrequired
github.event.pull_request.base.repo.owner.avatar_urlstringrequired
github.event.pull_request.base.repo.owner.events_urlstringrequired
github.event.pull_request.base.repo.owner.followers_urlstringrequired
github.event.pull_request.base.repo.owner.following_urlstringrequired
github.event.pull_request.base.repo.owner.gists_urlstringrequired
github.event.pull_request.base.repo.owner.gravatar_idstring or nullrequired
github.event.pull_request.base.repo.owner.html_urlstringrequired
github.event.pull_request.base.repo.owner.node_idstringrequired
github.event.pull_request.base.repo.owner.organizations_urlstringrequired
github.event.pull_request.base.repo.owner.received_events_urlstringrequired
github.event.pull_request.base.repo.owner.repos_urlstringrequired
github.event.pull_request.base.repo.owner.site_adminbooleanrequired
github.event.pull_request.base.repo.owner.starred_urlstringrequired
github.event.pull_request.base.repo.owner.subscriptions_urlstringrequired
github.event.pull_request.base.repo.owner.typestringrequired
github.event.pull_request.base.repo.owner.urlstringrequired
github.event.pull_request.base.repo.disabledbooleanrequired
github.event.pull_request.base.repo.visibilitystringoptional

The repository visibility: public, private, or internal.

github.event.pull_request.base.repo.temp_clone_tokenstringoptional
github.event.pull_request.base.repo.licenseobjectrequired

License Simple

github.event.pull_request.base.repo.license.spdx_idstring or nullrequired
github.event.pull_request.base.repo.license.html_urlstringoptional
github.event.pull_request.base.repo.pushed_atstringrequired
github.event.pull_request.base.repo.topicsarray of stringsoptional
github.event.pull_request.base.repo.created_atstringrequired
github.event.pull_request.base.userobjectrequired
github.event.pull_request.base.user.avatar_urlstringrequired
github.event.pull_request.base.user.events_urlstringrequired
github.event.pull_request.base.user.followers_urlstringrequired
github.event.pull_request.base.user.following_urlstringrequired
github.event.pull_request.base.user.gists_urlstringrequired
github.event.pull_request.base.user.gravatar_idstring or nullrequired
github.event.pull_request.base.user.html_urlstringrequired
github.event.pull_request.base.user.node_idstringrequired
github.event.pull_request.base.user.organizations_urlstringrequired
github.event.pull_request.base.user.received_events_urlstringrequired
github.event.pull_request.base.user.repos_urlstringrequired
github.event.pull_request.base.user.site_adminbooleanrequired
github.event.pull_request.base.user.starred_urlstringrequired
github.event.pull_request.base.user.subscriptions_urlstringrequired
github.event.pull_request.base.user.typestringrequired
github.event.pull_request.base.user.urlstringrequired
github.event.pull_request.auto_merge.enabled_byobjectrequired

A GitHub user.

github.event.pull_request.auto_merge.enabled_by.namestring or nulloptional
github.event.pull_request.auto_merge.enabled_by.node_idstringrequired
github.event.pull_request.auto_merge.enabled_by.avatar_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.gravatar_idstring or nullrequired
github.event.pull_request.auto_merge.enabled_by.urlstringrequired
github.event.pull_request.auto_merge.enabled_by.html_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.followers_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.following_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.gists_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.starred_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.subscriptions_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.organizations_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.repos_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.events_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.received_events_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.typestringrequired
github.event.pull_request.auto_merge.enabled_by.site_adminbooleanrequired
github.event.pull_request.auto_merge.enabled_by.starred_atstringoptional
github.event.pull_request.auto_merge.commit_titlestringrequired

Title for the merge commit message.

github.event.pull_request.auto_merge.commit_messagestringrequired

Commit message for the merge commit.

github.event.pull_request.draftbooleanoptional

Indicates whether or not the pull request is a draft.

github.event.pull_request.mergedbooleanrequired
github.event.pull_request.mergeableboolean or nullrequired
github.event.pull_request.mergeable_statestringrequired
github.event.pull_request.merged_byobjectrequired

A GitHub user.

github.event.pull_request.merged_by.namestring or nulloptional
github.event.pull_request.merged_by.node_idstringrequired
github.event.pull_request.merged_by.avatar_urlstringrequired
github.event.pull_request.merged_by.gravatar_idstring or nullrequired
github.event.pull_request.merged_by.urlstringrequired
github.event.pull_request.merged_by.html_urlstringrequired
github.event.pull_request.merged_by.followers_urlstringrequired
github.event.pull_request.merged_by.following_urlstringrequired
github.event.pull_request.merged_by.gists_urlstringrequired
github.event.pull_request.merged_by.starred_urlstringrequired
github.event.pull_request.merged_by.subscriptions_urlstringrequired
github.event.pull_request.merged_by.organizations_urlstringrequired
github.event.pull_request.merged_by.repos_urlstringrequired
github.event.pull_request.merged_by.events_urlstringrequired
github.event.pull_request.merged_by.received_events_urlstringrequired
github.event.pull_request.merged_by.typestringrequired
github.event.pull_request.merged_by.site_adminbooleanrequired
github.event.pull_request.merged_by.starred_atstringoptional
github.event.pull_request.commentsintegerrequired
github.event.pull_request.review_commentsintegerrequired
github.event.pull_request.maintainer_can_modifybooleanrequired

Indicates whether maintainers can modify the pull request.

github.event.pull_request.commitsintegerrequired
github.event.pull_request.additionsintegerrequired
github.event.pull_request.deletionsintegerrequired
github.event.pull_request.changed_filesintegerrequired
github.event.pull_request.allow_auto_mergebooleanoptional

Whether to allow auto-merge for pull requests.

github.event.pull_request.allow_update_branchbooleanoptional

Whether to allow updating the pull request’s branch.

github.event.pull_request.delete_branch_on_mergebooleanoptional

Whether to delete head branches when pull requests are merged.

github.event.pull_request.merge_commit_messagePR_BODY, PR_TITLE, BLANKoptional

The default value for a merge commit message.

  • PR_TITLE - default to the pull request’s title.
  • PR_BODY - default to the pull request’s body.
  • BLANK - default to a blank commit message.
github.event.pull_request.merge_commit_titlePR_TITLE, MERGE_MESSAGEoptional

The default value for a merge commit title.

  • PR_TITLE - default to the pull request’s title.
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
github.event.pull_request.squash_merge_commit_messagePR_BODY, COMMIT_MESSAGES, BLANKoptional

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request’s body.
  • COMMIT_MESSAGES - default to the branch’s commit messages.
  • BLANK - default to a blank commit message.
github.event.pull_request.squash_merge_commit_titlePR_TITLE, COMMIT_OR_PR_TITLEoptional

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request’s title.
  • COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
github.event.pull_request.use_squash_pr_title_as_defaultbooleanoptional

Whether a squash merge commit can use the pull request title as default. This property has been deprecated. Please use squash_merge_commit_title instead.

github.event.senderobjectrequired

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.

fieldtyperequireddescription
github.event.actionready_for_reviewrequired
github.event.installationobjectoptional

The GitHub App installation. Webhook payloads contain the installation property when the event is configured for and sent to a GitHub App. For more information, see “Using webhooks with GitHub Apps."

github.event.pull_request.userobjectrequired

A GitHub user.

github.event.pull_request.user.namestring or nulloptional
github.event.pull_request.user.node_idstringrequired
github.event.pull_request.user.avatar_urlstringrequired
github.event.pull_request.user.gravatar_idstring or nullrequired
github.event.pull_request.user.urlstringrequired
github.event.pull_request.user.html_urlstringrequired
github.event.pull_request.user.followers_urlstringrequired
github.event.pull_request.user.following_urlstringrequired
github.event.pull_request.user.gists_urlstringrequired
github.event.pull_request.user.starred_urlstringrequired
github.event.pull_request.user.subscriptions_urlstringrequired
github.event.pull_request.user.organizations_urlstringrequired
github.event.pull_request.user.repos_urlstringrequired
github.event.pull_request.user.events_urlstringrequired
github.event.pull_request.user.received_events_urlstringrequired
github.event.pull_request.user.typestringrequired
github.event.pull_request.user.site_adminbooleanrequired
github.event.pull_request.user.starred_atstringoptional
github.event.pull_request.milestoneobjectrequired

A collection of related issues and pull requests.

github.event.pull_request.milestone.creatorobjectrequired

A GitHub user.

github.event.pull_request.milestone.creator.namestring or nulloptional
github.event.pull_request.milestone.creator.node_idstringrequired
github.event.pull_request.milestone.creator.avatar_urlstringrequired
github.event.pull_request.milestone.creator.gravatar_idstring or nullrequired
github.event.pull_request.milestone.creator.urlstringrequired
github.event.pull_request.milestone.creator.html_urlstringrequired
github.event.pull_request.milestone.creator.followers_urlstringrequired
github.event.pull_request.milestone.creator.following_urlstringrequired
github.event.pull_request.milestone.creator.gists_urlstringrequired
github.event.pull_request.milestone.creator.starred_urlstringrequired
github.event.pull_request.milestone.creator.subscriptions_urlstringrequired
github.event.pull_request.milestone.creator.organizations_urlstringrequired
github.event.pull_request.milestone.creator.repos_urlstringrequired
github.event.pull_request.milestone.creator.events_urlstringrequired
github.event.pull_request.milestone.creator.received_events_urlstringrequired
github.event.pull_request.milestone.creator.typestringrequired
github.event.pull_request.milestone.creator.site_adminbooleanrequired
github.event.pull_request.milestone.creator.starred_atstringoptional
github.event.pull_request.active_lock_reasonstring or nulloptional
github.event.pull_request.assigneeobjectrequired

A GitHub user.

github.event.pull_request.assignee.namestring or nulloptional
github.event.pull_request.assignee.node_idstringrequired
github.event.pull_request.assignee.avatar_urlstringrequired
github.event.pull_request.assignee.gravatar_idstring or nullrequired
github.event.pull_request.assignee.urlstringrequired
github.event.pull_request.assignee.html_urlstringrequired
github.event.pull_request.assignee.followers_urlstringrequired
github.event.pull_request.assignee.following_urlstringrequired
github.event.pull_request.assignee.gists_urlstringrequired
github.event.pull_request.assignee.starred_urlstringrequired
github.event.pull_request.assignee.subscriptions_urlstringrequired
github.event.pull_request.assignee.organizations_urlstringrequired
github.event.pull_request.assignee.repos_urlstringrequired
github.event.pull_request.assignee.events_urlstringrequired
github.event.pull_request.assignee.received_events_urlstringrequired
github.event.pull_request.assignee.typestringrequired
github.event.pull_request.assignee.site_adminbooleanrequired
github.event.pull_request.assignee.starred_atstringoptional
github.event.pull_request.assigneesarray of objects or nulloptional
github.event.pull_request.assignees.namestring or nulloptional
github.event.pull_request.assignees.emailstring or nulloptional
github.event.pull_request.assignees.loginstringrequired
github.event.pull_request.assignees.idintegerrequired
github.event.pull_request.assignees.node_idstringrequired
github.event.pull_request.assignees.avatar_urlstringrequired
github.event.pull_request.assignees.gravatar_idstring or nullrequired
github.event.pull_request.assignees.urlstringrequired
github.event.pull_request.assignees.html_urlstringrequired
github.event.pull_request.assignees.followers_urlstringrequired
github.event.pull_request.assignees.following_urlstringrequired
github.event.pull_request.assignees.gists_urlstringrequired
github.event.pull_request.assignees.starred_urlstringrequired
github.event.pull_request.assignees.subscriptions_urlstringrequired
github.event.pull_request.assignees.organizations_urlstringrequired
github.event.pull_request.assignees.repos_urlstringrequired
github.event.pull_request.assignees.events_urlstringrequired
github.event.pull_request.assignees.received_events_urlstringrequired
github.event.pull_request.assignees.typestringrequired
github.event.pull_request.assignees.site_adminbooleanrequired
github.event.pull_request.assignees.starred_atstringoptional
github.event.pull_request.requested_reviewersarray of objects or nulloptional
github.event.pull_request.requested_reviewers.namestring or nulloptional
github.event.pull_request.requested_reviewers.emailstring or nulloptional
github.event.pull_request.requested_reviewers.loginstringrequired
github.event.pull_request.requested_reviewers.idintegerrequired
github.event.pull_request.requested_reviewers.node_idstringrequired
github.event.pull_request.requested_reviewers.avatar_urlstringrequired
github.event.pull_request.requested_reviewers.gravatar_idstring or nullrequired
github.event.pull_request.requested_reviewers.urlstringrequired
github.event.pull_request.requested_reviewers.html_urlstringrequired
github.event.pull_request.requested_reviewers.followers_urlstringrequired
github.event.pull_request.requested_reviewers.following_urlstringrequired
github.event.pull_request.requested_reviewers.gists_urlstringrequired
github.event.pull_request.requested_reviewers.starred_urlstringrequired
github.event.pull_request.requested_reviewers.subscriptions_urlstringrequired
github.event.pull_request.requested_reviewers.organizations_urlstringrequired
github.event.pull_request.requested_reviewers.repos_urlstringrequired
github.event.pull_request.requested_reviewers.events_urlstringrequired
github.event.pull_request.requested_reviewers.received_events_urlstringrequired
github.event.pull_request.requested_reviewers.typestringrequired
github.event.pull_request.requested_reviewers.site_adminbooleanrequired
github.event.pull_request.requested_reviewers.starred_atstringoptional
github.event.pull_request.requested_teamsarray of objects or nulloptional
github.event.pull_request.requested_teams.node_idstringrequired
github.event.pull_request.requested_teams.urlstringrequired

URL for the team

github.event.pull_request.requested_teams.members_urlstringrequired
github.event.pull_request.requested_teams.descriptionstring or nullrequired

Description of the team

github.event.pull_request.requested_teams.permissionstringrequired

Permission that the team will have for its repositories

github.event.pull_request.requested_teams.privacystringoptional

The level of privacy this team should have

github.event.pull_request.requested_teams.notification_settingstringoptional

The notification setting the team has set

github.event.pull_request.requested_teams.html_urlstringrequired
github.event.pull_request.requested_teams.repositories_urlstringrequired
github.event.pull_request.requested_teams.slugstringrequired
github.event.pull_request.requested_teams.ldap_dnstringoptional

Distinguished Name (DN) that team maps to within LDAP environment

github.event.pull_request.head.labelstringrequired
github.event.pull_request.head.repoobject or nullrequired
github.event.pull_request.head.repo.ownerobjectrequired
github.event.pull_request.head.repo.owner.avatar_urlstringrequired
github.event.pull_request.head.repo.owner.events_urlstringrequired
github.event.pull_request.head.repo.owner.followers_urlstringrequired
github.event.pull_request.head.repo.owner.following_urlstringrequired
github.event.pull_request.head.repo.owner.gists_urlstringrequired
github.event.pull_request.head.repo.owner.gravatar_idstring or nullrequired
github.event.pull_request.head.repo.owner.html_urlstringrequired
github.event.pull_request.head.repo.owner.node_idstringrequired
github.event.pull_request.head.repo.owner.organizations_urlstringrequired
github.event.pull_request.head.repo.owner.received_events_urlstringrequired
github.event.pull_request.head.repo.owner.repos_urlstringrequired
github.event.pull_request.head.repo.owner.site_adminbooleanrequired
github.event.pull_request.head.repo.owner.starred_urlstringrequired
github.event.pull_request.head.repo.owner.subscriptions_urlstringrequired
github.event.pull_request.head.repo.owner.typestringrequired
github.event.pull_request.head.repo.owner.urlstringrequired
github.event.pull_request.head.repo.disabledbooleanrequired
github.event.pull_request.head.repo.visibilitystringoptional

The repository visibility: public, private, or internal.

github.event.pull_request.head.repo.temp_clone_tokenstringoptional
github.event.pull_request.head.repo.license.spdx_idstring or nullrequired
github.event.pull_request.head.repo.pushed_atstringrequired
github.event.pull_request.head.repo.topicsarray of stringsoptional
github.event.pull_request.head.repo.created_atstringrequired
github.event.pull_request.head.userobjectrequired
github.event.pull_request.head.user.avatar_urlstringrequired
github.event.pull_request.head.user.events_urlstringrequired
github.event.pull_request.head.user.followers_urlstringrequired
github.event.pull_request.head.user.following_urlstringrequired
github.event.pull_request.head.user.gists_urlstringrequired
github.event.pull_request.head.user.gravatar_idstring or nullrequired
github.event.pull_request.head.user.html_urlstringrequired
github.event.pull_request.head.user.node_idstringrequired
github.event.pull_request.head.user.organizations_urlstringrequired
github.event.pull_request.head.user.received_events_urlstringrequired
github.event.pull_request.head.user.repos_urlstringrequired
github.event.pull_request.head.user.site_adminbooleanrequired
github.event.pull_request.head.user.starred_urlstringrequired
github.event.pull_request.head.user.subscriptions_urlstringrequired
github.event.pull_request.head.user.typestringrequired
github.event.pull_request.head.user.urlstringrequired
github.event.pull_request.base.labelstringrequired
github.event.pull_request.base.repo.ownerobjectrequired
github.event.pull_request.base.repo.owner.avatar_urlstringrequired
github.event.pull_request.base.repo.owner.events_urlstringrequired
github.event.pull_request.base.repo.owner.followers_urlstringrequired
github.event.pull_request.base.repo.owner.following_urlstringrequired
github.event.pull_request.base.repo.owner.gists_urlstringrequired
github.event.pull_request.base.repo.owner.gravatar_idstring or nullrequired
github.event.pull_request.base.repo.owner.html_urlstringrequired
github.event.pull_request.base.repo.owner.node_idstringrequired
github.event.pull_request.base.repo.owner.organizations_urlstringrequired
github.event.pull_request.base.repo.owner.received_events_urlstringrequired
github.event.pull_request.base.repo.owner.repos_urlstringrequired
github.event.pull_request.base.repo.owner.site_adminbooleanrequired
github.event.pull_request.base.repo.owner.starred_urlstringrequired
github.event.pull_request.base.repo.owner.subscriptions_urlstringrequired
github.event.pull_request.base.repo.owner.typestringrequired
github.event.pull_request.base.repo.owner.urlstringrequired
github.event.pull_request.base.repo.disabledbooleanrequired
github.event.pull_request.base.repo.visibilitystringoptional

The repository visibility: public, private, or internal.

github.event.pull_request.base.repo.temp_clone_tokenstringoptional
github.event.pull_request.base.repo.licenseobjectrequired

License Simple

github.event.pull_request.base.repo.license.spdx_idstring or nullrequired
github.event.pull_request.base.repo.license.html_urlstringoptional
github.event.pull_request.base.repo.pushed_atstringrequired
github.event.pull_request.base.repo.topicsarray of stringsoptional
github.event.pull_request.base.repo.created_atstringrequired
github.event.pull_request.base.userobjectrequired
github.event.pull_request.base.user.avatar_urlstringrequired
github.event.pull_request.base.user.events_urlstringrequired
github.event.pull_request.base.user.followers_urlstringrequired
github.event.pull_request.base.user.following_urlstringrequired
github.event.pull_request.base.user.gists_urlstringrequired
github.event.pull_request.base.user.gravatar_idstring or nullrequired
github.event.pull_request.base.user.html_urlstringrequired
github.event.pull_request.base.user.node_idstringrequired
github.event.pull_request.base.user.organizations_urlstringrequired
github.event.pull_request.base.user.received_events_urlstringrequired
github.event.pull_request.base.user.repos_urlstringrequired
github.event.pull_request.base.user.site_adminbooleanrequired
github.event.pull_request.base.user.starred_urlstringrequired
github.event.pull_request.base.user.subscriptions_urlstringrequired
github.event.pull_request.base.user.typestringrequired
github.event.pull_request.base.user.urlstringrequired
github.event.pull_request.auto_merge.enabled_byobjectrequired

A GitHub user.

github.event.pull_request.auto_merge.enabled_by.namestring or nulloptional
github.event.pull_request.auto_merge.enabled_by.node_idstringrequired
github.event.pull_request.auto_merge.enabled_by.avatar_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.gravatar_idstring or nullrequired
github.event.pull_request.auto_merge.enabled_by.urlstringrequired
github.event.pull_request.auto_merge.enabled_by.html_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.followers_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.following_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.gists_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.starred_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.subscriptions_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.organizations_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.repos_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.events_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.received_events_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.typestringrequired
github.event.pull_request.auto_merge.enabled_by.site_adminbooleanrequired
github.event.pull_request.auto_merge.enabled_by.starred_atstringoptional
github.event.pull_request.auto_merge.commit_titlestringrequired

Title for the merge commit message.

github.event.pull_request.auto_merge.commit_messagestringrequired

Commit message for the merge commit.

github.event.pull_request.draftbooleanoptional

Indicates whether or not the pull request is a draft.

github.event.pull_request.mergedbooleanrequired
github.event.pull_request.mergeableboolean or nullrequired
github.event.pull_request.mergeable_statestringrequired
github.event.pull_request.merged_byobjectrequired

A GitHub user.

github.event.pull_request.merged_by.namestring or nulloptional
github.event.pull_request.merged_by.node_idstringrequired
github.event.pull_request.merged_by.avatar_urlstringrequired
github.event.pull_request.merged_by.gravatar_idstring or nullrequired
github.event.pull_request.merged_by.urlstringrequired
github.event.pull_request.merged_by.html_urlstringrequired
github.event.pull_request.merged_by.followers_urlstringrequired
github.event.pull_request.merged_by.following_urlstringrequired
github.event.pull_request.merged_by.gists_urlstringrequired
github.event.pull_request.merged_by.starred_urlstringrequired
github.event.pull_request.merged_by.subscriptions_urlstringrequired
github.event.pull_request.merged_by.organizations_urlstringrequired
github.event.pull_request.merged_by.repos_urlstringrequired
github.event.pull_request.merged_by.events_urlstringrequired
github.event.pull_request.merged_by.received_events_urlstringrequired
github.event.pull_request.merged_by.typestringrequired
github.event.pull_request.merged_by.site_adminbooleanrequired
github.event.pull_request.merged_by.starred_atstringoptional
github.event.pull_request.commentsintegerrequired
github.event.pull_request.review_commentsintegerrequired
github.event.pull_request.maintainer_can_modifybooleanrequired

Indicates whether maintainers can modify the pull request.

github.event.pull_request.commitsintegerrequired
github.event.pull_request.additionsintegerrequired
github.event.pull_request.deletionsintegerrequired
github.event.pull_request.changed_filesintegerrequired
github.event.pull_request.allow_auto_mergebooleanoptional

Whether to allow auto-merge for pull requests.

github.event.pull_request.allow_update_branchbooleanoptional

Whether to allow updating the pull request’s branch.

github.event.pull_request.delete_branch_on_mergebooleanoptional

Whether to delete head branches when pull requests are merged.

github.event.pull_request.merge_commit_messagePR_BODY, PR_TITLE, BLANKoptional

The default value for a merge commit message.

  • PR_TITLE - default to the pull request’s title.
  • PR_BODY - default to the pull request’s body.
  • BLANK - default to a blank commit message.
github.event.pull_request.merge_commit_titlePR_TITLE, MERGE_MESSAGEoptional

The default value for a merge commit title.

  • PR_TITLE - default to the pull request’s title.
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., “Merge pull request #123 from branch-name”).
github.event.pull_request.squash_merge_commit_messagePR_BODY, COMMIT_MESSAGES, BLANKoptional

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request’s body.
  • COMMIT_MESSAGES - default to the branch’s commit messages.
  • BLANK - default to a blank commit message.
github.event.pull_request.squash_merge_commit_titlePR_TITLE, COMMIT_OR_PR_TITLEoptional

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request’s title.
  • COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
github.event.pull_request.use_squash_pr_title_as_defaultbooleanoptional

Whether a squash merge commit can use the pull request title as default. This property has been deprecated. Please use squash_merge_commit_title instead.

github.event.senderobjectrequired

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.

fieldtyperequireddescription
github.event.actionreopenedrequired
github.event.installationobjectoptional

The GitHub App installation. Webhook payloads contain the installation property when the event is configured for and sent to a GitHub App. For more information, see “Using webhooks with GitHub Apps."

github.event.pull_request.userobjectrequired

A GitHub user.

github.event.pull_request.user.namestring or nulloptional
github.event.pull_request.user.node_idstringrequired
github.event.pull_request.user.avatar_urlstringrequired
github.event.pull_request.user.gravatar_idstring or nullrequired
github.event.pull_request.user.urlstringrequired
github.event.pull_request.user.html_urlstringrequired
github.event.pull_request.user.followers_urlstringrequired
github.event.pull_request.user.following_urlstringrequired
github.event.pull_request.user.gists_urlstringrequired
github.event.pull_request.user.starred_urlstringrequired
github.event.pull_request.user.subscriptions_urlstringrequired
github.event.pull_request.user.organizations_urlstringrequired
github.event.pull_request.user.repos_urlstringrequired
github.event.pull_request.user.events_urlstringrequired
github.event.pull_request.user.received_events_urlstringrequired
github.event.pull_request.user.typestringrequired
github.event.pull_request.user.site_adminbooleanrequired
github.event.pull_request.user.starred_atstringoptional
github.event.pull_request.milestoneobjectrequired

A collection of related issues and pull requests.

github.event.pull_request.milestone.creatorobjectrequired

A GitHub user.

github.event.pull_request.milestone.creator.namestring or nulloptional
github.event.pull_request.milestone.creator.node_idstringrequired
github.event.pull_request.milestone.creator.avatar_urlstringrequired
github.event.pull_request.milestone.creator.gravatar_idstring or nullrequired
github.event.pull_request.milestone.creator.urlstringrequired
github.event.pull_request.milestone.creator.html_urlstringrequired
github.event.pull_request.milestone.creator.followers_urlstringrequired
github.event.pull_request.milestone.creator.following_urlstringrequired
github.event.pull_request.milestone.creator.gists_urlstringrequired
github.event.pull_request.milestone.creator.starred_urlstringrequired
github.event.pull_request.milestone.creator.subscriptions_urlstringrequired
github.event.pull_request.milestone.creator.organizations_urlstringrequired
github.event.pull_request.milestone.creator.repos_urlstringrequired
github.event.pull_request.milestone.creator.events_urlstringrequired
github.event.pull_request.milestone.creator.received_events_urlstringrequired
github.event.pull_request.milestone.creator.typestringrequired
github.event.pull_request.milestone.creator.site_adminbooleanrequired
github.event.pull_request.milestone.creator.starred_atstringoptional
github.event.pull_request.active_lock_reasonstring or nulloptional
github.event.pull_request.assigneeobjectrequired

A GitHub user.

github.event.pull_request.assignee.namestring or nulloptional
github.event.pull_request.assignee.node_idstringrequired
github.event.pull_request.assignee.avatar_urlstringrequired
github.event.pull_request.assignee.gravatar_idstring or nullrequired
github.event.pull_request.assignee.urlstringrequired
github.event.pull_request.assignee.html_urlstringrequired
github.event.pull_request.assignee.followers_urlstringrequired
github.event.pull_request.assignee.following_urlstringrequired
github.event.pull_request.assignee.gists_urlstringrequired
github.event.pull_request.assignee.starred_urlstringrequired
github.event.pull_request.assignee.subscriptions_urlstringrequired
github.event.pull_request.assignee.organizations_urlstringrequired
github.event.pull_request.assignee.repos_urlstringrequired
github.event.pull_request.assignee.events_urlstringrequired
github.event.pull_request.assignee.received_events_urlstringrequired
github.event.pull_request.assignee.typestringrequired
github.event.pull_request.assignee.site_adminbooleanrequired
github.event.pull_request.assignee.starred_atstringoptional
github.event.pull_request.assigneesarray of objects or nulloptional
github.event.pull_request.assignees.namestring or nulloptional
github.event.pull_request.assignees.emailstring or nulloptional
github.event.pull_request.assignees.loginstringrequired
github.event.pull_request.assignees.idintegerrequired
github.event.pull_request.assignees.node_idstringrequired
github.event.pull_request.assignees.avatar_urlstringrequired
github.event.pull_request.assignees.gravatar_idstring or nullrequired
github.event.pull_request.assignees.urlstringrequired
github.event.pull_request.assignees.html_urlstringrequired
github.event.pull_request.assignees.followers_urlstringrequired
github.event.pull_request.assignees.following_urlstringrequired
github.event.pull_request.assignees.gists_urlstringrequired
github.event.pull_request.assignees.starred_urlstringrequired
github.event.pull_request.assignees.subscriptions_urlstringrequired
github.event.pull_request.assignees.organizations_urlstringrequired
github.event.pull_request.assignees.repos_urlstringrequired
github.event.pull_request.assignees.events_urlstringrequired
github.event.pull_request.assignees.received_events_urlstringrequired
github.event.pull_request.assignees.typestringrequired
github.event.pull_request.assignees.site_adminbooleanrequired
github.event.pull_request.assignees.starred_atstringoptional
github.event.pull_request.requested_reviewersarray of objects or nulloptional
github.event.pull_request.requested_reviewers.namestring or nulloptional
github.event.pull_request.requested_reviewers.emailstring or nulloptional
github.event.pull_request.requested_reviewers.loginstringrequired
github.event.pull_request.requested_reviewers.idintegerrequired
github.event.pull_request.requested_reviewers.node_idstringrequired
github.event.pull_request.requested_reviewers.avatar_urlstringrequired
github.event.pull_request.requested_reviewers.gravatar_idstring or nullrequired
github.event.pull_request.requested_reviewers.urlstringrequired
github.event.pull_request.requested_reviewers.html_urlstringrequired
github.event.pull_request.requested_reviewers.followers_urlstringrequired
github.event.pull_request.requested_reviewers.following_urlstringrequired
github.event.pull_request.requested_reviewers.gists_urlstringrequired
github.event.pull_request.requested_reviewers.starred_urlstringrequired
github.event.pull_request.requested_reviewers.subscriptions_urlstringrequired
github.event.pull_request.requested_reviewers.organizations_urlstringrequired
github.event.pull_request.requested_reviewers.repos_urlstringrequired
github.event.pull_request.requested_reviewers.events_urlstringrequired
github.event.pull_request.requested_reviewers.received_events_urlstringrequired
github.event.pull_request.requested_reviewers.typestringrequired
github.event.pull_request.requested_reviewers.site_adminbooleanrequired
github.event.pull_request.requested_reviewers.starred_atstringoptional
github.event.pull_request.requested_teamsarray of objects or nulloptional
github.event.pull_request.requested_teams.node_idstringrequired
github.event.pull_request.requested_teams.urlstringrequired

URL for the team

github.event.pull_request.requested_teams.members_urlstringrequired
github.event.pull_request.requested_teams.descriptionstring or nullrequired

Description of the team

github.event.pull_request.requested_teams.permissionstringrequired

Permission that the team will have for its repositories

github.event.pull_request.requested_teams.privacystringoptional

The level of privacy this team should have

github.event.pull_request.requested_teams.notification_settingstringoptional

The notification setting the team has set

github.event.pull_request.requested_teams.html_urlstringrequired
github.event.pull_request.requested_teams.repositories_urlstringrequired
github.event.pull_request.requested_teams.slugstringrequired
github.event.pull_request.requested_teams.ldap_dnstringoptional

Distinguished Name (DN) that team maps to within LDAP environment

github.event.pull_request.head.labelstringrequired
github.event.pull_request.head.repoobject or nullrequired
github.event.pull_request.head.repo.ownerobjectrequired
github.event.pull_request.head.repo.owner.avatar_urlstringrequired
github.event.pull_request.head.repo.owner.events_urlstringrequired
github.event.pull_request.head.repo.owner.followers_urlstringrequired
github.event.pull_request.head.repo.owner.following_urlstringrequired
github.event.pull_request.head.repo.owner.gists_urlstringrequired
github.event.pull_request.head.repo.owner.gravatar_idstring or nullrequired
github.event.pull_request.head.repo.owner.html_urlstringrequired
github.event.pull_request.head.repo.owner.node_idstringrequired
github.event.pull_request.head.repo.owner.organizations_urlstringrequired
github.event.pull_request.head.repo.owner.received_events_urlstringrequired
github.event.pull_request.head.repo.owner.repos_urlstringrequired
github.event.pull_request.head.repo.owner.site_adminbooleanrequired
github.event.pull_request.head.repo.owner.starred_urlstringrequired
github.event.pull_request.head.repo.owner.subscriptions_urlstringrequired
github.event.pull_request.head.repo.owner.typestringrequired
github.event.pull_request.head.repo.owner.urlstringrequired
github.event.pull_request.head.repo.disabledbooleanrequired
github.event.pull_request.head.repo.visibilitystringoptional

The repository visibility: public, private, or internal.

github.event.pull_request.head.repo.temp_clone_tokenstringoptional
github.event.pull_request.head.repo.license.spdx_idstring or nullrequired
github.event.pull_request.head.repo.pushed_atstringrequired
github.event.pull_request.head.repo.topicsarray of stringsoptional
github.event.pull_request.head.repo.created_atstringrequired
github.event.pull_request.head.userobjectrequired
github.event.pull_request.head.user.avatar_urlstringrequired
github.event.pull_request.head.user.events_urlstringrequired
github.event.pull_request.head.user.followers_urlstringrequired
github.event.pull_request.head.user.following_urlstringrequired
github.event.pull_request.head.user.gists_urlstringrequired
github.event.pull_request.head.user.gravatar_idstring or nullrequired
github.event.pull_request.head.user.html_urlstringrequired
github.event.pull_request.head.user.node_idstringrequired
github.event.pull_request.head.user.organizations_urlstringrequired
github.event.pull_request.head.user.received_events_urlstringrequired
github.event.pull_request.head.user.repos_urlstringrequired
github.event.pull_request.head.user.site_adminbooleanrequired
github.event.pull_request.head.user.starred_urlstringrequired
github.event.pull_request.head.user.subscriptions_urlstringrequired
github.event.pull_request.head.user.typestringrequired
github.event.pull_request.head.user.urlstringrequired
github.event.pull_request.base.labelstringrequired
github.event.pull_request.base.repo.ownerobjectrequired
github.event.pull_request.base.repo.owner.avatar_urlstringrequired
github.event.pull_request.base.repo.owner.events_urlstringrequired
github.event.pull_request.base.repo.owner.followers_urlstringrequired
github.event.pull_request.base.repo.owner.following_urlstringrequired
github.event.pull_request.base.repo.owner.gists_urlstringrequired
github.event.pull_request.base.repo.owner.gravatar_idstring or nullrequired
github.event.pull_request.base.repo.owner.html_urlstringrequired
github.event.pull_request.base.repo.owner.node_idstringrequired
github.event.pull_request.base.repo.owner.organizations_urlstringrequired
github.event.pull_request.base.repo.owner.received_events_urlstringrequired
github.event.pull_request.base.repo.owner.repos_urlstringrequired
github.event.pull_request.base.repo.owner.site_adminbooleanrequired
github.event.pull_request.base.repo.owner.starred_urlstringrequired
github.event.pull_request.base.repo.owner.subscriptions_urlstringrequired
github.event.pull_request.base.repo.owner.typestringrequired
github.event.pull_request.base.repo.owner.urlstringrequired
github.event.pull_request.base.repo.disabledbooleanrequired
github.event.pull_request.base.repo.visibilitystringoptional

The repository visibility: public, private, or internal.

github.event.pull_request.base.repo.temp_clone_tokenstringoptional
github.event.pull_request.base.repo.licenseobjectrequired

License Simple

github.event.pull_request.base.repo.license.spdx_idstring or nullrequired
github.event.pull_request.base.repo.license.html_urlstringoptional
github.event.pull_request.base.repo.pushed_atstringrequired
github.event.pull_request.base.repo.topicsarray of stringsoptional
github.event.pull_request.base.repo.created_atstringrequired
github.event.pull_request.base.userobjectrequired
github.event.pull_request.base.user.avatar_urlstringrequired
github.event.pull_request.base.user.events_urlstringrequired
github.event.pull_request.base.user.followers_urlstringrequired
github.event.pull_request.base.user.following_urlstringrequired
github.event.pull_request.base.user.gists_urlstringrequired
github.event.pull_request.base.user.gravatar_idstring or nullrequired
github.event.pull_request.base.user.html_urlstringrequired
github.event.pull_request.base.user.node_idstringrequired
github.event.pull_request.base.user.organizations_urlstringrequired
github.event.pull_request.base.user.received_events_urlstringrequired
github.event.pull_request.base.user.repos_urlstringrequired
github.event.pull_request.base.user.site_adminbooleanrequired
github.event.pull_request.base.user.starred_urlstringrequired
github.event.pull_request.base.user.subscriptions_urlstringrequired
github.event.pull_request.base.user.typestringrequired
github.event.pull_request.base.user.urlstringrequired
github.event.pull_request.auto_merge.enabled_byobjectrequired

A GitHub user.

github.event.pull_request.auto_merge.enabled_by.namestring or nulloptional
github.event.pull_request.auto_merge.enabled_by.node_idstringrequired
github.event.pull_request.auto_merge.enabled_by.avatar_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.gravatar_idstring or nullrequired
github.event.pull_request.auto_merge.enabled_by.urlstringrequired
github.event.pull_request.auto_merge.enabled_by.html_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.followers_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.following_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.gists_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.starred_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.subscriptions_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.organizations_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.repos_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.events_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.received_events_urlstringrequired
github.event.pull_request.auto_merge.enabled_by.typestringrequired
github.event.pull_request.auto_merge.enabled_by.site_adminbooleanrequired
github.event.pull_request.auto_merge.enabled_by.starred_atstringoptional
github.event.pull_request.auto_merge.commit_titlestringrequired

Title for the merge commit message.

github.event.pull_request.auto_merge.commit_messagestringrequired

Commit message for the merge commit.

github.event.pull_request.draftbooleanoptional

Indicates whether or not the pull request is a draft.

github.event.pull_request.mergedbooleanrequired
github.event.pull_request.mergeableboolean or nullrequired
github.event.pull_request.mergeable_statestringrequired
github.event.pull_request.merged_byobjectrequired

A GitHub user.

github.event.pull_request.merged_by.namestring or nulloptional
github.event.pull_request.merged_by.node_idstringrequired
github.event.pull_request.merged_by.avatar_urlstringrequired
github.event.pull_request.merged_by.gravatar_idstring or nullrequired
github.event.pull_request.merged_by.urlstringrequired
github.event.pull_request.merged_by.html_urlstringrequired
github.event.pull_request.merged_by.followers_urlstringrequired
github.event.pull_request.merged_by.following_urlstringrequired
github.event.pull_request.merged_by.gists_urlstringrequired
github.event.pull_request.merged_by.starred_urlstringrequired
github.event.pull_request.merged_by.subscriptions_urlstringrequired
github.event.pull_request.merged_by.organizations_urlstringrequired
github.event.pull_request.merged_by.repos_urlstringrequired
github.event.pull_request.merged_by.events_urlstringrequired
github.event.pull_request.merged_by.received_events_urlstringrequired
github.event.pull_request.merged_by.typestringrequired
github.event.pull_request.merged_by.site_adminbooleanrequired
github.event.pull_request.merged_by.starred_atstringoptional
github.event.pull_request.commentsintegerrequired
github.event.pull_request.review_commentsintegerrequired
github.event.pull_request.maintainer_can_modifybooleanrequired

Indicates whether maintainers can modify the pull request.

github.event.pull_request.commitsintegerrequired
github.event.pull_request.additionsintegerrequired
github.event.pull_request.deletionsintegerrequired
github.event.pull_request.changed_filesintegerrequired
github.event.pull_request.allow_auto_mergebooleanoptional

Whether to allow auto-merge for pull requests.

github.event.pull_request.allow_update_branchbooleanoptional

Whether to allow updating the pull request’s branch.

github.event.pull_request.delete_branch_on_mergebooleanoptional

Whether to delete head branches when pull requests are merged.

github.event.pull_request.merge_commit_messagePR_BODY, PR_TITLE, BLANKoptional

The default value for a merge commit message.

  • PR_TITLE - default to the pull request’s title.
  • PR_BODY - default to the pull request’s body.
  • BLANK - default to a blank commit message.
github.event.pull_request.merge_commit_titlePR_TITLE, MERGE_MESSAGEoptional

The default value for a merge commit title.

  • PR_TITLE - default to the pull request’s title.
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., “Merge pull request #123 from branch-name”).
github.event.pull_request.squash_merge_commit_messagePR_BODY, COMMIT_MESSAGES, BLANKoptional

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request’s body.
  • COMMIT_MESSAGES - default to the branch’s commit messages.
  • BLANK - default to a blank commit message.
github.event.pull_request.squash_merge_commit_titlePR_TITLE, COMMIT_OR_PR_TITLEoptional

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request’s title.
  • COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
github.event.pull_request.use_squash_pr_title_as_defaultbooleanoptional

Whether a squash merge commit can use the pull request title as default. This property has been deprecated. Please use squash_merge_commit_title instead.

github.event.senderobjectrequired

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.

fieldtyperequireddescription
github.event.actionreview_request_removedrequired
github.event.installationobjectoptional

The GitHub App installation. Webhook payloads contain the installation property when the event is configured for and sent to a GitHub App. For more information, see “Using webhooks with GitHub Apps."

github.event.pull_request.active_lock_reasonresolved, off-topic, too heated, spam, Nonerequired
github.event.pull_request.additionsintegeroptional
github.event.pull_request.assigneeobject or nullrequired
github.event.pull_request.assignee.avatar_urlstringoptional
github.event.pull_request.assignee.deletedbooleanoptional
github.event.pull_request.assignee.events_urlstringoptional
github.event.pull_request.assignee.followers_urlstringoptional
github.event.pull_request.assignee.following_urlstringoptional
github.event.pull_request.assignee.gists_urlstringoptional
github.event.pull_request.assignee.gravatar_idstringoptional
github.event.pull_request.assignee.html_urlstringoptional
github.event.pull_request.assignee.namestringoptional
github.event.pull_request.assignee.node_idstringoptional
github.event.pull_request.assignee.organizations_urlstringoptional
github.event.pull_request.assignee.received_events_urlstringoptional
github.event.pull_request.assignee.repos_urlstringoptional
github.event.pull_request.assignee.site_adminbooleanoptional
github.event.pull_request.assignee.starred_urlstringoptional
github.event.pull_request.assignee.subscriptions_urlstringoptional
github.event.pull_request.assignee.typeBot, User, Organizationoptional
github.event.pull_request.assignee.urlstringoptional
github.event.pull_request.assigneesarray of object,nullsrequired
github.event.pull_request.auto_merge.commit_messagestring or nullrequired

Commit message for the merge commit.

github.event.pull_request.auto_merge.commit_titlestring or nullrequired

Title for the merge commit message.

github.event.pull_request.auto_merge.enabled_byobject or nullrequired
github.event.pull_request.auto_merge.enabled_by.avatar_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.deletedbooleanoptional
github.event.pull_request.auto_merge.enabled_by.events_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.followers_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.following_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.gists_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.gravatar_idstringoptional
github.event.pull_request.auto_merge.enabled_by.html_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.namestringoptional
github.event.pull_request.auto_merge.enabled_by.node_idstringoptional
github.event.pull_request.auto_merge.enabled_by.organizations_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.received_events_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.repos_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.site_adminbooleanoptional
github.event.pull_request.auto_merge.enabled_by.starred_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.subscriptions_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.typeBot, User, Organizationoptional
github.event.pull_request.auto_merge.enabled_by.urlstringoptional
github.event.pull_request.base.labelstringrequired
github.event.pull_request.base.repo.allow_auto_mergebooleanoptional

Whether to allow auto-merge for pull requests.

github.event.pull_request.base.repo.allow_update_branchbooleanoptional
github.event.pull_request.base.repo.created_atinteger or stringrequired
github.event.pull_request.base.repo.delete_branch_on_mergebooleanoptional

Whether to delete head branches when pull requests are merged

github.event.pull_request.base.repo.disabledbooleanoptional

Returns whether or not this repository is disabled.

github.event.pull_request.base.repo.licenseobject or nullrequired
github.event.pull_request.base.repo.license.spdx_idstringrequired
github.event.pull_request.base.repo.merge_commit_messagePR_BODY, PR_TITLE, BLANKoptional

The default value for a merge commit message.

  • PR_TITLE - default to the pull request’s title.
  • PR_BODY - default to the pull request’s body.
  • BLANK - default to a blank commit message.
github.event.pull_request.base.repo.merge_commit_titlePR_TITLE, MERGE_MESSAGEoptional

The default value for a merge commit title.

  • PR_TITLE - default to the pull request’s title.
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
github.event.pull_request.base.repo.organizationstringoptional
github.event.pull_request.base.repo.ownerobject or nullrequired
github.event.pull_request.base.repo.owner.avatar_urlstringoptional
github.event.pull_request.base.repo.owner.deletedbooleanoptional
github.event.pull_request.base.repo.owner.emailstring or nulloptional
github.event.pull_request.base.repo.owner.events_urlstringoptional
github.event.pull_request.base.repo.owner.followers_urlstringoptional
github.event.pull_request.base.repo.owner.following_urlstringoptional
github.event.pull_request.base.repo.owner.gists_urlstringoptional
github.event.pull_request.base.repo.owner.gravatar_idstringoptional
github.event.pull_request.base.repo.owner.html_urlstringoptional
github.event.pull_request.base.repo.owner.namestringoptional
github.event.pull_request.base.repo.owner.node_idstringoptional
github.event.pull_request.base.repo.owner.organizations_urlstringoptional
github.event.pull_request.base.repo.owner.received_events_urlstringoptional
github.event.pull_request.base.repo.owner.repos_urlstringoptional
github.event.pull_request.base.repo.owner.site_adminbooleanoptional
github.event.pull_request.base.repo.owner.starred_urlstringoptional
github.event.pull_request.base.repo.owner.subscriptions_urlstringoptional
github.event.pull_request.base.repo.owner.typeBot, User, Organizationoptional
github.event.pull_request.base.repo.owner.urlstringoptional
github.event.pull_request.base.repo.publicbooleanoptional
github.event.pull_request.base.repo.pushed_atnull or integer or stringrequired
github.event.pull_request.base.repo.role_namestring or nulloptional
github.event.pull_request.base.repo.squash_merge_commit_messagePR_BODY, COMMIT_MESSAGES, BLANKoptional

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request’s body.
  • COMMIT_MESSAGES - default to the branch’s commit messages.
  • BLANK - default to a blank commit message.
github.event.pull_request.base.repo.squash_merge_commit_titlePR_TITLE, COMMIT_OR_PR_TITLEoptional

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request’s title.
  • COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
github.event.pull_request.base.repo.stargazersintegeroptional
github.event.pull_request.base.repo.topicsarray of stringsrequired
github.event.pull_request.base.repo.use_squash_pr_title_as_defaultbooleanoptional

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

github.event.pull_request.base.repo.visibilitypublic, private, internalrequired
github.event.pull_request.base.userobject or nullrequired
github.event.pull_request.base.user.avatar_urlstringoptional
github.event.pull_request.base.user.deletedbooleanoptional
github.event.pull_request.base.user.emailstring or nulloptional
github.event.pull_request.base.user.events_urlstringoptional
github.event.pull_request.base.user.followers_urlstringoptional
github.event.pull_request.base.user.following_urlstringoptional
github.event.pull_request.base.user.gists_urlstringoptional
github.event.pull_request.base.user.gravatar_idstringoptional
github.event.pull_request.base.user.html_urlstringoptional
github.event.pull_request.base.user.namestringoptional
github.event.pull_request.base.user.node_idstringoptional
github.event.pull_request.base.user.organizations_urlstringoptional
github.event.pull_request.base.user.received_events_urlstringoptional
github.event.pull_request.base.user.repos_urlstringoptional
github.event.pull_request.base.user.site_adminbooleanoptional
github.event.pull_request.base.user.starred_urlstringoptional
github.event.pull_request.base.user.subscriptions_urlstringoptional
github.event.pull_request.base.user.typeBot, User, Organizationoptional
github.event.pull_request.base.user.urlstringoptional
github.event.pull_request.changed_filesintegeroptional
github.event.pull_request.commentsintegeroptional
github.event.pull_request.commitsintegeroptional
github.event.pull_request.deletionsintegeroptional
github.event.pull_request.draftbooleanrequired

Indicates whether or not the pull request is a draft.

github.event.pull_request.head.labelstringrequired
github.event.pull_request.head.repoobjectrequired

A git repository

github.event.pull_request.head.repo.allow_auto_mergebooleanoptional

Whether to allow auto-merge for pull requests.

github.event.pull_request.head.repo.allow_update_branchbooleanoptional
github.event.pull_request.head.repo.created_atinteger or stringrequired
github.event.pull_request.head.repo.delete_branch_on_mergebooleanoptional

Whether to delete head branches when pull requests are merged

github.event.pull_request.head.repo.disabledbooleanoptional

Returns whether or not this repository is disabled.

github.event.pull_request.head.repo.license.spdx_idstringrequired
github.event.pull_request.head.repo.merge_commit_messagePR_BODY, PR_TITLE, BLANKoptional

The default value for a merge commit message.

  • PR_TITLE - default to the pull request’s title.
  • PR_BODY - default to the pull request’s body.
  • BLANK - default to a blank commit message.
github.event.pull_request.head.repo.merge_commit_titlePR_TITLE, MERGE_MESSAGEoptional

The default value for a merge commit title.

  • PR_TITLE - default to the pull request’s title.
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
github.event.pull_request.head.repo.organizationstringoptional
github.event.pull_request.head.repo.ownerobject or nullrequired
github.event.pull_request.head.repo.owner.avatar_urlstringoptional
github.event.pull_request.head.repo.owner.deletedbooleanoptional
github.event.pull_request.head.repo.owner.emailstring or nulloptional
github.event.pull_request.head.repo.owner.events_urlstringoptional
github.event.pull_request.head.repo.owner.followers_urlstringoptional
github.event.pull_request.head.repo.owner.following_urlstringoptional
github.event.pull_request.head.repo.owner.gists_urlstringoptional
github.event.pull_request.head.repo.owner.gravatar_idstringoptional
github.event.pull_request.head.repo.owner.html_urlstringoptional
github.event.pull_request.head.repo.owner.namestringoptional
github.event.pull_request.head.repo.owner.node_idstringoptional
github.event.pull_request.head.repo.owner.organizations_urlstringoptional
github.event.pull_request.head.repo.owner.received_events_urlstringoptional
github.event.pull_request.head.repo.owner.repos_urlstringoptional
github.event.pull_request.head.repo.owner.site_adminbooleanoptional
github.event.pull_request.head.repo.owner.starred_urlstringoptional
github.event.pull_request.head.repo.owner.subscriptions_urlstringoptional
github.event.pull_request.head.repo.owner.typeBot, User, Organizationoptional
github.event.pull_request.head.repo.owner.urlstringoptional
github.event.pull_request.head.repo.publicbooleanoptional
github.event.pull_request.head.repo.pushed_atnull or integer or stringrequired
github.event.pull_request.head.repo.role_namestring or nulloptional
github.event.pull_request.head.repo.squash_merge_commit_messagePR_BODY, COMMIT_MESSAGES, BLANKoptional

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request’s body.
  • COMMIT_MESSAGES - default to the branch’s commit messages.
  • BLANK - default to a blank commit message.
github.event.pull_request.head.repo.squash_merge_commit_titlePR_TITLE, COMMIT_OR_PR_TITLEoptional

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request’s title.
  • COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
github.event.pull_request.head.repo.stargazersintegeroptional
github.event.pull_request.head.repo.topicsarray of stringsrequired
github.event.pull_request.head.repo.use_squash_pr_title_as_defaultbooleanoptional

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

github.event.pull_request.head.repo.visibilitypublic, private, internalrequired
github.event.pull_request.head.userobject or nullrequired
github.event.pull_request.head.user.avatar_urlstringoptional
github.event.pull_request.head.user.deletedbooleanoptional
github.event.pull_request.head.user.emailstring or nulloptional
github.event.pull_request.head.user.events_urlstringoptional
github.event.pull_request.head.user.followers_urlstringoptional
github.event.pull_request.head.user.following_urlstringoptional
github.event.pull_request.head.user.gists_urlstringoptional
github.event.pull_request.head.user.gravatar_idstringoptional
github.event.pull_request.head.user.html_urlstringoptional
github.event.pull_request.head.user.namestringoptional
github.event.pull_request.head.user.node_idstringoptional
github.event.pull_request.head.user.organizations_urlstringoptional
github.event.pull_request.head.user.received_events_urlstringoptional
github.event.pull_request.head.user.repos_urlstringoptional
github.event.pull_request.head.user.site_adminbooleanoptional
github.event.pull_request.head.user.starred_urlstringoptional
github.event.pull_request.head.user.subscriptions_urlstringoptional
github.event.pull_request.head.user.typeBot, User, Organizationoptional
github.event.pull_request.head.user.urlstringoptional
github.event.pull_request.maintainer_can_modifybooleanoptional

Indicates whether maintainers can modify the pull request.

github.event.pull_request.mergeableboolean or nulloptional
github.event.pull_request.mergeable_statestringoptional
github.event.pull_request.mergedboolean or nulloptional
github.event.pull_request.merged_byobject or nulloptional
github.event.pull_request.merged_by.avatar_urlstringoptional
github.event.pull_request.merged_by.deletedbooleanoptional
github.event.pull_request.merged_by.events_urlstringoptional
github.event.pull_request.merged_by.followers_urlstringoptional
github.event.pull_request.merged_by.following_urlstringoptional
github.event.pull_request.merged_by.gists_urlstringoptional
github.event.pull_request.merged_by.gravatar_idstringoptional
github.event.pull_request.merged_by.html_urlstringoptional
github.event.pull_request.merged_by.namestringoptional
github.event.pull_request.merged_by.node_idstringoptional
github.event.pull_request.merged_by.organizations_urlstringoptional
github.event.pull_request.merged_by.received_events_urlstringoptional
github.event.pull_request.merged_by.repos_urlstringoptional
github.event.pull_request.merged_by.site_adminbooleanoptional
github.event.pull_request.merged_by.starred_urlstringoptional
github.event.pull_request.merged_by.subscriptions_urlstringoptional
github.event.pull_request.merged_by.typeBot, User, Organizationoptional
github.event.pull_request.merged_by.urlstringoptional
github.event.pull_request.milestoneobject or nullrequired

A collection of related issues and pull requests.

github.event.pull_request.milestone.creatorobject or nullrequired
github.event.pull_request.milestone.creator.avatar_urlstringoptional
github.event.pull_request.milestone.creator.deletedbooleanoptional
github.event.pull_request.milestone.creator.events_urlstringoptional
github.event.pull_request.milestone.creator.followers_urlstringoptional
github.event.pull_request.milestone.creator.following_urlstringoptional
github.event.pull_request.milestone.creator.gists_urlstringoptional
github.event.pull_request.milestone.creator.gravatar_idstringoptional
github.event.pull_request.milestone.creator.html_urlstringoptional
github.event.pull_request.milestone.creator.namestringoptional
github.event.pull_request.milestone.creator.node_idstringoptional
github.event.pull_request.milestone.creator.organizations_urlstringoptional
github.event.pull_request.milestone.creator.received_events_urlstringoptional
github.event.pull_request.milestone.creator.repos_urlstringoptional
github.event.pull_request.milestone.creator.site_adminbooleanoptional
github.event.pull_request.milestone.creator.starred_urlstringoptional
github.event.pull_request.milestone.creator.subscriptions_urlstringoptional
github.event.pull_request.milestone.creator.typeBot, User, Organizationoptional
github.event.pull_request.milestone.creator.urlstringoptional
github.event.pull_request.requested_reviewersarrayrequired
github.event.pull_request.requested_teamsarray of objectsrequired
github.event.pull_request.requested_teams.deletedbooleanoptional
github.event.pull_request.requested_teams.descriptionstring or nullrequired

Description of the team

github.event.pull_request.requested_teams.html_urlstringrequired
github.event.pull_request.requested_teams.members_urlstringrequired
github.event.pull_request.requested_teams.node_idstringrequired
github.event.pull_request.requested_teams.parentobject or nulloptional
github.event.pull_request.requested_teams.parent.descriptionstring or nullrequired

Description of the team

github.event.pull_request.requested_teams.parent.html_urlstringrequired
github.event.pull_request.requested_teams.parent.idintegerrequired

Unique identifier of the team

github.event.pull_request.requested_teams.parent.members_urlstringrequired
github.event.pull_request.requested_teams.parent.namestringrequired

Name of the team

github.event.pull_request.requested_teams.parent.node_idstringrequired
github.event.pull_request.requested_teams.parent.permissionstringrequired

Permission that the team will have for its repositories

github.event.pull_request.requested_teams.parent.privacyopen, closed, secretrequired
github.event.pull_request.requested_teams.parent.repositories_urlstringrequired
github.event.pull_request.requested_teams.parent.slugstringrequired
github.event.pull_request.requested_teams.parent.urlstringrequired

URL for the team

github.event.pull_request.requested_teams.permissionstringrequired

Permission that the team will have for its repositories

github.event.pull_request.requested_teams.privacyopen, closed, secretrequired
github.event.pull_request.requested_teams.repositories_urlstringrequired
github.event.pull_request.requested_teams.slugstringrequired
github.event.pull_request.requested_teams.urlstringrequired

URL for the team

github.event.pull_request.review_commentsintegeroptional
github.event.pull_request.userobject or nullrequired
github.event.pull_request.user.avatar_urlstringoptional
github.event.pull_request.user.deletedbooleanoptional
github.event.pull_request.user.events_urlstringoptional
github.event.pull_request.user.followers_urlstringoptional
github.event.pull_request.user.following_urlstringoptional
github.event.pull_request.user.gists_urlstringoptional
github.event.pull_request.user.gravatar_idstringoptional
github.event.pull_request.user.html_urlstringoptional
github.event.pull_request.user.namestringoptional
github.event.pull_request.user.node_idstringoptional
github.event.pull_request.user.organizations_urlstringoptional
github.event.pull_request.user.received_events_urlstringoptional
github.event.pull_request.user.repos_urlstringoptional
github.event.pull_request.user.site_adminbooleanoptional
github.event.pull_request.user.starred_urlstringoptional
github.event.pull_request.user.subscriptions_urlstringoptional
github.event.pull_request.user.typeBot, User, Organizationoptional
github.event.pull_request.user.urlstringoptional
github.event.requested_reviewerobject or nullrequired
github.event.requested_reviewer.avatar_urlstringoptional
github.event.requested_reviewer.deletedbooleanoptional
github.event.requested_reviewer.emailstring or nulloptional
github.event.requested_reviewer.events_urlstringoptional
github.event.requested_reviewer.followers_urlstringoptional
github.event.requested_reviewer.following_urlstringoptional
github.event.requested_reviewer.gists_urlstringoptional
github.event.requested_reviewer.gravatar_idstringoptional
github.event.requested_reviewer.html_urlstringoptional
github.event.requested_reviewer.idintegerrequired
github.event.requested_reviewer.loginstringrequired
github.event.requested_reviewer.namestringoptional
github.event.requested_reviewer.node_idstringoptional
github.event.requested_reviewer.organizations_urlstringoptional
github.event.requested_reviewer.received_events_urlstringoptional
github.event.requested_reviewer.repos_urlstringoptional
github.event.requested_reviewer.site_adminbooleanoptional
github.event.requested_reviewer.starred_urlstringoptional
github.event.requested_reviewer.subscriptions_urlstringoptional
github.event.requested_reviewer.typeBot, User, Organizationoptional
github.event.requested_reviewer.urlstringoptional
github.event.senderobjectrequired

The GitHub user that triggered the event. This property is included in every webhook payload.

github.event.requested_teamobjectrequired

Groups of organization members that gives permissions on specified repositories.

github.event.requested_team.deletedbooleanoptional
github.event.requested_team.descriptionstring or nullrequired

Description of the team

github.event.requested_team.html_urlstringrequired
github.event.requested_team.idintegerrequired

Unique identifier of the team

github.event.requested_team.members_urlstringrequired
github.event.requested_team.namestringrequired

Name of the team

github.event.requested_team.node_idstringrequired
github.event.requested_team.parentobject or nulloptional
github.event.requested_team.parent.descriptionstring or nullrequired

Description of the team

github.event.requested_team.parent.html_urlstringrequired
github.event.requested_team.parent.idintegerrequired

Unique identifier of the team

github.event.requested_team.parent.members_urlstringrequired
github.event.requested_team.parent.namestringrequired

Name of the team

github.event.requested_team.parent.node_idstringrequired
github.event.requested_team.parent.permissionstringrequired

Permission that the team will have for its repositories

github.event.requested_team.parent.privacyopen, closed, secretrequired
github.event.requested_team.parent.repositories_urlstringrequired
github.event.requested_team.parent.slugstringrequired
github.event.requested_team.parent.urlstringrequired

URL for the team

github.event.requested_team.permissionstringrequired

Permission that the team will have for its repositories

github.event.requested_team.privacyopen, closed, secretrequired
github.event.requested_team.repositories_urlstringrequired
github.event.requested_team.slugstringrequired
github.event.requested_team.urlstringrequired

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.

fieldtyperequireddescription
github.event.actionreview_requestedrequired
github.event.installationobjectoptional

The GitHub App installation. Webhook payloads contain the installation property when the event is configured for and sent to a GitHub App. For more information, see “Using webhooks with GitHub Apps."

github.event.pull_request.active_lock_reasonresolved, off-topic, too heated, spam, Nonerequired
github.event.pull_request.additionsintegeroptional
github.event.pull_request.assigneeobject or nullrequired
github.event.pull_request.assignee.avatar_urlstringoptional
github.event.pull_request.assignee.deletedbooleanoptional
github.event.pull_request.assignee.events_urlstringoptional
github.event.pull_request.assignee.followers_urlstringoptional
github.event.pull_request.assignee.following_urlstringoptional
github.event.pull_request.assignee.gists_urlstringoptional
github.event.pull_request.assignee.gravatar_idstringoptional
github.event.pull_request.assignee.html_urlstringoptional
github.event.pull_request.assignee.namestringoptional
github.event.pull_request.assignee.node_idstringoptional
github.event.pull_request.assignee.organizations_urlstringoptional
github.event.pull_request.assignee.received_events_urlstringoptional
github.event.pull_request.assignee.repos_urlstringoptional
github.event.pull_request.assignee.site_adminbooleanoptional
github.event.pull_request.assignee.starred_urlstringoptional
github.event.pull_request.assignee.subscriptions_urlstringoptional
github.event.pull_request.assignee.typeBot, User, Organization, Mannequinoptional
github.event.pull_request.assignee.urlstringoptional
github.event.pull_request.assigneesarray of object,nullsrequired
github.event.pull_request.auto_merge.commit_messagestring or nullrequired

Commit message for the merge commit.

github.event.pull_request.auto_merge.commit_titlestring or nullrequired

Title for the merge commit message.

github.event.pull_request.auto_merge.enabled_byobject or nullrequired
github.event.pull_request.auto_merge.enabled_by.avatar_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.deletedbooleanoptional
github.event.pull_request.auto_merge.enabled_by.events_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.followers_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.following_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.gists_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.gravatar_idstringoptional
github.event.pull_request.auto_merge.enabled_by.html_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.namestringoptional
github.event.pull_request.auto_merge.enabled_by.node_idstringoptional
github.event.pull_request.auto_merge.enabled_by.organizations_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.received_events_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.repos_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.site_adminbooleanoptional
github.event.pull_request.auto_merge.enabled_by.starred_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.subscriptions_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.typeBot, User, Organizationoptional
github.event.pull_request.auto_merge.enabled_by.urlstringoptional
github.event.pull_request.base.labelstringrequired
github.event.pull_request.base.repo.allow_auto_mergebooleanoptional

Whether to allow auto-merge for pull requests.

github.event.pull_request.base.repo.allow_update_branchbooleanoptional
github.event.pull_request.base.repo.created_atinteger or stringrequired
github.event.pull_request.base.repo.delete_branch_on_mergebooleanoptional

Whether to delete head branches when pull requests are merged

github.event.pull_request.base.repo.disabledbooleanoptional

Returns whether or not this repository is disabled.

github.event.pull_request.base.repo.licenseobject or nullrequired
github.event.pull_request.base.repo.license.spdx_idstringrequired
github.event.pull_request.base.repo.merge_commit_messagePR_BODY, PR_TITLE, BLANKoptional

The default value for a merge commit message.

  • PR_TITLE - default to the pull request’s title.
  • PR_BODY - default to the pull request’s body.
  • BLANK - default to a blank commit message.
github.event.pull_request.base.repo.merge_commit_titlePR_TITLE, MERGE_MESSAGEoptional

The default value for a merge commit title.

  • PR_TITLE - default to the pull request’s title.
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
github.event.pull_request.base.repo.organizationstringoptional
github.event.pull_request.base.repo.ownerobject or nullrequired
github.event.pull_request.base.repo.owner.avatar_urlstringoptional
github.event.pull_request.base.repo.owner.deletedbooleanoptional
github.event.pull_request.base.repo.owner.emailstring or nulloptional
github.event.pull_request.base.repo.owner.events_urlstringoptional
github.event.pull_request.base.repo.owner.followers_urlstringoptional
github.event.pull_request.base.repo.owner.following_urlstringoptional
github.event.pull_request.base.repo.owner.gists_urlstringoptional
github.event.pull_request.base.repo.owner.gravatar_idstringoptional
github.event.pull_request.base.repo.owner.html_urlstringoptional
github.event.pull_request.base.repo.owner.namestringoptional
github.event.pull_request.base.repo.owner.node_idstringoptional
github.event.pull_request.base.repo.owner.organizations_urlstringoptional
github.event.pull_request.base.repo.owner.received_events_urlstringoptional
github.event.pull_request.base.repo.owner.repos_urlstringoptional
github.event.pull_request.base.repo.owner.site_adminbooleanoptional
github.event.pull_request.base.repo.owner.starred_urlstringoptional
github.event.pull_request.base.repo.owner.subscriptions_urlstringoptional
github.event.pull_request.base.repo.owner.typeBot, User, Organizationoptional
github.event.pull_request.base.repo.owner.urlstringoptional
github.event.pull_request.base.repo.publicbooleanoptional
github.event.pull_request.base.repo.pushed_atnull or integer or stringrequired
github.event.pull_request.base.repo.role_namestring or nulloptional
github.event.pull_request.base.repo.squash_merge_commit_messagePR_BODY, COMMIT_MESSAGES, BLANKoptional

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request’s body.
  • COMMIT_MESSAGES - default to the branch’s commit messages.
  • BLANK - default to a blank commit message.
github.event.pull_request.base.repo.squash_merge_commit_titlePR_TITLE, COMMIT_OR_PR_TITLEoptional

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request’s title.
  • COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
github.event.pull_request.base.repo.stargazersintegeroptional
github.event.pull_request.base.repo.topicsarray of stringsrequired
github.event.pull_request.base.repo.use_squash_pr_title_as_defaultbooleanoptional

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

github.event.pull_request.base.repo.visibilitypublic, private, internalrequired
github.event.pull_request.base.userobject or nullrequired
github.event.pull_request.base.user.avatar_urlstringoptional
github.event.pull_request.base.user.deletedbooleanoptional
github.event.pull_request.base.user.emailstring or nulloptional
github.event.pull_request.base.user.events_urlstringoptional
github.event.pull_request.base.user.followers_urlstringoptional
github.event.pull_request.base.user.following_urlstringoptional
github.event.pull_request.base.user.gists_urlstringoptional
github.event.pull_request.base.user.gravatar_idstringoptional
github.event.pull_request.base.user.html_urlstringoptional
github.event.pull_request.base.user.namestringoptional
github.event.pull_request.base.user.node_idstringoptional
github.event.pull_request.base.user.organizations_urlstringoptional
github.event.pull_request.base.user.received_events_urlstringoptional
github.event.pull_request.base.user.repos_urlstringoptional
github.event.pull_request.base.user.site_adminbooleanoptional
github.event.pull_request.base.user.starred_urlstringoptional
github.event.pull_request.base.user.subscriptions_urlstringoptional
github.event.pull_request.base.user.typeBot, User, Organizationoptional
github.event.pull_request.base.user.urlstringoptional
github.event.pull_request.changed_filesintegeroptional
github.event.pull_request.commentsintegeroptional
github.event.pull_request.commitsintegeroptional
github.event.pull_request.deletionsintegeroptional
github.event.pull_request.draftbooleanrequired

Indicates whether or not the pull request is a draft.

github.event.pull_request.head.labelstringrequired
github.event.pull_request.head.repoobjectrequired

A git repository

github.event.pull_request.head.repo.allow_auto_mergebooleanoptional

Whether to allow auto-merge for pull requests.

github.event.pull_request.head.repo.allow_update_branchbooleanoptional
github.event.pull_request.head.repo.created_atinteger or stringrequired
github.event.pull_request.head.repo.delete_branch_on_mergebooleanoptional

Whether to delete head branches when pull requests are merged

github.event.pull_request.head.repo.disabledbooleanoptional

Returns whether or not this repository is disabled.

github.event.pull_request.head.repo.license.spdx_idstringrequired
github.event.pull_request.head.repo.merge_commit_messagePR_BODY, PR_TITLE, BLANKoptional

The default value for a merge commit message.

  • PR_TITLE - default to the pull request’s title.
  • PR_BODY - default to the pull request’s body.
  • BLANK - default to a blank commit message.
github.event.pull_request.head.repo.merge_commit_titlePR_TITLE, MERGE_MESSAGEoptional

The default value for a merge commit title.

  • PR_TITLE - default to the pull request’s title.
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
github.event.pull_request.head.repo.organizationstringoptional
github.event.pull_request.head.repo.ownerobject or nullrequired
github.event.pull_request.head.repo.owner.avatar_urlstringoptional
github.event.pull_request.head.repo.owner.deletedbooleanoptional
github.event.pull_request.head.repo.owner.emailstring or nulloptional
github.event.pull_request.head.repo.owner.events_urlstringoptional
github.event.pull_request.head.repo.owner.followers_urlstringoptional
github.event.pull_request.head.repo.owner.following_urlstringoptional
github.event.pull_request.head.repo.owner.gists_urlstringoptional
github.event.pull_request.head.repo.owner.gravatar_idstringoptional
github.event.pull_request.head.repo.owner.html_urlstringoptional
github.event.pull_request.head.repo.owner.namestringoptional
github.event.pull_request.head.repo.owner.node_idstringoptional
github.event.pull_request.head.repo.owner.organizations_urlstringoptional
github.event.pull_request.head.repo.owner.received_events_urlstringoptional
github.event.pull_request.head.repo.owner.repos_urlstringoptional
github.event.pull_request.head.repo.owner.site_adminbooleanoptional
github.event.pull_request.head.repo.owner.starred_urlstringoptional
github.event.pull_request.head.repo.owner.subscriptions_urlstringoptional
github.event.pull_request.head.repo.owner.typeBot, User, Organizationoptional
github.event.pull_request.head.repo.owner.urlstringoptional
github.event.pull_request.head.repo.publicbooleanoptional
github.event.pull_request.head.repo.pushed_atnull or integer or stringrequired
github.event.pull_request.head.repo.role_namestring or nulloptional
github.event.pull_request.head.repo.squash_merge_commit_messagePR_BODY, COMMIT_MESSAGES, BLANKoptional

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request’s body.
  • COMMIT_MESSAGES - default to the branch’s commit messages.
  • BLANK - default to a blank commit message.
github.event.pull_request.head.repo.squash_merge_commit_titlePR_TITLE, COMMIT_OR_PR_TITLEoptional

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request’s title.
  • COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
github.event.pull_request.head.repo.stargazersintegeroptional
github.event.pull_request.head.repo.topicsarray of stringsrequired
github.event.pull_request.head.repo.use_squash_pr_title_as_defaultbooleanoptional

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

github.event.pull_request.head.repo.visibilitypublic, private, internalrequired
github.event.pull_request.head.userobject or nullrequired
github.event.pull_request.head.user.avatar_urlstringoptional
github.event.pull_request.head.user.deletedbooleanoptional
github.event.pull_request.head.user.emailstring or nulloptional
github.event.pull_request.head.user.events_urlstringoptional
github.event.pull_request.head.user.followers_urlstringoptional
github.event.pull_request.head.user.following_urlstringoptional
github.event.pull_request.head.user.gists_urlstringoptional
github.event.pull_request.head.user.gravatar_idstringoptional
github.event.pull_request.head.user.html_urlstringoptional
github.event.pull_request.head.user.namestringoptional
github.event.pull_request.head.user.node_idstringoptional
github.event.pull_request.head.user.organizations_urlstringoptional
github.event.pull_request.head.user.received_events_urlstringoptional
github.event.pull_request.head.user.repos_urlstringoptional
github.event.pull_request.head.user.site_adminbooleanoptional
github.event.pull_request.head.user.starred_urlstringoptional
github.event.pull_request.head.user.subscriptions_urlstringoptional
github.event.pull_request.head.user.typeBot, User, Organizationoptional
github.event.pull_request.head.user.urlstringoptional
github.event.pull_request.maintainer_can_modifybooleanoptional

Indicates whether maintainers can modify the pull request.

github.event.pull_request.mergeableboolean or nulloptional
github.event.pull_request.mergeable_statestringoptional
github.event.pull_request.mergedboolean or nulloptional
github.event.pull_request.merged_byobject or nulloptional
github.event.pull_request.merged_by.avatar_urlstringoptional
github.event.pull_request.merged_by.deletedbooleanoptional
github.event.pull_request.merged_by.events_urlstringoptional
github.event.pull_request.merged_by.followers_urlstringoptional
github.event.pull_request.merged_by.following_urlstringoptional
github.event.pull_request.merged_by.gists_urlstringoptional
github.event.pull_request.merged_by.gravatar_idstringoptional
github.event.pull_request.merged_by.html_urlstringoptional
github.event.pull_request.merged_by.namestringoptional
github.event.pull_request.merged_by.node_idstringoptional
github.event.pull_request.merged_by.organizations_urlstringoptional
github.event.pull_request.merged_by.received_events_urlstringoptional
github.event.pull_request.merged_by.repos_urlstringoptional
github.event.pull_request.merged_by.site_adminbooleanoptional
github.event.pull_request.merged_by.starred_urlstringoptional
github.event.pull_request.merged_by.subscriptions_urlstringoptional
github.event.pull_request.merged_by.typeBot, User, Organizationoptional
github.event.pull_request.merged_by.urlstringoptional
github.event.pull_request.milestoneobject or nullrequired

A collection of related issues and pull requests.

github.event.pull_request.milestone.creatorobject or nullrequired
github.event.pull_request.milestone.creator.avatar_urlstringoptional
github.event.pull_request.milestone.creator.deletedbooleanoptional
github.event.pull_request.milestone.creator.events_urlstringoptional
github.event.pull_request.milestone.creator.followers_urlstringoptional
github.event.pull_request.milestone.creator.following_urlstringoptional
github.event.pull_request.milestone.creator.gists_urlstringoptional
github.event.pull_request.milestone.creator.gravatar_idstringoptional
github.event.pull_request.milestone.creator.html_urlstringoptional
github.event.pull_request.milestone.creator.namestringoptional
github.event.pull_request.milestone.creator.node_idstringoptional
github.event.pull_request.milestone.creator.organizations_urlstringoptional
github.event.pull_request.milestone.creator.received_events_urlstringoptional
github.event.pull_request.milestone.creator.repos_urlstringoptional
github.event.pull_request.milestone.creator.site_adminbooleanoptional
github.event.pull_request.milestone.creator.starred_urlstringoptional
github.event.pull_request.milestone.creator.subscriptions_urlstringoptional
github.event.pull_request.milestone.creator.typeBot, User, Organization, Mannequinoptional
github.event.pull_request.milestone.creator.urlstringoptional
github.event.pull_request.requested_reviewersarrayrequired
github.event.pull_request.requested_teamsarray of objectsrequired
github.event.pull_request.requested_teams.deletedbooleanoptional
github.event.pull_request.requested_teams.descriptionstring or nulloptional

Description of the team

github.event.pull_request.requested_teams.html_urlstringoptional
github.event.pull_request.requested_teams.members_urlstringoptional
github.event.pull_request.requested_teams.node_idstringoptional
github.event.pull_request.requested_teams.parentobject or nulloptional
github.event.pull_request.requested_teams.parent.descriptionstring or nullrequired

Description of the team

github.event.pull_request.requested_teams.parent.html_urlstringrequired
github.event.pull_request.requested_teams.parent.idintegerrequired

Unique identifier of the team

github.event.pull_request.requested_teams.parent.members_urlstringrequired
github.event.pull_request.requested_teams.parent.namestringrequired

Name of the team

github.event.pull_request.requested_teams.parent.node_idstringrequired
github.event.pull_request.requested_teams.parent.permissionstringrequired

Permission that the team will have for its repositories

github.event.pull_request.requested_teams.parent.privacyopen, closed, secretrequired
github.event.pull_request.requested_teams.parent.repositories_urlstringrequired
github.event.pull_request.requested_teams.parent.slugstringrequired
github.event.pull_request.requested_teams.parent.urlstringrequired

URL for the team

github.event.pull_request.requested_teams.permissionstringoptional

Permission that the team will have for its repositories

github.event.pull_request.requested_teams.privacyopen, closed, secretoptional
github.event.pull_request.requested_teams.repositories_urlstringoptional
github.event.pull_request.requested_teams.slugstringoptional
github.event.pull_request.requested_teams.urlstringoptional

URL for the team

github.event.pull_request.review_commentsintegeroptional
github.event.pull_request.userobject or nullrequired
github.event.pull_request.user.avatar_urlstringoptional
github.event.pull_request.user.deletedbooleanoptional
github.event.pull_request.user.events_urlstringoptional
github.event.pull_request.user.followers_urlstringoptional
github.event.pull_request.user.following_urlstringoptional
github.event.pull_request.user.gists_urlstringoptional
github.event.pull_request.user.gravatar_idstringoptional
github.event.pull_request.user.html_urlstringoptional
github.event.pull_request.user.namestringoptional
github.event.pull_request.user.node_idstringoptional
github.event.pull_request.user.organizations_urlstringoptional
github.event.pull_request.user.received_events_urlstringoptional
github.event.pull_request.user.repos_urlstringoptional
github.event.pull_request.user.site_adminbooleanoptional
github.event.pull_request.user.starred_urlstringoptional
github.event.pull_request.user.subscriptions_urlstringoptional
github.event.pull_request.user.typeBot, User, Organization, Mannequinoptional
github.event.pull_request.user.urlstringoptional
github.event.requested_reviewerobject or nullrequired
github.event.requested_reviewer.avatar_urlstringoptional
github.event.requested_reviewer.deletedbooleanoptional
github.event.requested_reviewer.emailstring or nulloptional
github.event.requested_reviewer.events_urlstringoptional
github.event.requested_reviewer.followers_urlstringoptional
github.event.requested_reviewer.following_urlstringoptional
github.event.requested_reviewer.gists_urlstringoptional
github.event.requested_reviewer.gravatar_idstringoptional
github.event.requested_reviewer.html_urlstringoptional
github.event.requested_reviewer.idintegerrequired
github.event.requested_reviewer.loginstringrequired
github.event.requested_reviewer.namestringoptional
github.event.requested_reviewer.node_idstringoptional
github.event.requested_reviewer.organizations_urlstringoptional
github.event.requested_reviewer.received_events_urlstringoptional
github.event.requested_reviewer.repos_urlstringoptional
github.event.requested_reviewer.site_adminbooleanoptional
github.event.requested_reviewer.starred_urlstringoptional
github.event.requested_reviewer.subscriptions_urlstringoptional
github.event.requested_reviewer.typeBot, User, Organization, Mannequinoptional
github.event.requested_reviewer.urlstringoptional
github.event.senderobjectrequired

The GitHub user that triggered the event. This property is included in every webhook payload.

github.event.requested_teamobjectrequired

Groups of organization members that gives permissions on specified repositories.

github.event.requested_team.deletedbooleanoptional
github.event.requested_team.descriptionstring or nulloptional

Description of the team

github.event.requested_team.html_urlstringoptional
github.event.requested_team.idintegerrequired

Unique identifier of the team

github.event.requested_team.members_urlstringoptional
github.event.requested_team.namestringrequired

Name of the team

github.event.requested_team.node_idstringoptional
github.event.requested_team.parentobject or nulloptional
github.event.requested_team.parent.descriptionstring or nullrequired

Description of the team

github.event.requested_team.parent.html_urlstringrequired
github.event.requested_team.parent.idintegerrequired

Unique identifier of the team

github.event.requested_team.parent.members_urlstringrequired
github.event.requested_team.parent.namestringrequired

Name of the team

github.event.requested_team.parent.node_idstringrequired
github.event.requested_team.parent.permissionstringrequired

Permission that the team will have for its repositories

github.event.requested_team.parent.privacyopen, closed, secretrequired
github.event.requested_team.parent.repositories_urlstringrequired
github.event.requested_team.parent.slugstringrequired
github.event.requested_team.parent.urlstringrequired

URL for the team

github.event.requested_team.permissionstringoptional

Permission that the team will have for its repositories

github.event.requested_team.privacyopen, closed, secretoptional
github.event.requested_team.repositories_urlstringoptional
github.event.requested_team.slugstringoptional
github.event.requested_team.urlstringoptional

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.

fieldtyperequireddescription
github.event.actionsynchronizerequired
github.event.afterstringrequired
github.event.beforestringrequired
github.event.installationobjectoptional

The GitHub App installation. Webhook payloads contain the installation property when the event is configured for and sent to a GitHub App. For more information, see “Using webhooks with GitHub Apps."

github.event.pull_request.active_lock_reasonresolved, off-topic, too heated, spam, Nonerequired
github.event.pull_request.additionsintegeroptional
github.event.pull_request.assigneeobject or nullrequired
github.event.pull_request.assignee.avatar_urlstringoptional
github.event.pull_request.assignee.deletedbooleanoptional
github.event.pull_request.assignee.events_urlstringoptional
github.event.pull_request.assignee.followers_urlstringoptional
github.event.pull_request.assignee.following_urlstringoptional
github.event.pull_request.assignee.gists_urlstringoptional
github.event.pull_request.assignee.gravatar_idstringoptional
github.event.pull_request.assignee.html_urlstringoptional
github.event.pull_request.assignee.namestringoptional
github.event.pull_request.assignee.node_idstringoptional
github.event.pull_request.assignee.organizations_urlstringoptional
github.event.pull_request.assignee.received_events_urlstringoptional
github.event.pull_request.assignee.repos_urlstringoptional
github.event.pull_request.assignee.site_adminbooleanoptional
github.event.pull_request.assignee.starred_urlstringoptional
github.event.pull_request.assignee.subscriptions_urlstringoptional
github.event.pull_request.assignee.typeBot, User, Organization, Mannequinoptional
github.event.pull_request.assignee.urlstringoptional
github.event.pull_request.assigneesarray of object,nullsrequired
github.event.pull_request.auto_merge.commit_messagestring or nullrequired

Commit message for the merge commit.

github.event.pull_request.auto_merge.commit_titlestring or nullrequired

Title for the merge commit message.

github.event.pull_request.auto_merge.enabled_byobject or nullrequired
github.event.pull_request.auto_merge.enabled_by.avatar_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.deletedbooleanoptional
github.event.pull_request.auto_merge.enabled_by.events_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.followers_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.following_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.gists_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.gravatar_idstringoptional
github.event.pull_request.auto_merge.enabled_by.html_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.namestringoptional
github.event.pull_request.auto_merge.enabled_by.node_idstringoptional
github.event.pull_request.auto_merge.enabled_by.organizations_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.received_events_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.repos_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.site_adminbooleanoptional
github.event.pull_request.auto_merge.enabled_by.starred_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.subscriptions_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.typeBot, User, Organizationoptional
github.event.pull_request.auto_merge.enabled_by.urlstringoptional
github.event.pull_request.base.labelstringrequired
github.event.pull_request.base.repo.allow_auto_mergebooleanoptional

Whether to allow auto-merge for pull requests.

github.event.pull_request.base.repo.allow_update_branchbooleanoptional
github.event.pull_request.base.repo.created_atinteger or stringrequired
github.event.pull_request.base.repo.delete_branch_on_mergebooleanoptional

Whether to delete head branches when pull requests are merged

github.event.pull_request.base.repo.disabledbooleanoptional

Returns whether or not this repository is disabled.

github.event.pull_request.base.repo.licenseobject or nullrequired
github.event.pull_request.base.repo.license.spdx_idstringrequired
github.event.pull_request.base.repo.merge_commit_messagePR_BODY, PR_TITLE, BLANKoptional

The default value for a merge commit message.

  • PR_TITLE - default to the pull request’s title.
  • PR_BODY - default to the pull request’s body.
  • BLANK - default to a blank commit message.
github.event.pull_request.base.repo.merge_commit_titlePR_TITLE, MERGE_MESSAGEoptional

The default value for a merge commit title.

  • PR_TITLE - default to the pull request’s title.
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
github.event.pull_request.base.repo.organizationstringoptional
github.event.pull_request.base.repo.ownerobject or nullrequired
github.event.pull_request.base.repo.owner.avatar_urlstringoptional
github.event.pull_request.base.repo.owner.deletedbooleanoptional
github.event.pull_request.base.repo.owner.emailstring or nulloptional
github.event.pull_request.base.repo.owner.events_urlstringoptional
github.event.pull_request.base.repo.owner.followers_urlstringoptional
github.event.pull_request.base.repo.owner.following_urlstringoptional
github.event.pull_request.base.repo.owner.gists_urlstringoptional
github.event.pull_request.base.repo.owner.gravatar_idstringoptional
github.event.pull_request.base.repo.owner.html_urlstringoptional
github.event.pull_request.base.repo.owner.namestringoptional
github.event.pull_request.base.repo.owner.node_idstringoptional
github.event.pull_request.base.repo.owner.organizations_urlstringoptional
github.event.pull_request.base.repo.owner.received_events_urlstringoptional
github.event.pull_request.base.repo.owner.repos_urlstringoptional
github.event.pull_request.base.repo.owner.site_adminbooleanoptional
github.event.pull_request.base.repo.owner.starred_urlstringoptional
github.event.pull_request.base.repo.owner.subscriptions_urlstringoptional
github.event.pull_request.base.repo.owner.typeBot, User, Organizationoptional
github.event.pull_request.base.repo.owner.urlstringoptional
github.event.pull_request.base.repo.publicbooleanoptional
github.event.pull_request.base.repo.pushed_atnull or integer or stringrequired
github.event.pull_request.base.repo.role_namestring or nulloptional
github.event.pull_request.base.repo.squash_merge_commit_messagePR_BODY, COMMIT_MESSAGES, BLANKoptional

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request’s body.
  • COMMIT_MESSAGES - default to the branch’s commit messages.
  • BLANK - default to a blank commit message.
github.event.pull_request.base.repo.squash_merge_commit_titlePR_TITLE, COMMIT_OR_PR_TITLEoptional

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request’s title.
  • COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
github.event.pull_request.base.repo.stargazersintegeroptional
github.event.pull_request.base.repo.topicsarray of stringsrequired
github.event.pull_request.base.repo.use_squash_pr_title_as_defaultbooleanoptional

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

github.event.pull_request.base.repo.visibilitypublic, private, internalrequired
github.event.pull_request.base.userobject or nullrequired
github.event.pull_request.base.user.avatar_urlstringoptional
github.event.pull_request.base.user.deletedbooleanoptional
github.event.pull_request.base.user.emailstring or nulloptional
github.event.pull_request.base.user.events_urlstringoptional
github.event.pull_request.base.user.followers_urlstringoptional
github.event.pull_request.base.user.following_urlstringoptional
github.event.pull_request.base.user.gists_urlstringoptional
github.event.pull_request.base.user.gravatar_idstringoptional
github.event.pull_request.base.user.html_urlstringoptional
github.event.pull_request.base.user.namestringoptional
github.event.pull_request.base.user.node_idstringoptional
github.event.pull_request.base.user.organizations_urlstringoptional
github.event.pull_request.base.user.received_events_urlstringoptional
github.event.pull_request.base.user.repos_urlstringoptional
github.event.pull_request.base.user.site_adminbooleanoptional
github.event.pull_request.base.user.starred_urlstringoptional
github.event.pull_request.base.user.subscriptions_urlstringoptional
github.event.pull_request.base.user.typeBot, User, Organizationoptional
github.event.pull_request.base.user.urlstringoptional
github.event.pull_request.changed_filesintegeroptional
github.event.pull_request.commentsintegeroptional
github.event.pull_request.commitsintegeroptional
github.event.pull_request.deletionsintegeroptional
github.event.pull_request.draftbooleanrequired

Indicates whether or not the pull request is a draft.

github.event.pull_request.head.labelstringrequired
github.event.pull_request.head.repoobjectrequired

A git repository

github.event.pull_request.head.repo.allow_auto_mergebooleanoptional

Whether to allow auto-merge for pull requests.

github.event.pull_request.head.repo.allow_update_branchbooleanoptional
github.event.pull_request.head.repo.created_atinteger or stringrequired
github.event.pull_request.head.repo.delete_branch_on_mergebooleanoptional

Whether to delete head branches when pull requests are merged

github.event.pull_request.head.repo.disabledbooleanoptional

Returns whether or not this repository is disabled.

github.event.pull_request.head.repo.license.spdx_idstringrequired
github.event.pull_request.head.repo.merge_commit_messagePR_BODY, PR_TITLE, BLANKoptional

The default value for a merge commit message.

github.event.pull_request.head.repo.merge_commit_titlePR_TITLE, MERGE_MESSAGEoptional

The default value for a merge commit message title.

github.event.pull_request.head.repo.organizationstringoptional
github.event.pull_request.head.repo.ownerobject or nullrequired
github.event.pull_request.head.repo.owner.avatar_urlstringoptional
github.event.pull_request.head.repo.owner.deletedbooleanoptional
github.event.pull_request.head.repo.owner.emailstring or nulloptional
github.event.pull_request.head.repo.owner.events_urlstringoptional
github.event.pull_request.head.repo.owner.followers_urlstringoptional
github.event.pull_request.head.repo.owner.following_urlstringoptional
github.event.pull_request.head.repo.owner.gists_urlstringoptional
github.event.pull_request.head.repo.owner.gravatar_idstringoptional
github.event.pull_request.head.repo.owner.html_urlstringoptional
github.event.pull_request.head.repo.owner.namestringoptional
github.event.pull_request.head.repo.owner.node_idstringoptional
github.event.pull_request.head.repo.owner.organizations_urlstringoptional
github.event.pull_request.head.repo.owner.received_events_urlstringoptional
github.event.pull_request.head.repo.owner.repos_urlstringoptional
github.event.pull_request.head.repo.owner.site_adminbooleanoptional
github.event.pull_request.head.repo.owner.starred_urlstringoptional
github.event.pull_request.head.repo.owner.subscriptions_urlstringoptional
github.event.pull_request.head.repo.owner.typeBot, User, Organizationoptional
github.event.pull_request.head.repo.owner.urlstringoptional
github.event.pull_request.head.repo.publicbooleanoptional
github.event.pull_request.head.repo.pushed_atnull or integer or stringrequired
github.event.pull_request.head.repo.role_namestring or nulloptional
github.event.pull_request.head.repo.squash_merge_commit_messagePR_BODY, COMMIT_MESSAGES, BLANKoptional

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request’s body.
  • COMMIT_MESSAGES - default to the branch’s commit messages.
  • BLANK - default to a blank commit message.
github.event.pull_request.head.repo.squash_merge_commit_titlePR_TITLE, COMMIT_OR_PR_TITLEoptional

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request’s title.
  • COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
github.event.pull_request.head.repo.stargazersintegeroptional
github.event.pull_request.head.repo.topicsarray of stringsrequired
github.event.pull_request.head.repo.use_squash_pr_title_as_defaultbooleanoptional

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

github.event.pull_request.head.repo.visibilitypublic, private, internalrequired
github.event.pull_request.head.userobject or nullrequired
github.event.pull_request.head.user.avatar_urlstringoptional
github.event.pull_request.head.user.deletedbooleanoptional
github.event.pull_request.head.user.emailstring or nulloptional
github.event.pull_request.head.user.events_urlstringoptional
github.event.pull_request.head.user.followers_urlstringoptional
github.event.pull_request.head.user.following_urlstringoptional
github.event.pull_request.head.user.gists_urlstringoptional
github.event.pull_request.head.user.gravatar_idstringoptional
github.event.pull_request.head.user.html_urlstringoptional
github.event.pull_request.head.user.namestringoptional
github.event.pull_request.head.user.node_idstringoptional
github.event.pull_request.head.user.organizations_urlstringoptional
github.event.pull_request.head.user.received_events_urlstringoptional
github.event.pull_request.head.user.repos_urlstringoptional
github.event.pull_request.head.user.site_adminbooleanoptional
github.event.pull_request.head.user.starred_urlstringoptional
github.event.pull_request.head.user.subscriptions_urlstringoptional
github.event.pull_request.head.user.typeBot, User, Organizationoptional
github.event.pull_request.head.user.urlstringoptional
github.event.pull_request.maintainer_can_modifybooleanoptional

Indicates whether maintainers can modify the pull request.

github.event.pull_request.mergeableboolean or nulloptional
github.event.pull_request.mergeable_statestringoptional
github.event.pull_request.mergedboolean or nulloptional
github.event.pull_request.merged_byobject or nulloptional
github.event.pull_request.merged_by.avatar_urlstringoptional
github.event.pull_request.merged_by.deletedbooleanoptional
github.event.pull_request.merged_by.events_urlstringoptional
github.event.pull_request.merged_by.followers_urlstringoptional
github.event.pull_request.merged_by.following_urlstringoptional
github.event.pull_request.merged_by.gists_urlstringoptional
github.event.pull_request.merged_by.gravatar_idstringoptional
github.event.pull_request.merged_by.html_urlstringoptional
github.event.pull_request.merged_by.namestringoptional
github.event.pull_request.merged_by.node_idstringoptional
github.event.pull_request.merged_by.organizations_urlstringoptional
github.event.pull_request.merged_by.received_events_urlstringoptional
github.event.pull_request.merged_by.repos_urlstringoptional
github.event.pull_request.merged_by.site_adminbooleanoptional
github.event.pull_request.merged_by.starred_urlstringoptional
github.event.pull_request.merged_by.subscriptions_urlstringoptional
github.event.pull_request.merged_by.typeBot, User, Organizationoptional
github.event.pull_request.merged_by.urlstringoptional
github.event.pull_request.milestoneobject or nullrequired

A collection of related issues and pull requests.

github.event.pull_request.milestone.creatorobject or nullrequired
github.event.pull_request.milestone.creator.avatar_urlstringoptional
github.event.pull_request.milestone.creator.deletedbooleanoptional
github.event.pull_request.milestone.creator.events_urlstringoptional
github.event.pull_request.milestone.creator.followers_urlstringoptional
github.event.pull_request.milestone.creator.following_urlstringoptional
github.event.pull_request.milestone.creator.gists_urlstringoptional
github.event.pull_request.milestone.creator.gravatar_idstringoptional
github.event.pull_request.milestone.creator.html_urlstringoptional
github.event.pull_request.milestone.creator.namestringoptional
github.event.pull_request.milestone.creator.node_idstringoptional
github.event.pull_request.milestone.creator.organizations_urlstringoptional
github.event.pull_request.milestone.creator.received_events_urlstringoptional
github.event.pull_request.milestone.creator.repos_urlstringoptional
github.event.pull_request.milestone.creator.site_adminbooleanoptional
github.event.pull_request.milestone.creator.starred_urlstringoptional
github.event.pull_request.milestone.creator.subscriptions_urlstringoptional
github.event.pull_request.milestone.creator.typeBot, User, Organization, Mannequinoptional
github.event.pull_request.milestone.creator.urlstringoptional
github.event.pull_request.requested_reviewersarrayrequired
github.event.pull_request.requested_teamsarray of objectsrequired
github.event.pull_request.requested_teams.deletedbooleanoptional
github.event.pull_request.requested_teams.descriptionstring or nulloptional

Description of the team

github.event.pull_request.requested_teams.html_urlstringoptional
github.event.pull_request.requested_teams.members_urlstringoptional
github.event.pull_request.requested_teams.node_idstringoptional
github.event.pull_request.requested_teams.parentobject or nulloptional
github.event.pull_request.requested_teams.parent.descriptionstring or nullrequired

Description of the team

github.event.pull_request.requested_teams.parent.html_urlstringrequired
github.event.pull_request.requested_teams.parent.idintegerrequired

Unique identifier of the team

github.event.pull_request.requested_teams.parent.members_urlstringrequired
github.event.pull_request.requested_teams.parent.namestringrequired

Name of the team

github.event.pull_request.requested_teams.parent.node_idstringrequired
github.event.pull_request.requested_teams.parent.permissionstringrequired

Permission that the team will have for its repositories

github.event.pull_request.requested_teams.parent.privacyopen, closed, secretrequired
github.event.pull_request.requested_teams.parent.repositories_urlstringrequired
github.event.pull_request.requested_teams.parent.slugstringrequired
github.event.pull_request.requested_teams.parent.urlstringrequired

URL for the team

github.event.pull_request.requested_teams.permissionstringoptional

Permission that the team will have for its repositories

github.event.pull_request.requested_teams.privacyopen, closed, secretoptional
github.event.pull_request.requested_teams.repositories_urlstringoptional
github.event.pull_request.requested_teams.slugstringoptional
github.event.pull_request.requested_teams.urlstringoptional

URL for the team

github.event.pull_request.review_commentsintegeroptional
github.event.pull_request.userobject or nullrequired
github.event.pull_request.user.avatar_urlstringoptional
github.event.pull_request.user.deletedbooleanoptional
github.event.pull_request.user.events_urlstringoptional
github.event.pull_request.user.followers_urlstringoptional
github.event.pull_request.user.following_urlstringoptional
github.event.pull_request.user.gists_urlstringoptional
github.event.pull_request.user.gravatar_idstringoptional
github.event.pull_request.user.html_urlstringoptional
github.event.pull_request.user.namestringoptional
github.event.pull_request.user.node_idstringoptional
github.event.pull_request.user.organizations_urlstringoptional
github.event.pull_request.user.received_events_urlstringoptional
github.event.pull_request.user.repos_urlstringoptional
github.event.pull_request.user.site_adminbooleanoptional
github.event.pull_request.user.starred_urlstringoptional
github.event.pull_request.user.subscriptions_urlstringoptional
github.event.pull_request.user.typeBot, User, Organization, Mannequinoptional
github.event.pull_request.user.urlstringoptional
github.event.senderobjectrequired

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.

fieldtyperequireddescription
github.event.actionunassignedrequired
github.event.assigneeobject or nulloptional
github.event.assignee.avatar_urlstringoptional
github.event.assignee.deletedbooleanoptional
github.event.assignee.emailstring or nulloptional
github.event.assignee.events_urlstringoptional
github.event.assignee.followers_urlstringoptional
github.event.assignee.following_urlstringoptional
github.event.assignee.gists_urlstringoptional
github.event.assignee.gravatar_idstringoptional
github.event.assignee.html_urlstringoptional
github.event.assignee.idintegerrequired
github.event.assignee.loginstringrequired
github.event.assignee.namestringoptional
github.event.assignee.node_idstringoptional
github.event.assignee.organizations_urlstringoptional
github.event.assignee.received_events_urlstringoptional
github.event.assignee.repos_urlstringoptional
github.event.assignee.site_adminbooleanoptional
github.event.assignee.starred_urlstringoptional
github.event.assignee.subscriptions_urlstringoptional
github.event.assignee.typeBot, User, Organization, Mannequinoptional
github.event.assignee.urlstringoptional
github.event.installationobjectoptional

The GitHub App installation. Webhook payloads contain the installation property when the event is configured for and sent to a GitHub App. For more information, see “Using webhooks with GitHub Apps."

github.event.pull_request.active_lock_reasonresolved, off-topic, too heated, spam, Nonerequired
github.event.pull_request.additionsintegeroptional
github.event.pull_request.assigneeobject or nullrequired
github.event.pull_request.assignee.avatar_urlstringoptional
github.event.pull_request.assignee.deletedbooleanoptional
github.event.pull_request.assignee.events_urlstringoptional
github.event.pull_request.assignee.followers_urlstringoptional
github.event.pull_request.assignee.following_urlstringoptional
github.event.pull_request.assignee.gists_urlstringoptional
github.event.pull_request.assignee.gravatar_idstringoptional
github.event.pull_request.assignee.html_urlstringoptional
github.event.pull_request.assignee.namestringoptional
github.event.pull_request.assignee.node_idstringoptional
github.event.pull_request.assignee.organizations_urlstringoptional
github.event.pull_request.assignee.received_events_urlstringoptional
github.event.pull_request.assignee.repos_urlstringoptional
github.event.pull_request.assignee.site_adminbooleanoptional
github.event.pull_request.assignee.starred_urlstringoptional
github.event.pull_request.assignee.subscriptions_urlstringoptional
github.event.pull_request.assignee.typeBot, User, Organization, Mannequinoptional
github.event.pull_request.assignee.urlstringoptional
github.event.pull_request.assigneesarray of object,nullsrequired
github.event.pull_request.auto_merge.commit_messagestring or nullrequired

Commit message for the merge commit.

github.event.pull_request.auto_merge.commit_titlestring or nullrequired

Title for the merge commit message.

github.event.pull_request.auto_merge.enabled_byobject or nullrequired
github.event.pull_request.auto_merge.enabled_by.avatar_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.deletedbooleanoptional
github.event.pull_request.auto_merge.enabled_by.events_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.followers_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.following_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.gists_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.gravatar_idstringoptional
github.event.pull_request.auto_merge.enabled_by.html_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.namestringoptional
github.event.pull_request.auto_merge.enabled_by.node_idstringoptional
github.event.pull_request.auto_merge.enabled_by.organizations_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.received_events_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.repos_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.site_adminbooleanoptional
github.event.pull_request.auto_merge.enabled_by.starred_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.subscriptions_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.typeBot, User, Organizationoptional
github.event.pull_request.auto_merge.enabled_by.urlstringoptional
github.event.pull_request.base.labelstring or nullrequired
github.event.pull_request.base.repo.allow_auto_mergebooleanoptional

Whether to allow auto-merge for pull requests.

github.event.pull_request.base.repo.allow_update_branchbooleanoptional
github.event.pull_request.base.repo.created_atinteger or stringrequired
github.event.pull_request.base.repo.delete_branch_on_mergebooleanoptional

Whether to delete head branches when pull requests are merged

github.event.pull_request.base.repo.disabledbooleanoptional

Returns whether or not this repository is disabled.

github.event.pull_request.base.repo.licenseobject or nullrequired
github.event.pull_request.base.repo.license.spdx_idstringrequired
github.event.pull_request.base.repo.merge_commit_messagePR_BODY, PR_TITLE, BLANKoptional

The default value for a merge commit message.

  • PR_TITLE - default to the pull request’s title.
  • PR_BODY - default to the pull request’s body.
  • BLANK - default to a blank commit message.
github.event.pull_request.base.repo.merge_commit_titlePR_TITLE, MERGE_MESSAGEoptional

The default value for a merge commit title.

  • PR_TITLE - default to the pull request’s title.
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
github.event.pull_request.base.repo.organizationstringoptional
github.event.pull_request.base.repo.ownerobject or nullrequired
github.event.pull_request.base.repo.owner.avatar_urlstringoptional
github.event.pull_request.base.repo.owner.deletedbooleanoptional
github.event.pull_request.base.repo.owner.emailstring or nulloptional
github.event.pull_request.base.repo.owner.events_urlstringoptional
github.event.pull_request.base.repo.owner.followers_urlstringoptional
github.event.pull_request.base.repo.owner.following_urlstringoptional
github.event.pull_request.base.repo.owner.gists_urlstringoptional
github.event.pull_request.base.repo.owner.gravatar_idstringoptional
github.event.pull_request.base.repo.owner.html_urlstringoptional
github.event.pull_request.base.repo.owner.namestringoptional
github.event.pull_request.base.repo.owner.node_idstringoptional
github.event.pull_request.base.repo.owner.organizations_urlstringoptional
github.event.pull_request.base.repo.owner.received_events_urlstringoptional
github.event.pull_request.base.repo.owner.repos_urlstringoptional
github.event.pull_request.base.repo.owner.site_adminbooleanoptional
github.event.pull_request.base.repo.owner.starred_urlstringoptional
github.event.pull_request.base.repo.owner.subscriptions_urlstringoptional
github.event.pull_request.base.repo.owner.typeBot, User, Organizationoptional
github.event.pull_request.base.repo.owner.urlstringoptional
github.event.pull_request.base.repo.publicbooleanoptional
github.event.pull_request.base.repo.pushed_atnull or integer or stringrequired
github.event.pull_request.base.repo.role_namestring or nulloptional
github.event.pull_request.base.repo.squash_merge_commit_messagePR_BODY, COMMIT_MESSAGES, BLANKoptional

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request’s body.
  • COMMIT_MESSAGES - default to the branch’s commit messages.
  • BLANK - default to a blank commit message.
github.event.pull_request.base.repo.squash_merge_commit_titlePR_TITLE, COMMIT_OR_PR_TITLEoptional

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request’s title.
  • COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
github.event.pull_request.base.repo.stargazersintegeroptional
github.event.pull_request.base.repo.topicsarray of stringsrequired
github.event.pull_request.base.repo.use_squash_pr_title_as_defaultbooleanoptional

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

github.event.pull_request.base.repo.visibilitypublic, private, internalrequired
github.event.pull_request.base.userobject or nullrequired
github.event.pull_request.base.user.avatar_urlstringoptional
github.event.pull_request.base.user.deletedbooleanoptional
github.event.pull_request.base.user.emailstring or nulloptional
github.event.pull_request.base.user.events_urlstringoptional
github.event.pull_request.base.user.followers_urlstringoptional
github.event.pull_request.base.user.following_urlstringoptional
github.event.pull_request.base.user.gists_urlstringoptional
github.event.pull_request.base.user.gravatar_idstringoptional
github.event.pull_request.base.user.html_urlstringoptional
github.event.pull_request.base.user.namestringoptional
github.event.pull_request.base.user.node_idstringoptional
github.event.pull_request.base.user.organizations_urlstringoptional
github.event.pull_request.base.user.received_events_urlstringoptional
github.event.pull_request.base.user.repos_urlstringoptional
github.event.pull_request.base.user.site_adminbooleanoptional
github.event.pull_request.base.user.starred_urlstringoptional
github.event.pull_request.base.user.subscriptions_urlstringoptional
github.event.pull_request.base.user.typeBot, User, Organizationoptional
github.event.pull_request.base.user.urlstringoptional
github.event.pull_request.changed_filesintegeroptional
github.event.pull_request.commentsintegeroptional
github.event.pull_request.commitsintegeroptional
github.event.pull_request.deletionsintegeroptional
github.event.pull_request.draftbooleanrequired

Indicates whether or not the pull request is a draft.

github.event.pull_request.head.labelstring or nullrequired
github.event.pull_request.head.repoobject or nullrequired

A git repository

github.event.pull_request.head.repo.allow_auto_mergebooleanoptional

Whether to allow auto-merge for pull requests.

github.event.pull_request.head.repo.allow_update_branchbooleanoptional
github.event.pull_request.head.repo.created_atinteger or stringrequired
github.event.pull_request.head.repo.delete_branch_on_mergebooleanoptional

Whether to delete head branches when pull requests are merged

github.event.pull_request.head.repo.disabledbooleanoptional

Returns whether or not this repository is disabled.

github.event.pull_request.head.repo.license.spdx_idstringrequired
github.event.pull_request.head.repo.merge_commit_messagePR_BODY, PR_TITLE, BLANKoptional

The default value for a merge commit message.

  • PR_TITLE - default to the pull request’s title.
  • PR_BODY - default to the pull request’s body.
  • BLANK - default to a blank commit message.
github.event.pull_request.head.repo.merge_commit_titlePR_TITLE, MERGE_MESSAGEoptional

The default value for a merge commit title.

  • PR_TITLE - default to the pull request’s title.
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
github.event.pull_request.head.repo.organizationstringoptional
github.event.pull_request.head.repo.ownerobject or nullrequired
github.event.pull_request.head.repo.owner.avatar_urlstringoptional
github.event.pull_request.head.repo.owner.deletedbooleanoptional
github.event.pull_request.head.repo.owner.emailstring or nulloptional
github.event.pull_request.head.repo.owner.events_urlstringoptional
github.event.pull_request.head.repo.owner.followers_urlstringoptional
github.event.pull_request.head.repo.owner.following_urlstringoptional
github.event.pull_request.head.repo.owner.gists_urlstringoptional
github.event.pull_request.head.repo.owner.gravatar_idstringoptional
github.event.pull_request.head.repo.owner.html_urlstringoptional
github.event.pull_request.head.repo.owner.namestringoptional
github.event.pull_request.head.repo.owner.node_idstringoptional
github.event.pull_request.head.repo.owner.organizations_urlstringoptional
github.event.pull_request.head.repo.owner.received_events_urlstringoptional
github.event.pull_request.head.repo.owner.repos_urlstringoptional
github.event.pull_request.head.repo.owner.site_adminbooleanoptional
github.event.pull_request.head.repo.owner.starred_urlstringoptional
github.event.pull_request.head.repo.owner.subscriptions_urlstringoptional
github.event.pull_request.head.repo.owner.typeBot, User, Organizationoptional
github.event.pull_request.head.repo.owner.urlstringoptional
github.event.pull_request.head.repo.publicbooleanoptional
github.event.pull_request.head.repo.pushed_atnull or integer or stringrequired
github.event.pull_request.head.repo.role_namestring or nulloptional
github.event.pull_request.head.repo.squash_merge_commit_messagePR_BODY, COMMIT_MESSAGES, BLANKoptional

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request’s body.
  • COMMIT_MESSAGES - default to the branch’s commit messages.
  • BLANK - default to a blank commit message.
github.event.pull_request.head.repo.squash_merge_commit_titlePR_TITLE, COMMIT_OR_PR_TITLEoptional

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request’s title.
  • COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
github.event.pull_request.head.repo.stargazersintegeroptional
github.event.pull_request.head.repo.topicsarray of stringsrequired
github.event.pull_request.head.repo.use_squash_pr_title_as_defaultbooleanoptional

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

github.event.pull_request.head.repo.visibilitypublic, private, internalrequired
github.event.pull_request.head.userobject or nullrequired
github.event.pull_request.head.user.avatar_urlstringoptional
github.event.pull_request.head.user.deletedbooleanoptional
github.event.pull_request.head.user.emailstring or nulloptional
github.event.pull_request.head.user.events_urlstringoptional
github.event.pull_request.head.user.followers_urlstringoptional
github.event.pull_request.head.user.following_urlstringoptional
github.event.pull_request.head.user.gists_urlstringoptional
github.event.pull_request.head.user.gravatar_idstringoptional
github.event.pull_request.head.user.html_urlstringoptional
github.event.pull_request.head.user.namestringoptional
github.event.pull_request.head.user.node_idstringoptional
github.event.pull_request.head.user.organizations_urlstringoptional
github.event.pull_request.head.user.received_events_urlstringoptional
github.event.pull_request.head.user.repos_urlstringoptional
github.event.pull_request.head.user.site_adminbooleanoptional
github.event.pull_request.head.user.starred_urlstringoptional
github.event.pull_request.head.user.subscriptions_urlstringoptional
github.event.pull_request.head.user.typeBot, User, Organizationoptional
github.event.pull_request.head.user.urlstringoptional
github.event.pull_request.maintainer_can_modifybooleanoptional

Indicates whether maintainers can modify the pull request.

github.event.pull_request.mergeableboolean or nulloptional
github.event.pull_request.mergeable_statestringoptional
github.event.pull_request.mergedboolean or nulloptional
github.event.pull_request.merged_byobject or nulloptional
github.event.pull_request.merged_by.avatar_urlstringoptional
github.event.pull_request.merged_by.deletedbooleanoptional
github.event.pull_request.merged_by.events_urlstringoptional
github.event.pull_request.merged_by.followers_urlstringoptional
github.event.pull_request.merged_by.following_urlstringoptional
github.event.pull_request.merged_by.gists_urlstringoptional
github.event.pull_request.merged_by.gravatar_idstringoptional
github.event.pull_request.merged_by.html_urlstringoptional
github.event.pull_request.merged_by.namestringoptional
github.event.pull_request.merged_by.node_idstringoptional
github.event.pull_request.merged_by.organizations_urlstringoptional
github.event.pull_request.merged_by.received_events_urlstringoptional
github.event.pull_request.merged_by.repos_urlstringoptional
github.event.pull_request.merged_by.site_adminbooleanoptional
github.event.pull_request.merged_by.starred_urlstringoptional
github.event.pull_request.merged_by.subscriptions_urlstringoptional
github.event.pull_request.merged_by.typeBot, User, Organization, Mannequinoptional
github.event.pull_request.merged_by.urlstringoptional
github.event.pull_request.milestoneobject or nullrequired

A collection of related issues and pull requests.

github.event.pull_request.milestone.creatorobject or nullrequired
github.event.pull_request.milestone.creator.avatar_urlstringoptional
github.event.pull_request.milestone.creator.deletedbooleanoptional
github.event.pull_request.milestone.creator.events_urlstringoptional
github.event.pull_request.milestone.creator.followers_urlstringoptional
github.event.pull_request.milestone.creator.following_urlstringoptional
github.event.pull_request.milestone.creator.gists_urlstringoptional
github.event.pull_request.milestone.creator.gravatar_idstringoptional
github.event.pull_request.milestone.creator.html_urlstringoptional
github.event.pull_request.milestone.creator.namestringoptional
github.event.pull_request.milestone.creator.node_idstringoptional
github.event.pull_request.milestone.creator.organizations_urlstringoptional
github.event.pull_request.milestone.creator.received_events_urlstringoptional
github.event.pull_request.milestone.creator.repos_urlstringoptional
github.event.pull_request.milestone.creator.site_adminbooleanoptional
github.event.pull_request.milestone.creator.starred_urlstringoptional
github.event.pull_request.milestone.creator.subscriptions_urlstringoptional
github.event.pull_request.milestone.creator.typeBot, User, Organization, Mannequinoptional
github.event.pull_request.milestone.creator.urlstringoptional
github.event.pull_request.requested_reviewersarrayrequired
github.event.pull_request.requested_teamsarray of objectsrequired
github.event.pull_request.requested_teams.deletedbooleanoptional
github.event.pull_request.requested_teams.descriptionstring or nulloptional

Description of the team

github.event.pull_request.requested_teams.html_urlstringoptional
github.event.pull_request.requested_teams.members_urlstringoptional
github.event.pull_request.requested_teams.node_idstringoptional
github.event.pull_request.requested_teams.parentobject or nulloptional
github.event.pull_request.requested_teams.parent.descriptionstring or nullrequired

Description of the team

github.event.pull_request.requested_teams.parent.html_urlstringrequired
github.event.pull_request.requested_teams.parent.idintegerrequired

Unique identifier of the team

github.event.pull_request.requested_teams.parent.members_urlstringrequired
github.event.pull_request.requested_teams.parent.namestringrequired

Name of the team

github.event.pull_request.requested_teams.parent.node_idstringrequired
github.event.pull_request.requested_teams.parent.permissionstringrequired

Permission that the team will have for its repositories

github.event.pull_request.requested_teams.parent.privacyopen, closed, secretrequired
github.event.pull_request.requested_teams.parent.repositories_urlstringrequired
github.event.pull_request.requested_teams.parent.slugstringrequired
github.event.pull_request.requested_teams.parent.urlstringrequired

URL for the team

github.event.pull_request.requested_teams.permissionstringoptional

Permission that the team will have for its repositories

github.event.pull_request.requested_teams.privacyopen, closed, secretoptional
github.event.pull_request.requested_teams.repositories_urlstringoptional
github.event.pull_request.requested_teams.slugstringoptional
github.event.pull_request.requested_teams.urlstringoptional

URL for the team

github.event.pull_request.review_commentsintegeroptional
github.event.pull_request.userobject or nullrequired
github.event.pull_request.user.avatar_urlstringoptional
github.event.pull_request.user.deletedbooleanoptional
github.event.pull_request.user.events_urlstringoptional
github.event.pull_request.user.followers_urlstringoptional
github.event.pull_request.user.following_urlstringoptional
github.event.pull_request.user.gists_urlstringoptional
github.event.pull_request.user.gravatar_idstringoptional
github.event.pull_request.user.html_urlstringoptional
github.event.pull_request.user.namestringoptional
github.event.pull_request.user.node_idstringoptional
github.event.pull_request.user.organizations_urlstringoptional
github.event.pull_request.user.received_events_urlstringoptional
github.event.pull_request.user.repos_urlstringoptional
github.event.pull_request.user.site_adminbooleanoptional
github.event.pull_request.user.starred_urlstringoptional
github.event.pull_request.user.subscriptions_urlstringoptional
github.event.pull_request.user.typeBot, User, Organization, Mannequinoptional
github.event.pull_request.user.urlstringoptional
github.event.senderobjectoptional

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.

fieldtyperequireddescription
github.event.actionunlabeledrequired
github.event.installationobjectoptional

The GitHub App installation. Webhook payloads contain the installation property when the event is configured for and sent to a GitHub App. For more information, see “Using webhooks with GitHub Apps."

github.event.labelobjectoptional
github.event.label.colorstringrequired

6-character hex code, without the leading #, identifying the color

github.event.label.defaultbooleanrequired
github.event.label.descriptionstring or nullrequired
github.event.label.idintegerrequired
github.event.label.namestringrequired

The name of the label.

github.event.label.node_idstringrequired
github.event.label.urlstringrequired

URL for the label

github.event.pull_request.active_lock_reasonresolved, off-topic, too heated, spam, Nonerequired
github.event.pull_request.additionsintegeroptional
github.event.pull_request.assigneeobject or nullrequired
github.event.pull_request.assignee.avatar_urlstringoptional
github.event.pull_request.assignee.deletedbooleanoptional
github.event.pull_request.assignee.events_urlstringoptional
github.event.pull_request.assignee.followers_urlstringoptional
github.event.pull_request.assignee.following_urlstringoptional
github.event.pull_request.assignee.gists_urlstringoptional
github.event.pull_request.assignee.gravatar_idstringoptional
github.event.pull_request.assignee.html_urlstringoptional
github.event.pull_request.assignee.namestringoptional
github.event.pull_request.assignee.node_idstringoptional
github.event.pull_request.assignee.organizations_urlstringoptional
github.event.pull_request.assignee.received_events_urlstringoptional
github.event.pull_request.assignee.repos_urlstringoptional
github.event.pull_request.assignee.site_adminbooleanoptional
github.event.pull_request.assignee.starred_urlstringoptional
github.event.pull_request.assignee.subscriptions_urlstringoptional
github.event.pull_request.assignee.typeBot, User, Organization, Mannequinoptional
github.event.pull_request.assignee.urlstringoptional
github.event.pull_request.assigneesarray of object,nullsrequired
github.event.pull_request.auto_merge.commit_messagestring or nullrequired

Commit message for the merge commit.

github.event.pull_request.auto_merge.commit_titlestring or nullrequired

Title for the merge commit message.

github.event.pull_request.auto_merge.enabled_byobject or nullrequired
github.event.pull_request.auto_merge.enabled_by.avatar_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.deletedbooleanoptional
github.event.pull_request.auto_merge.enabled_by.events_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.followers_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.following_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.gists_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.gravatar_idstringoptional
github.event.pull_request.auto_merge.enabled_by.html_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.namestringoptional
github.event.pull_request.auto_merge.enabled_by.node_idstringoptional
github.event.pull_request.auto_merge.enabled_by.organizations_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.received_events_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.repos_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.site_adminbooleanoptional
github.event.pull_request.auto_merge.enabled_by.starred_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.subscriptions_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.typeBot, User, Organizationoptional
github.event.pull_request.auto_merge.enabled_by.urlstringoptional
github.event.pull_request.base.labelstringrequired
github.event.pull_request.base.repo.allow_auto_mergebooleanoptional

Whether to allow auto-merge for pull requests.

github.event.pull_request.base.repo.allow_update_branchbooleanoptional
github.event.pull_request.base.repo.created_atinteger or stringrequired
github.event.pull_request.base.repo.delete_branch_on_mergebooleanoptional

Whether to delete head branches when pull requests are merged

github.event.pull_request.base.repo.disabledbooleanoptional

Returns whether or not this repository is disabled.

github.event.pull_request.base.repo.licenseobject or nullrequired
github.event.pull_request.base.repo.license.spdx_idstringrequired
github.event.pull_request.base.repo.merge_commit_messagePR_BODY, PR_TITLE, BLANKoptional

The default value for a merge commit message.

  • PR_TITLE - default to the pull request’s title.
  • PR_BODY - default to the pull request’s body.
  • BLANK - default to a blank commit message.
github.event.pull_request.base.repo.merge_commit_titlePR_TITLE, MERGE_MESSAGEoptional

The default value for a merge commit title.

  • PR_TITLE - default to the pull request’s title.
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
github.event.pull_request.base.repo.organizationstringoptional
github.event.pull_request.base.repo.ownerobject or nullrequired
github.event.pull_request.base.repo.owner.avatar_urlstringoptional
github.event.pull_request.base.repo.owner.deletedbooleanoptional
github.event.pull_request.base.repo.owner.emailstring or nulloptional
github.event.pull_request.base.repo.owner.events_urlstringoptional
github.event.pull_request.base.repo.owner.followers_urlstringoptional
github.event.pull_request.base.repo.owner.following_urlstringoptional
github.event.pull_request.base.repo.owner.gists_urlstringoptional
github.event.pull_request.base.repo.owner.gravatar_idstringoptional
github.event.pull_request.base.repo.owner.html_urlstringoptional
github.event.pull_request.base.repo.owner.namestringoptional
github.event.pull_request.base.repo.owner.node_idstringoptional
github.event.pull_request.base.repo.owner.organizations_urlstringoptional
github.event.pull_request.base.repo.owner.received_events_urlstringoptional
github.event.pull_request.base.repo.owner.repos_urlstringoptional
github.event.pull_request.base.repo.owner.site_adminbooleanoptional
github.event.pull_request.base.repo.owner.starred_urlstringoptional
github.event.pull_request.base.repo.owner.subscriptions_urlstringoptional
github.event.pull_request.base.repo.owner.typeBot, User, Organizationoptional
github.event.pull_request.base.repo.owner.urlstringoptional
github.event.pull_request.base.repo.publicbooleanoptional
github.event.pull_request.base.repo.pushed_atnull or integer or stringrequired
github.event.pull_request.base.repo.role_namestring or nulloptional
github.event.pull_request.base.repo.squash_merge_commit_messagePR_BODY, COMMIT_MESSAGES, BLANKoptional

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request’s body.
  • COMMIT_MESSAGES - default to the branch’s commit messages.
  • BLANK - default to a blank commit message.
github.event.pull_request.base.repo.squash_merge_commit_titlePR_TITLE, COMMIT_OR_PR_TITLEoptional

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request’s title.
  • COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
github.event.pull_request.base.repo.stargazersintegeroptional
github.event.pull_request.base.repo.topicsarray of stringsrequired
github.event.pull_request.base.repo.use_squash_pr_title_as_defaultbooleanoptional

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

github.event.pull_request.base.repo.visibilitypublic, private, internalrequired
github.event.pull_request.base.userobject or nullrequired
github.event.pull_request.base.user.avatar_urlstringoptional
github.event.pull_request.base.user.deletedbooleanoptional
github.event.pull_request.base.user.emailstring or nulloptional
github.event.pull_request.base.user.events_urlstringoptional
github.event.pull_request.base.user.followers_urlstringoptional
github.event.pull_request.base.user.following_urlstringoptional
github.event.pull_request.base.user.gists_urlstringoptional
github.event.pull_request.base.user.gravatar_idstringoptional
github.event.pull_request.base.user.html_urlstringoptional
github.event.pull_request.base.user.namestringoptional
github.event.pull_request.base.user.node_idstringoptional
github.event.pull_request.base.user.organizations_urlstringoptional
github.event.pull_request.base.user.received_events_urlstringoptional
github.event.pull_request.base.user.repos_urlstringoptional
github.event.pull_request.base.user.site_adminbooleanoptional
github.event.pull_request.base.user.starred_urlstringoptional
github.event.pull_request.base.user.subscriptions_urlstringoptional
github.event.pull_request.base.user.typeBot, User, Organizationoptional
github.event.pull_request.base.user.urlstringoptional
github.event.pull_request.changed_filesintegeroptional
github.event.pull_request.commentsintegeroptional
github.event.pull_request.commitsintegeroptional
github.event.pull_request.deletionsintegeroptional
github.event.pull_request.draftbooleanrequired

Indicates whether or not the pull request is a draft.

github.event.pull_request.head.labelstring or nullrequired
github.event.pull_request.head.repoobject or nullrequired

A git repository

github.event.pull_request.head.repo.allow_auto_mergebooleanoptional

Whether to allow auto-merge for pull requests.

github.event.pull_request.head.repo.allow_update_branchbooleanoptional
github.event.pull_request.head.repo.created_atinteger or stringrequired
github.event.pull_request.head.repo.delete_branch_on_mergebooleanoptional

Whether to delete head branches when pull requests are merged

github.event.pull_request.head.repo.disabledbooleanoptional

Returns whether or not this repository is disabled.

github.event.pull_request.head.repo.license.spdx_idstringrequired
github.event.pull_request.head.repo.merge_commit_messagePR_BODY, PR_TITLE, BLANKoptional

The default value for a merge commit message.

github.event.pull_request.head.repo.merge_commit_titlePR_TITLE, MERGE_MESSAGEoptional

The default value for a merge commit message title.

github.event.pull_request.head.repo.organizationstringoptional
github.event.pull_request.head.repo.ownerobject or nullrequired
github.event.pull_request.head.repo.owner.avatar_urlstringoptional
github.event.pull_request.head.repo.owner.deletedbooleanoptional
github.event.pull_request.head.repo.owner.emailstring or nulloptional
github.event.pull_request.head.repo.owner.events_urlstringoptional
github.event.pull_request.head.repo.owner.followers_urlstringoptional
github.event.pull_request.head.repo.owner.following_urlstringoptional
github.event.pull_request.head.repo.owner.gists_urlstringoptional
github.event.pull_request.head.repo.owner.gravatar_idstringoptional
github.event.pull_request.head.repo.owner.html_urlstringoptional
github.event.pull_request.head.repo.owner.namestringoptional
github.event.pull_request.head.repo.owner.node_idstringoptional
github.event.pull_request.head.repo.owner.organizations_urlstringoptional
github.event.pull_request.head.repo.owner.received_events_urlstringoptional
github.event.pull_request.head.repo.owner.repos_urlstringoptional
github.event.pull_request.head.repo.owner.site_adminbooleanoptional
github.event.pull_request.head.repo.owner.starred_urlstringoptional
github.event.pull_request.head.repo.owner.subscriptions_urlstringoptional
github.event.pull_request.head.repo.owner.typeBot, User, Organizationoptional
github.event.pull_request.head.repo.owner.urlstringoptional
github.event.pull_request.head.repo.publicbooleanoptional
github.event.pull_request.head.repo.pushed_atnull or integer or stringrequired
github.event.pull_request.head.repo.role_namestring or nulloptional
github.event.pull_request.head.repo.squash_merge_commit_messagePR_BODY, COMMIT_MESSAGES, BLANKoptional

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request’s body.
  • COMMIT_MESSAGES - default to the branch’s commit messages.
  • BLANK - default to a blank commit message.
github.event.pull_request.head.repo.squash_merge_commit_titlePR_TITLE, COMMIT_OR_PR_TITLEoptional

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request’s title.
  • COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
github.event.pull_request.head.repo.stargazersintegeroptional
github.event.pull_request.head.repo.topicsarray of stringsrequired
github.event.pull_request.head.repo.use_squash_pr_title_as_defaultbooleanoptional

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

github.event.pull_request.head.repo.visibilitypublic, private, internalrequired
github.event.pull_request.head.userobject or nullrequired
github.event.pull_request.head.user.avatar_urlstringoptional
github.event.pull_request.head.user.deletedbooleanoptional
github.event.pull_request.head.user.emailstring or nulloptional
github.event.pull_request.head.user.events_urlstringoptional
github.event.pull_request.head.user.followers_urlstringoptional
github.event.pull_request.head.user.following_urlstringoptional
github.event.pull_request.head.user.gists_urlstringoptional
github.event.pull_request.head.user.gravatar_idstringoptional
github.event.pull_request.head.user.html_urlstringoptional
github.event.pull_request.head.user.namestringoptional
github.event.pull_request.head.user.node_idstringoptional
github.event.pull_request.head.user.organizations_urlstringoptional
github.event.pull_request.head.user.received_events_urlstringoptional
github.event.pull_request.head.user.repos_urlstringoptional
github.event.pull_request.head.user.site_adminbooleanoptional
github.event.pull_request.head.user.starred_urlstringoptional
github.event.pull_request.head.user.subscriptions_urlstringoptional
github.event.pull_request.head.user.typeBot, User, Organizationoptional
github.event.pull_request.head.user.urlstringoptional
github.event.pull_request.maintainer_can_modifybooleanoptional

Indicates whether maintainers can modify the pull request.

github.event.pull_request.mergeableboolean or nulloptional
github.event.pull_request.mergeable_statestringoptional
github.event.pull_request.mergedboolean or nulloptional
github.event.pull_request.merged_byobject or nulloptional
github.event.pull_request.merged_by.avatar_urlstringoptional
github.event.pull_request.merged_by.deletedbooleanoptional
github.event.pull_request.merged_by.events_urlstringoptional
github.event.pull_request.merged_by.followers_urlstringoptional
github.event.pull_request.merged_by.following_urlstringoptional
github.event.pull_request.merged_by.gists_urlstringoptional
github.event.pull_request.merged_by.gravatar_idstringoptional
github.event.pull_request.merged_by.html_urlstringoptional
github.event.pull_request.merged_by.namestringoptional
github.event.pull_request.merged_by.node_idstringoptional
github.event.pull_request.merged_by.organizations_urlstringoptional
github.event.pull_request.merged_by.received_events_urlstringoptional
github.event.pull_request.merged_by.repos_urlstringoptional
github.event.pull_request.merged_by.site_adminbooleanoptional
github.event.pull_request.merged_by.starred_urlstringoptional
github.event.pull_request.merged_by.subscriptions_urlstringoptional
github.event.pull_request.merged_by.typeBot, User, Organizationoptional
github.event.pull_request.merged_by.urlstringoptional
github.event.pull_request.milestoneobject or nullrequired

A collection of related issues and pull requests.

github.event.pull_request.milestone.creatorobject or nullrequired
github.event.pull_request.milestone.creator.avatar_urlstringoptional
github.event.pull_request.milestone.creator.deletedbooleanoptional
github.event.pull_request.milestone.creator.events_urlstringoptional
github.event.pull_request.milestone.creator.followers_urlstringoptional
github.event.pull_request.milestone.creator.following_urlstringoptional
github.event.pull_request.milestone.creator.gists_urlstringoptional
github.event.pull_request.milestone.creator.gravatar_idstringoptional
github.event.pull_request.milestone.creator.html_urlstringoptional
github.event.pull_request.milestone.creator.namestringoptional
github.event.pull_request.milestone.creator.node_idstringoptional
github.event.pull_request.milestone.creator.organizations_urlstringoptional
github.event.pull_request.milestone.creator.received_events_urlstringoptional
github.event.pull_request.milestone.creator.repos_urlstringoptional
github.event.pull_request.milestone.creator.site_adminbooleanoptional
github.event.pull_request.milestone.creator.starred_urlstringoptional
github.event.pull_request.milestone.creator.subscriptions_urlstringoptional
github.event.pull_request.milestone.creator.typeBot, User, Organization, Mannequinoptional
github.event.pull_request.milestone.creator.urlstringoptional
github.event.pull_request.requested_reviewersarrayrequired
github.event.pull_request.requested_teamsarray of objectsrequired
github.event.pull_request.requested_teams.deletedbooleanoptional
github.event.pull_request.requested_teams.descriptionstring or nulloptional

Description of the team

github.event.pull_request.requested_teams.html_urlstringoptional
github.event.pull_request.requested_teams.members_urlstringoptional
github.event.pull_request.requested_teams.node_idstringoptional
github.event.pull_request.requested_teams.parentobject or nulloptional
github.event.pull_request.requested_teams.parent.descriptionstring or nullrequired

Description of the team

github.event.pull_request.requested_teams.parent.html_urlstringrequired
github.event.pull_request.requested_teams.parent.idintegerrequired

Unique identifier of the team

github.event.pull_request.requested_teams.parent.members_urlstringrequired
github.event.pull_request.requested_teams.parent.namestringrequired

Name of the team

github.event.pull_request.requested_teams.parent.node_idstringrequired
github.event.pull_request.requested_teams.parent.permissionstringrequired

Permission that the team will have for its repositories

github.event.pull_request.requested_teams.parent.privacyopen, closed, secretrequired
github.event.pull_request.requested_teams.parent.repositories_urlstringrequired
github.event.pull_request.requested_teams.parent.slugstringrequired
github.event.pull_request.requested_teams.parent.urlstringrequired

URL for the team

github.event.pull_request.requested_teams.permissionstringoptional

Permission that the team will have for its repositories

github.event.pull_request.requested_teams.privacyopen, closed, secretoptional
github.event.pull_request.requested_teams.repositories_urlstringoptional
github.event.pull_request.requested_teams.slugstringoptional
github.event.pull_request.requested_teams.urlstringoptional

URL for the team

github.event.pull_request.review_commentsintegeroptional
github.event.pull_request.userobject or nullrequired
github.event.pull_request.user.avatar_urlstringoptional
github.event.pull_request.user.deletedbooleanoptional
github.event.pull_request.user.events_urlstringoptional
github.event.pull_request.user.followers_urlstringoptional
github.event.pull_request.user.following_urlstringoptional
github.event.pull_request.user.gists_urlstringoptional
github.event.pull_request.user.gravatar_idstringoptional
github.event.pull_request.user.html_urlstringoptional
github.event.pull_request.user.namestringoptional
github.event.pull_request.user.node_idstringoptional
github.event.pull_request.user.organizations_urlstringoptional
github.event.pull_request.user.received_events_urlstringoptional
github.event.pull_request.user.repos_urlstringoptional
github.event.pull_request.user.site_adminbooleanoptional
github.event.pull_request.user.starred_urlstringoptional
github.event.pull_request.user.subscriptions_urlstringoptional
github.event.pull_request.user.typeBot, User, Organization, Mannequinoptional
github.event.pull_request.user.urlstringoptional
github.event.senderobjectrequired

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.

fieldtyperequireddescription
github.event.actionunlockedrequired
github.event.installationobjectoptional

The GitHub App installation. Webhook payloads contain the installation property when the event is configured for and sent to a GitHub App. For more information, see “Using webhooks with GitHub Apps."

github.event.pull_request.active_lock_reasonresolved, off-topic, too heated, spam, Nonerequired
github.event.pull_request.additionsintegeroptional
github.event.pull_request.assigneeobject or nullrequired
github.event.pull_request.assignee.avatar_urlstringoptional
github.event.pull_request.assignee.deletedbooleanoptional
github.event.pull_request.assignee.events_urlstringoptional
github.event.pull_request.assignee.followers_urlstringoptional
github.event.pull_request.assignee.following_urlstringoptional
github.event.pull_request.assignee.gists_urlstringoptional
github.event.pull_request.assignee.gravatar_idstringoptional
github.event.pull_request.assignee.html_urlstringoptional
github.event.pull_request.assignee.namestringoptional
github.event.pull_request.assignee.node_idstringoptional
github.event.pull_request.assignee.organizations_urlstringoptional
github.event.pull_request.assignee.received_events_urlstringoptional
github.event.pull_request.assignee.repos_urlstringoptional
github.event.pull_request.assignee.site_adminbooleanoptional
github.event.pull_request.assignee.starred_urlstringoptional
github.event.pull_request.assignee.subscriptions_urlstringoptional
github.event.pull_request.assignee.typeBot, User, Organizationoptional
github.event.pull_request.assignee.urlstringoptional
github.event.pull_request.assigneesarray of object,nullsrequired
github.event.pull_request.auto_merge.commit_messagestring or nullrequired

Commit message for the merge commit.

github.event.pull_request.auto_merge.commit_titlestringrequired

Title for the merge commit message.

github.event.pull_request.auto_merge.enabled_byobject or nullrequired
github.event.pull_request.auto_merge.enabled_by.avatar_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.deletedbooleanoptional
github.event.pull_request.auto_merge.enabled_by.events_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.followers_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.following_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.gists_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.gravatar_idstringoptional
github.event.pull_request.auto_merge.enabled_by.html_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.namestringoptional
github.event.pull_request.auto_merge.enabled_by.node_idstringoptional
github.event.pull_request.auto_merge.enabled_by.organizations_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.received_events_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.repos_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.site_adminbooleanoptional
github.event.pull_request.auto_merge.enabled_by.starred_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.subscriptions_urlstringoptional
github.event.pull_request.auto_merge.enabled_by.typeBot, User, Organizationoptional
github.event.pull_request.auto_merge.enabled_by.urlstringoptional
github.event.pull_request.base.labelstringrequired
github.event.pull_request.base.repo.allow_auto_mergebooleanoptional

Whether to allow auto-merge for pull requests.

github.event.pull_request.base.repo.allow_update_branchbooleanoptional
github.event.pull_request.base.repo.created_atinteger or stringrequired
github.event.pull_request.base.repo.delete_branch_on_mergebooleanoptional

Whether to delete head branches when pull requests are merged

github.event.pull_request.base.repo.disabledbooleanoptional

Returns whether or not this repository is disabled.

github.event.pull_request.base.repo.licenseobject or nullrequired
github.event.pull_request.base.repo.license.spdx_idstringrequired
github.event.pull_request.base.repo.merge_commit_messagePR_BODY, PR_TITLE, BLANKoptional

The default value for a merge commit message.

  • PR_TITLE - default to the pull request’s title.
  • PR_BODY - default to the pull request’s body.
  • BLANK - default to a blank commit message.
github.event.pull_request.base.repo.merge_commit_titlePR_TITLE, MERGE_MESSAGEoptional

The default value for a merge commit title.

  • PR_TITLE - default to the pull request’s title.
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
github.event.pull_request.base.repo.organizationstringoptional
github.event.pull_request.base.repo.ownerobject or nullrequired
github.event.pull_request.base.repo.owner.avatar_urlstringoptional
github.event.pull_request.base.repo.owner.deletedbooleanoptional
github.event.pull_request.base.repo.owner.emailstring or nulloptional
github.event.pull_request.base.repo.owner.events_urlstringoptional
github.event.pull_request.base.repo.owner.followers_urlstringoptional
github.event.pull_request.base.repo.owner.following_urlstringoptional
github.event.pull_request.base.repo.owner.gists_urlstringoptional
github.event.pull_request.base.repo.owner.gravatar_idstringoptional
github.event.pull_request.base.repo.owner.html_urlstringoptional
github.event.pull_request.base.repo.owner.namestringoptional
github.event.pull_request.base.repo.owner.node_idstringoptional
github.event.pull_request.base.repo.owner.organizations_urlstringoptional
github.event.pull_request.base.repo.owner.received_events_urlstringoptional
github.event.pull_request.base.repo.owner.repos_urlstringoptional
github.event.pull_request.base.repo.owner.site_adminbooleanoptional
github.event.pull_request.base.repo.owner.starred_urlstringoptional
github.event.pull_request.base.repo.owner.subscriptions_urlstringoptional
github.event.pull_request.base.repo.owner.typeBot, User, Organizationoptional
github.event.pull_request.base.repo.owner.urlstringoptional
github.event.pull_request.base.repo.publicbooleanoptional
github.event.pull_request.base.repo.pushed_atnull or integer or stringrequired
github.event.pull_request.base.repo.role_namestring or nulloptional
github.event.pull_request.base.repo.squash_merge_commit_messagePR_BODY, COMMIT_MESSAGES, BLANKoptional

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request’s body.
  • COMMIT_MESSAGES - default to the branch’s commit messages.
  • BLANK - default to a blank commit message.
github.event.pull_request.base.repo.squash_merge_commit_titlePR_TITLE, COMMIT_OR_PR_TITLEoptional

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request’s title.
  • COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
github.event.pull_request.base.repo.stargazersintegeroptional
github.event.pull_request.base.repo.topicsarray of stringsrequired
github.event.pull_request.base.repo.use_squash_pr_title_as_defaultbooleanoptional

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

github.event.pull_request.base.repo.visibilitypublic, private, internalrequired
github.event.pull_request.base.userobject or nullrequired
github.event.pull_request.base.user.avatar_urlstringoptional
github.event.pull_request.base.user.deletedbooleanoptional
github.event.pull_request.base.user.emailstring or nulloptional
github.event.pull_request.base.user.events_urlstringoptional
github.event.pull_request.base.user.followers_urlstringoptional
github.event.pull_request.base.user.following_urlstringoptional
github.event.pull_request.base.user.gists_urlstringoptional
github.event.pull_request.base.user.gravatar_idstringoptional
github.event.pull_request.base.user.html_urlstringoptional
github.event.pull_request.base.user.namestringoptional
github.event.pull_request.base.user.node_idstringoptional
github.event.pull_request.base.user.organizations_urlstringoptional
github.event.pull_request.base.user.received_events_urlstringoptional
github.event.pull_request.base.user.repos_urlstringoptional
github.event.pull_request.base.user.site_adminbooleanoptional
github.event.pull_request.base.user.starred_urlstringoptional
github.event.pull_request.base.user.subscriptions_urlstringoptional
github.event.pull_request.base.user.typeBot, User, Organizationoptional
github.event.pull_request.base.user.urlstringoptional
github.event.pull_request.changed_filesintegeroptional
github.event.pull_request.commentsintegeroptional
github.event.pull_request.commitsintegeroptional
github.event.pull_request.deletionsintegeroptional
github.event.pull_request.draftbooleanrequired

Indicates whether or not the pull request is a draft.

github.event.pull_request.head.labelstringrequired
github.event.pull_request.head.repoobject or nullrequired

A git repository

github.event.pull_request.head.repo.allow_auto_mergebooleanoptional

Whether to allow auto-merge for pull requests.

github.event.pull_request.head.repo.allow_update_branchbooleanoptional
github.event.pull_request.head.repo.created_atinteger or stringrequired
github.event.pull_request.head.repo.delete_branch_on_mergebooleanoptional

Whether to delete head branches when pull requests are merged

github.event.pull_request.head.repo.disabledbooleanoptional

Returns whether or not this repository is disabled.

github.event.pull_request.head.repo.license.spdx_idstringrequired
github.event.pull_request.head.repo.merge_commit_messagePR_BODY, PR_TITLE, BLANKoptional

The default value for a merge commit message.

  • PR_TITLE - default to the pull request’s title.
  • PR_BODY - default to the pull request’s body.
  • BLANK - default to a blank commit message.
github.event.pull_request.head.repo.merge_commit_titlePR_TITLE, MERGE_MESSAGEoptional

The default value for a merge commit title.

  • PR_TITLE - default to the pull request’s title.
  • MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
github.event.pull_request.head.repo.organizationstringoptional
github.event.pull_request.head.repo.ownerobject or nullrequired
github.event.pull_request.head.repo.owner.avatar_urlstringoptional
github.event.pull_request.head.repo.owner.deletedbooleanoptional
github.event.pull_request.head.repo.owner.emailstring or nulloptional
github.event.pull_request.head.repo.owner.events_urlstringoptional
github.event.pull_request.head.repo.owner.followers_urlstringoptional
github.event.pull_request.head.repo.owner.following_urlstringoptional
github.event.pull_request.head.repo.owner.gists_urlstringoptional
github.event.pull_request.head.repo.owner.gravatar_idstringoptional
github.event.pull_request.head.repo.owner.html_urlstringoptional
github.event.pull_request.head.repo.owner.namestringoptional
github.event.pull_request.head.repo.owner.node_idstringoptional
github.event.pull_request.head.repo.owner.organizations_urlstringoptional
github.event.pull_request.head.repo.owner.received_events_urlstringoptional
github.event.pull_request.head.repo.owner.repos_urlstringoptional
github.event.pull_request.head.repo.owner.site_adminbooleanoptional
github.event.pull_request.head.repo.owner.starred_urlstringoptional
github.event.pull_request.head.repo.owner.subscriptions_urlstringoptional
github.event.pull_request.head.repo.owner.typeBot, User, Organizationoptional
github.event.pull_request.head.repo.owner.urlstringoptional
github.event.pull_request.head.repo.publicbooleanoptional
github.event.pull_request.head.repo.pushed_atnull or integer or stringrequired
github.event.pull_request.head.repo.role_namestring or nulloptional
github.event.pull_request.head.repo.squash_merge_commit_messagePR_BODY, COMMIT_MESSAGES, BLANKoptional

The default value for a squash merge commit message:

  • PR_BODY - default to the pull request’s body.
  • COMMIT_MESSAGES - default to the branch’s commit messages.
  • BLANK - default to a blank commit message.
github.event.pull_request.head.repo.squash_merge_commit_titlePR_TITLE, COMMIT_OR_PR_TITLEoptional

The default value for a squash merge commit title:

  • PR_TITLE - default to the pull request’s title.
  • COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).
github.event.pull_request.head.repo.stargazersintegeroptional
github.event.pull_request.head.repo.topicsarray of stringsrequired
github.event.pull_request.head.repo.use_squash_pr_title_as_defaultbooleanoptional

Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use squash_merge_commit_title instead.

github.event.pull_request.head.repo.visibilitypublic, private, internalrequired
github.event.pull_request.head.userobject or nullrequired
github.event.pull_request.head.user.avatar_urlstringoptional
github.event.pull_request.head.user.deletedbooleanoptional
github.event.pull_request.head.user.emailstring or nulloptional
github.event.pull_request.head.user.events_urlstringoptional
github.event.pull_request.head.user.followers_urlstringoptional
github.event.pull_request.head.user.following_urlstringoptional
github.event.pull_request.head.user.gists_urlstringoptional
github.event.pull_request.head.user.gravatar_idstringoptional
github.event.pull_request.head.user.html_urlstringoptional
github.event.pull_request.head.user.namestringoptional
github.event.pull_request.head.user.node_idstringoptional
github.event.pull_request.head.user.organizations_urlstringoptional
github.event.pull_request.head.user.received_events_urlstringoptional
github.event.pull_request.head.user.repos_urlstringoptional
github.event.pull_request.head.user.site_adminbooleanoptional
github.event.pull_request.head.user.starred_urlstringoptional
github.event.pull_request.head.user.subscriptions_urlstringoptional
github.event.pull_request.head.user.typeBot, User, Organizationoptional
github.event.pull_request.head.user.urlstringoptional
github.event.pull_request.maintainer_can_modifybooleanoptional

Indicates whether maintainers can modify the pull request.

github.event.pull_request.mergeableboolean or nulloptional
github.event.pull_request.mergeable_statestringoptional
github.event.pull_request.mergedboolean or nulloptional
github.event.pull_request.merged_byobject or nulloptional
github.event.pull_request.merged_by.avatar_urlstringoptional
github.event.pull_request.merged_by.deletedbooleanoptional
github.event.pull_request.merged_by.events_urlstringoptional
github.event.pull_request.merged_by.followers_urlstringoptional
github.event.pull_request.merged_by.following_urlstringoptional
github.event.pull_request.merged_by.gists_urlstringoptional
github.event.pull_request.merged_by.gravatar_idstringoptional
github.event.pull_request.merged_by.html_urlstringoptional
github.event.pull_request.merged_by.namestringoptional
github.event.pull_request.merged_by.node_idstringoptional
github.event.pull_request.merged_by.organizations_urlstringoptional
github.event.pull_request.merged_by.received_events_urlstringoptional
github.event.pull_request.merged_by.repos_urlstringoptional
github.event.pull_request.merged_by.site_adminbooleanoptional
github.event.pull_request.merged_by.starred_urlstringoptional
github.event.pull_request.merged_by.subscriptions_urlstringoptional
github.event.pull_request.merged_by.typeBot, User, Organizationoptional
github.event.pull_request.merged_by.urlstringoptional
github.event.pull_request.milestoneobject or nullrequired

A collection of related issues and pull requests.

github.event.pull_request.milestone.creatorobject or nullrequired
github.event.pull_request.milestone.creator.avatar_urlstringoptional
github.event.pull_request.milestone.creator.deletedbooleanoptional
github.event.pull_request.milestone.creator.events_urlstringoptional
github.event.pull_request.milestone.creator.followers_urlstringoptional
github.event.pull_request.milestone.creator.following_urlstringoptional
github.event.pull_request.milestone.creator.gists_urlstringoptional
github.event.pull_request.milestone.creator.gravatar_idstringoptional
github.event.pull_request.milestone.creator.html_urlstringoptional
github.event.pull_request.milestone.creator.namestringoptional
github.event.pull_request.milestone.creator.node_idstringoptional
github.event.pull_request.milestone.creator.organizations_urlstringoptional
github.event.pull_request.milestone.creator.received_events_urlstringoptional
github.event.pull_request.milestone.creator.repos_urlstringoptional
github.event.pull_request.milestone.creator.site_adminbooleanoptional
github.event.pull_request.milestone.creator.starred_urlstringoptional
github.event.pull_request.milestone.creator.subscriptions_urlstringoptional
github.event.pull_request.milestone.creator.typeBot, User, Organizationoptional
github.event.pull_request.milestone.creator.urlstringoptional
github.event.pull_request.requested_reviewersarrayrequired
github.event.pull_request.requested_teamsarray of objectsrequired
github.event.pull_request.requested_teams.deletedbooleanoptional
github.event.pull_request.requested_teams.descriptionstring or nulloptional

Description of the team

github.event.pull_request.requested_teams.html_urlstringoptional
github.event.pull_request.requested_teams.members_urlstringoptional
github.event.pull_request.requested_teams.node_idstringoptional
github.event.pull_request.requested_teams.parentobject or nulloptional
github.event.pull_request.requested_teams.parent.descriptionstring or nullrequired

Description of the team

github.event.pull_request.requested_teams.parent.html_urlstringrequired
github.event.pull_request.requested_teams.parent.idintegerrequired

Unique identifier of the team

github.event.pull_request.requested_teams.parent.members_urlstringrequired
github.event.pull_request.requested_teams.parent.namestringrequired

Name of the team

github.event.pull_request.requested_teams.parent.node_idstringrequired
github.event.pull_request.requested_teams.parent.permissionstringrequired

Permission that the team will have for its repositories

github.event.pull_request.requested_teams.parent.privacyopen, closed, secretrequired
github.event.pull_request.requested_teams.parent.repositories_urlstringrequired
github.event.pull_request.requested_teams.parent.slugstringrequired
github.event.pull_request.requested_teams.parent.urlstringrequired

URL for the team

github.event.pull_request.requested_teams.permissionstringoptional

Permission that the team will have for its repositories

github.event.pull_request.requested_teams.privacyopen, closed, secretoptional
github.event.pull_request.requested_teams.repositories_urlstringoptional
github.event.pull_request.requested_teams.slugstringoptional
github.event.pull_request.requested_teams.urlstringoptional

URL for the team

github.event.pull_request.review_commentsintegeroptional
github.event.pull_request.userobject or nullrequired
github.event.pull_request.user.avatar_urlstringoptional
github.event.pull_request.user.deletedbooleanoptional
github.event.pull_request.user.events_urlstringoptional
github.event.pull_request.user.followers_urlstringoptional
github.event.pull_request.user.following_urlstringoptional
github.event.pull_request.user.gists_urlstringoptional
github.event.pull_request.user.gravatar_idstringoptional
github.event.pull_request.user.html_urlstringoptional
github.event.pull_request.user.namestringoptional
github.event.pull_request.user.node_idstringoptional
github.event.pull_request.user.organizations_urlstringoptional
github.event.pull_request.user.received_events_urlstringoptional
github.event.pull_request.user.repos_urlstringoptional
github.event.pull_request.user.site_adminbooleanoptional
github.event.pull_request.user.starred_urlstringoptional
github.event.pull_request.user.subscriptions_urlstringoptional
github.event.pull_request.user.typeBot, User, Organizationoptional
github.event.pull_request.user.urlstringoptional
github.event.senderobjectrequired

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"
}