---
title: "Every item of a batch is done"
method: POST
path: "batch.completed"
---

# Every item of a batch is done

`POST batch.completed` (webhook)

Sent to your endpoint as a POST. Answer 2xx within 10 seconds; anything else is retried for about 24 hours.

## Headers

- `CastPDF-Signature` string, required
- `CastPDF-Event-Id` string, required
- `CastPDF-Event-Type` string, required

## Payload

- object
  - `id` string, required: evt_ followed by 32 hex characters; the same for every endpoint receiving it.
  - `type` 'batch.completed', required
  - `created_at` string, date-time, required
  - `livemode` boolean, required
  - `test_event` boolean: Present (true) only on events sent with "Send test event".
  - `data` Batch, required
    - `id` string, uuid
    - `status` 'queued' | 'processing' | 'completed' | 'canceled'
    - `livemode` boolean
    - `source` 'api' | 'spreadsheet'
    - `template_id` string, uuid
    - `template_version` integer
    - `total` integer
    - `queued` integer
    - `processing` integer
    - `succeeded` integer
    - `failed` integer
    - `canceled` integer
    - `created_at` string, date-time
    - `completed_at` string, date-time, nullable
    - `zip` object, nullable
      - `url` string, uri
      - `expires_at` string, date-time
      - `bytes` integer
    - `metadata` object, nullable

## Acknowledgement `200`

Any 2xx acknowledges the event.

---

[API](https://skmtc.dev/castpdf/apis/castpdf-api.md) · [All operations](https://skmtc.dev/castpdf/apis/castpdf-api/llms.txt) · [OpenAPI document](https://skmtc.dev/castpdf/apis/castpdf-api/revisions/4ec737ba2ba6?raw)