Signatures Requested
Understanding the Event
The signatures.requested event is triggered automatically when a document requires signatures for completion.
Payload Fields
webhook_idstringA unique identifier for this webhook in a UUID format.
Example: 123e4567-e89b-12d3-a456-426614174000
eventstringThe name of the event that triggered this webhook.
Value: signatures.requested
messagestringProvides a human-readable message indicating the result of the webhook event.
Value: The requests for document signatures have been sent.
timestampstringThe exact date and time when the webhook was triggered, formatted as an ISO 8601 string in UTC.
Example: 2024-12-01T07:19:30.443Z
servicestringThe type of service this webhook relates to.
Possible values: signature or notarization
case_idstringThe unique identifier for the case in a UUID format.
Example: 123e4567-e89b-12d3-a456-426614174000
document_idstringThe unique identifier for the document in a UUID format.
Example: 123e4567-e89b-12d3-a456-426614174000
document_statusstringIndicates the current status of the document.
Possible values: draft, signatures-requested, waiting-for-verifications, notarization-started or completed
signersarrayList of signers included in this case.
first_namestringThe first name of the signer.
Example: John
last_namestringThe last name of the signer.
Example: Doe
emailstringThe email address of the signer.
Example: john.doe@mail.com
urlstringA unique invitation link containing an identification token. The link prompts the signer to complete the required actions, such as signing or verifying documents, based on the case's requirements.\
Example: https://app.beglaubigt.de/sign/123e4567-e89b-12d3-a456-426614174000?token=123e4567-e89b-12d3-a456-426614174001
client_referencestringYour custom reference string provided during case creation.
Example: REF-2025-001
{
"webhook_id": "123e4567-e89b-12d3-a456-426614174000",
"event": "signatures.requested",
"message": "The requests for document signatures have been sent.",
"timestamp": "2024-10-18T12:00:00Z",
"service": "signature",
"case_id": "123e4567-e89b-12d3-a456-426614174000",
"document_id": "456e1234-e89b-12d3-a456-426614174001",
"document_status": "signatures-requested",
"signers": [
{
"first_name": "John",
"last_name": "Doe",
"email": "john@example.com",
"url": "https://app.beglaubigt.de/sign/123e4567-e89b-12d3-a456-426614174000?token=123e4567-e89b-12d3-a456-426614174003"
}
],
"client_reference": "REF-2025-001"
}