Document deleted
Headers
HMAC SHA256 signature of the request body. Generated using the webhook's signing key and the raw JSON payload.
Generate the same value in your endpoint and compare it with this header to validate the webhook payload.
"a1b2c3d4e5f67890abcdef1234567890abcdef1234567890abcdef1234567890"
Body
Payload delivered for document-related events. Combines the document resource with
the common webhook envelope fields (event, timestamp, trigger, source).
See the Webhooks guide for a full example payload.
Document generated from a document template and attached to an entry, allocation, or user.
Carries the generated file, its translated name and description, the user who created it, and the resource it is attached to.
Allocation the document is attached to.
Empty array when the document is not attached to an allocation.
Date and time when the document was created.
Description of the document, inherited from the document template.
Map keyed by locale code (for example, en_GB or fr_FR). Keys are drawn from the languages enabled on the account. Values are the translated string.
Entry the document is attached to.
Empty array when the document is not attached to an entry.
Generated document file.
File format of the generated document.
PDF, Word Name of the document.
Map keyed by locale code (for example, en_GB or fr_FR). Keys are drawn from the languages enabled on the account. Values are the translated string.
Specifies whether the document is shared with the entrant.
URL-safe identifier of the document.
User who created the document.
Empty array when no user is attached.
Human-readable name of the event that triggered the webhook.
"Document created"
ISO 8601 formatted datetime indicating when the event occurred.
"2020-01-01T00:00:00Z"
Origin of the change that triggered the event.
ui, api Response
Return any 2xx status code to acknowledge receipt of the event.