---
title: "Pull request batch canceled"
method: POST
path: "pull_request_batch.canceled"
---

# Pull request batch canceled

`POST pull_request_batch.canceled` (webhook)

Triggered when a batch of PRs is canceled

## Payload

- object — Triggered when a batch of PRs is canceled
  - `test_branch` string, required — The branch the pull request or pull request batch was tested on
  - `test_branch_sha` string, required — The SHA of the branch the pull request or pull request batch was tested on
  - `test_pr_number` integer — 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_bisection` boolean, 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_numbers` integer[], required — The PR numbers of the pull requests in the batch
  - `pr_numbers_in_batch` integer[] — 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.
  - `repository` object, required — The repository that the webhook event occurred in
    - `host` string, required — The type of source control for this repository
    - `owner` string, required — The name of the repository
    - `name` string, required — The user or organization that owns the repository
  - `status` 'canceled', required — The current status of the Pull Request batch
  - `target_branch` string, required — The name of the branch targeted by the merge queue where the event occurred
  - `timestamp` string, date-time, required — The ISO 8601 timestamp of when this state transition occurred

---

[API](https://skmtc.dev/trunk/apis/trunk-apis.md) · [All operations](https://skmtc.dev/trunk/apis/trunk-apis/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/trunk/trunk-apis/revisions/f7b911d8e24c/schema)