{
"allocation": [],
"application": {
"slug": "AbCdEfGh",
"link": "https://api.au.cr4ce.com/application/AbCdEfGh",
"title": "Sustainable Cities Initiative"
},
"created_at": "2025-01-15T09:00:00Z",
"description": {
"en_GB": ""
},
"file": {
"token": "IjKlMnOpQrStUvWx",
"link": "https://api.au.cr4ce.com/file/IjKlMnOpQrStUvWx",
"name": "certificate.pdf",
"download": "https://files.au.cr4ce.com/file/IjKlMnOpQrStUvWx/certificate.pdf?Expires=1781485359&Signature=REDACTED&Key-Pair-Id=REDACTED"
},
"file_type": "PDF",
"name": {
"en_GB": "Certificate of application"
},
"shared_with_user": false,
"slug": "QrStUvWx",
"user": {
"slug": "YzAbCdEf",
"link": "https://api.au.cr4ce.com/user/YzAbCdEf",
"name": "Jane Smith",
"first_name": "Jane",
"last_name": "Smith"
},
"event": "Document created",
"timestamp": "2026-08-14T09:30:00Z",
"trigger": "document_created",
"source": "api"
}Document deleted
{
"allocation": [],
"application": {
"slug": "AbCdEfGh",
"link": "https://api.au.cr4ce.com/application/AbCdEfGh",
"title": "Sustainable Cities Initiative"
},
"created_at": "2025-01-15T09:00:00Z",
"description": {
"en_GB": ""
},
"file": {
"token": "IjKlMnOpQrStUvWx",
"link": "https://api.au.cr4ce.com/file/IjKlMnOpQrStUvWx",
"name": "certificate.pdf",
"download": "https://files.au.cr4ce.com/file/IjKlMnOpQrStUvWx/certificate.pdf?Expires=1781485359&Signature=REDACTED&Key-Pair-Id=REDACTED"
},
"file_type": "PDF",
"name": {
"en_GB": "Certificate of application"
},
"shared_with_user": false,
"slug": "QrStUvWx",
"user": {
"slug": "YzAbCdEf",
"link": "https://api.au.cr4ce.com/user/YzAbCdEf",
"name": "Jane Smith",
"first_name": "Jane",
"last_name": "Smith"
},
"event": "Document created",
"timestamp": "2026-08-14T09:30:00Z",
"trigger": "document_created",
"source": "api"
}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.
Document generated from a document template and attached to an application, allocation, or user.
Allocation the document is attached to, or an empty array when not attached to one.
Show child attributes
Show child attributes
Application the document is attached to, or an empty array when not attached to one.
Show child attributes
Show child attributes
Date and time when the document was created.
Description of the document, inherited from the document template, keyed by locale code.
Show child attributes
Show child attributes
Generated document file.
Show child attributes
Show child attributes
File format of the generated document.
PDF, Word Name of the document, keyed by locale code.
Show child attributes
Show child attributes
Specifies whether the document is shared with the applicant.
URL-safe identifier of the document.
User who created the document, or an empty array when none is attached.
Show child attributes
Show child attributes
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.