Skip to main content
WEBHOOK

Headers

Signature
string
required

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.

Example:

"a1b2c3d4e5f67890abcdef1234567890abcdef1234567890abcdef1234567890"

Body

application/json

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 application, 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

Allocation the document is attached to.

Empty array when the document is not attached to an allocation.

application

Application the document is attached to.

Empty array when the document is not attached to an application.

created_at
string<date-time>

Date and time when the document was created.

description
object

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.

file
object

Generated document file.

file_type
enum<string>

File format of the generated document.

Available options:
PDF,
Word
name
object

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.

shared_with_user
boolean

Specifies whether the document is shared with the applicant.

slug
string

URL-safe identifier of the document.

user

User who created the document.

Empty array when no user is attached.

event
string

Human-readable name of the event that triggered the webhook.

Example:

"Document created"

timestamp
string<date-time>

ISO 8601 formatted datetime indicating when the event occurred.

Example:

"2020-01-01T00:00:00Z"

trigger
string

Machine-readable event key that fired the webhook. Full list of events can be found here.

Example:

"document_created"

source
enum<string>
default:ui

Origin of the change that triggered the event.

Available options:
ui,
api

Response

200

Return any 2xx status code to acknowledge receipt of the event.