Webhook: post batch_cancelled — openapi

Sent when a batch has been cancelled.

postWebhookbatch_cancelled

Payload

created_atinteger required

The Unix timestamp (in seconds) of when the batch API request was cancelled.

idstring required

The unique ID of the event.

object'event'

The object of the event. Always event.

type'batch.cancelled' required

The type of the event. Always batch.cancelled.

Return a 200 status code to acknowledge receipt of the event. Non-200 status codes will be retried.

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.