---
title: "signature_request.canceled event"
method: POST
path: "signature_request.canceled"
---

# signature_request.canceled event

`POST signature_request.canceled` (webhook)

Signed with `PDFBetter-Signature: t=<unix>,v1=<hex HMAC-SHA256(secret, `${t}.${body}`)>`. Respond with any 2xx within 10 seconds.

## Headers

- `PDFBetter-Signature` string, required

## Payload

- object
  - `id` string, required: evt_…; use it to de-duplicate
  - `type` 'signature_request.canceled', required
  - `created` integer, required: Unix seconds
  - `data` object, required
    - `signatureRequest` object, required
      - `object` 'signature_request', required
      - `id` string, required
      - `documentId` string, required
      - `title` string, required
      - `message` string, nullable, required
      - `status` 'draft' | 'sent' | 'completed' | 'declined' | 'canceled' | 'expired', required
      - `routing` 'sequential' | 'parallel', required
      - `reminderEveryDays` integer, nullable, required
      - `expiresAt` string, nullable, required: ISO 8601 timestamp (UTC)
      - `sentAt` string, nullable, required: ISO 8601 timestamp (UTC)
      - `completedAt` string, nullable, required: ISO 8601 timestamp (UTC)
      - `createdAt` string, required: ISO 8601 timestamp (UTC)
      - `fieldCount` integer, required
      - `hasCompletedFile` boolean, required
      - `hasCertificate` boolean, required
      - `recipients` object[], required
        - `id` string, required
        - `name` string, required
        - `email` string, required
        - `role` 'signer' | 'approver' | 'cc', required
        - `order` integer, required
        - `status` 'pending' | 'sent' | 'viewed' | 'signed' | 'declined', required
        - `authMethod` string, required
        - `sentAt` string, nullable, required: ISO 8601 timestamp (UTC)
        - `viewedAt` string, nullable, required: ISO 8601 timestamp (UTC)
        - `signedAt` string, nullable, required: ISO 8601 timestamp (UTC)
        - `declinedAt` string, nullable, required: ISO 8601 timestamp (UTC)
        - `declineReason` string, nullable, required
    - `recipient` object, nullable, required: The recipient who acted (viewed/signed/declined); null otherwise
      - `id` string, required
      - `name` string, required
      - `email` string, required
      - `role` 'signer' | 'approver' | 'cc', required
      - `order` integer, required
      - `status` 'pending' | 'sent' | 'viewed' | 'signed' | 'declined', required
      - `authMethod` string, required
      - `sentAt` string, nullable, required: ISO 8601 timestamp (UTC)
      - `viewedAt` string, nullable, required: ISO 8601 timestamp (UTC)
      - `signedAt` string, nullable, required: ISO 8601 timestamp (UTC)
      - `declinedAt` string, nullable, required: ISO 8601 timestamp (UTC)
      - `declineReason` string, nullable, required

## Acknowledgement `2XX`

Acknowledged. Anything else (or no answer in 10 s) is retried.

---

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