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 notarization.completed event is triggered automatically when a notarization process has been successfully completed and the notarized document is available for download.

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: notarization.completed
message
string
Provides a human-readable message indicating the result of the webhook event.Value: A document has been notarized.
timestamp
string
The exact date and time when the webhook was triggered, formatted as an ISO 8601 string in UTC.Example2024-12-01T07:19:30.443Z
service
string
The type of service this webhook relates to.Value: notarization
case_id
string
The unique identifier for the created notarization case in a UUID format.Example123e4567-e89b-12d3-a456-426614174000
original_document_id
string
The unique identifier for the original document in a UUID format.Example123e4567-e89b-12d3-a456-426614174000
notarized_document_id
string
The unique identifier for the original document in a UUID format.Example123e4567-e89b-12d3-a456-426614174000
notarized_document_url
string
The URL of the notarized document associated with the case in a PDF format. The URL is available for 24 hours after reception of the webhook HTTP request.Examplehttps://app.beglaubigt.de/download?bucket=notarized_documents&id=789e4567-e89b-12d3-a456-426614174002&token=h4J...f7P
client_reference
string
Your custom reference string provided during notarization creation.Example: REF-2025-001
{
  "webhook_id": "123e4567-e89b-12d3-a456-426614174000",
  "event": "notarization.completed",
  "message": "A document has been notarized.",
  "timestamp": "2024-10-18T12:00:00Z",
  "service": "notarization",
  "case_id": "123e4567-e89b-12d3-a456-426614174000",
  "original_document_id": "456e1234-e89b-12d3-a456-426614174001",
  "notarized_document_id": "789e4567-e89b-12d3-a456-426614174002",
  "notarized_document_url": "https://app.beglaubigt.de/download?bucket=notarized_documents&id=789e4567-e89b-12d3-a456-426614174002&token=h4J...f7P",
  "client_reference": "REF-2025-001"
}