---
title: "Flush batch"
method: POST
path: "/api/v1/automations/{automationId}/batches/{batchId}/flush"
tags: ["automations"]
---

# Flush batch

`POST /api/v1/automations/{automationId}/batches/{batchId}/flush`

## Request

- Base URL: `https://api.capy.ai`
- URL: `https://api.capy.ai/api/v1/automations/{automationId}/batches/{batchId}/flush`
- Auth: HTTP bearer

## Path parameters

- `automationId` string, required
- `batchId` string, required

## Response `200`

AutomationWebhookBatch

- AutomationWebhookBatchEncoded
  - `id` string, required
  - `automationId` string, required
  - `triggerId` string, required
  - `status` 'collecting' | 'queued' | 'cancelled', required: Collecting accepts events; queued has one automation run; cancelled retains scrubbed history without a run.
  - `group` WebhookBatchGroupValue[], required
    - union: A non-null finite JSON scalar; string, number, and boolean grouping values remain distinct.
      - string
      - number
      - boolean
  - `eventCount` integer, required
  - `byteCount` integer, required
  - `firstEventAt` string, required
  - `lastEventAt` string, required
  - `dispatchAfter` string, required
  - `maxEvents` integer, required
  - `maxWaitSeconds` integer, required
  - `quietPeriodSeconds` integer, nullable, required
  - `closedAt` string, nullable, required
  - `reason` 'count' | 'quiet' | 'max_wait' | 'bytes' | 'manual' | 'cancelled' | 'configuration_changed' | 'disabled' | 'project_deleted', required: The boundary that closed or cancelled a webhook batch.
  - `runId` string, nullable, required
  - `runStatus` 'queued' | 'running' | 'completed' | 'failed' | 'skipped' | 'cancelled', nullable, required
  - `jamId` string, nullable, required
  - `failure` string, nullable, required

## Other responses

- `400`: capy/InvalidRequest
- `401`: capy/Unauthorized
- `403`: capy/Forbidden
- `404`: capy/AutomationNotFound
- `429`: capy/RateLimited

## Changes

- **2026-10-31** `e3be47264feb`: 1 info
  - added the non-success response with the status `400`
- **2026-09-30** `7187d2287ecd`: 2 breaking, 1 info
  - the response's body type changed from `object` to no type for status `403`
  - removed the required property `_tag` from the response with the `403` status
  - added `#/components/schemas/capy_ForbiddenEncoded, #/components/schemas/capy_ForbiddenEncoded` to the response body `anyOf` list for the response status `403`
- **2026-09-24** `0de0f8cfab7d`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/capy/apis/capy-api/changes/api/v1/automations/:automationId/batches/:batchId/flush/post.md)

---

[API](https://skmtc.dev/capy/apis/capy-api.md) - [All operations](https://skmtc.dev/capy/apis/capy-api/llms.txt) - [OpenAPI document](https://skmtc.dev/capy/apis/capy-api/revisions/4663f7dc4e39?raw)