Skip to main content

Documentation Index

Fetch the complete documentation index at: https://beglaubigt.de/docs/llms.txt

Use this file to discover all available pages before exploring further.

​
Understanding the Event

The signatures.requested event is triggered automatically when a document requires signatures for completion.

​
Payload Fields

​
webhook_id
string
A unique identifier for this webhook in a UUID format.
Example: 123e4567-e89b-12d3-a456-426614174000
​
event
string
The name of the event that triggered this webhook.
Value: signatures.requested
​
message
string
Provides a human-readable message indicating the result of the webhook event.
Value: The requests for document signatures have been sent.
​
timestamp
string
The exact date and time when the webhook was triggered, formatted as an ISO 8601 string in UTC.
Example: 2024-12-01T07:19:30.443Z
​
service
string
The type of service this webhook relates to.
Possible values: signature or notarization
​
case_id
string
The unique identifier for the case in a UUID format.
Example: 123e4567-e89b-12d3-a456-426614174000
​
document_id
string
The unique identifier for the document in a UUID format.
Example: 123e4567-e89b-12d3-a456-426614174000
​
document_status
string
Indicates the current status of the document.
Possible values: draft, signatures-requested, waiting-for-verifications, notarization-started or completed
​
signers
array
List of signers included in this case.
​
client_reference
string
Your 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"
}