v2
latestOpenAPI 3.1.0UNLICENSED2026-07-26210239.8 KBPull request canceled
Triggered when a PR is canceled
postWebhookpull_request.canceled
Payload
test_branchstring
The branch the pull request or pull request batch was tested on
test_branch_shastring
The SHA of the branch the pull request or pull request batch was tested on
test_pr_numberinteger
The number of the pull request used to test the pull request or pull request batch
batchedboolean
Whether this pull request was part of a batch
cancellation_reason'USER_REQUESTED' | 'PR_CLOSED' | 'PR_PUSHED_TO' | 'PR_BASE_BRANCH_CHANGED' | 'TRUNK_ADMIN_REQUESTED' | 'PR_CONVERTED_TO_DRAFT' | 'STACKED_PR_MEMBER_PUSHED_TO' | 'STACKED_PR_MEMBER_CLOSED' | 'STACKED_PR_MEMBER_MERGED' | 'STACKED_PR_MEMBER_BASE_BRANCH_CHANGED'
The reason the PR was canceled
is_bisectionboolean required
Whether this event is part of a bisection test run
type'pull_request.canceled' required
The type of webhook event that occurred
action'canceled' required
The type of action that triggered the webhook
authorstring required
The username of the author of the PR
http_details_urlstring uri required
Web link to the details about this PR
pr_numberinteger required
The PR number
status'canceled' required
The current status of the PR
target_branchstring required
The name of the branch targeted by the merge queue where the event occurred
timestampstring date-time required
The ISO 8601 timestamp of when this state transition occurred