> For the documentation index, fetch https://sync.so/docs/llms.txt. Append .md to a page URL for Markdown. Documentation-search MCP: https://sync.so/docs/_mcp/server.

# Batch Status Update

POST 

Receive a notification when a batch completes or fails

Reference: https://sync.so/docs/api-reference/api/webhooks-payload-reference/webhooks/batch-status-update

## Request

### Headers

- `X-Signature-Primary` (string, required) — An HMAC signature of the payloadd

### Payload

- `id` (string, required) — A unique identifier for the batch.
- `created_at` (datetime, required) — The date and time the batch was created.
- `status` (enum, required) — The current status of the batch.
  - Allowed values: `PENDING`, `JOBS_CREATED`, `PROCESSING`, `COMPLETED`, `FAILED`
- `metrics` (BatchMetrics, required) — Metrics about the batch processing progress.
- `outputUrl` (string, required) — The URL to download the batch results file when completed. A GET request follows a 302 redirect to a signed JSONL result URL.
- `webhookUrl` (string, optional) — The webhook URL for batch status notifications. Deliveries include a Sync-Signature header signed with the organization webhook secret.

## Types

### BatchMetrics

- `total_generations` (integer, required) — Total number of generation requests in the batch.
- `success_count` (integer, required) — Number of successfully completed generations.
- `failed_count` (integer, required) — Number of failed generations.
- `pending_count` (integer, required) — Number of generations still pending or processing.