Sign in

v2

latestOpenAPI 3.1.0UNLICENSED2026-07-26210239.8 KB

Pull request batch canceled

Triggered when a batch of PRs is canceled

postWebhookpull_request_batch.canceled

Payload

test_branchstring required

The branch the pull request or pull request batch was tested on

test_branch_shastring required

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

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 batch was canceled

is_bisectionboolean required

Whether this event is part of a bisection test run

type'pull_request_batch.canceled' required

The type of webhook event that occurred

action'canceled' required

The type of action that triggered the webhook

pr_numbersinteger[] required

The PR numbers of the pull requests in the batch

pr_numbers_in_batchinteger[]

The PR numbers of all pull requests that were tested together in this batch. This may be a superset of pr_numbers if some PRs in the batch failed to merge.

status'canceled' required

The current status of the Pull Request batch

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