---
title: "Broadcast canceled"
method: POST
path: "broadcast.canceled"
tags: ["Broadcasts"]
---

# Broadcast canceled

`POST broadcast.canceled` (webhook)

Triggered when a scheduled or in-flight broadcast is canceled

## Headers

- `webhook-id` string, required
- `webhook-timestamp` string, required
- `webhook-signature` string, required

## Payload

- object
  - `id` string, required: Unique identifier for this webhook event
  - `object` 'event', required
  - `type` 'broadcast.canceled', required: The event type
  - `created_at` string, date-time, required: ISO 8601 timestamp of when the event was created
  - `api_version` string, required: API version used to generate the payload
  - `data` object, required: `object` is the resource exactly as its API endpoint returns it.
    - `object` Broadcast, required
      - `object` string, required
      - `id` string, required
      - `subject` string, nullable, required
      - `preview_text` string, nullable, required
      - `body` string, nullable, required
      - `html_body` string, nullable, required
      - `from` string, nullable, required
      - `reply_to` string, nullable, required
      - `styled` boolean, required
      - `audience` object, required
      - `audience_description` string, required
      - `status` 'draft' | 'scheduled' | 'sending' | 'sent' | 'canceled' | 'failed', required
      - `scheduled_at` string, date-time, nullable, required
      - `started_at` string, date-time, nullable, required
      - `sent_at` string, date-time, nullable, required
      - `canceled_at` string, date-time, nullable, required
      - `stats` object, required
      - `error` string, nullable, required
      - `metadata` object, required
      - `created_at` string, date-time, required
      - `updated_at` string, date-time, required

## Acknowledgement `200`

Return any 2xx status within 5 seconds to acknowledge receipt.

---

[API](https://skmtc.dev/crevio/apis/crevio-api-v1.md) · [All operations](https://skmtc.dev/crevio/apis/crevio-api-v1/llms.txt) · [OpenAPI document](https://skmtc.dev/crevio/apis/crevio-api-v1/revisions/2219f18ad651?raw)