Introduction

Webhooks are like having a helpful assistant who proactively notifies your application when important notarization events occur. Instead of repeatedly asking, “Has the notarization been completed?”, webhooks automatically tap your application on the shoulder when it happens.

Why use webhooks?

• Real-time updates: Get instant notifications when notarization events are completed.

• Automation friendly: Perfect for integrating notarization workflows seamlessly.

• Efficient: No need to constantly poll the API for updates.

• Reliable: Never miss an important event, even if your system is temporarily down.

Getting started

To start receiving webhooks from Beglaubigt, follow these steps:

1. Set up a publicly accessible HTTPS endpoint on your server.

2. Register your webhook URL with Beglaubigt (via your dashboard under /webhooks).

3. Implement a handler to process the notarization.completed event.

Webhook payload example

Here’s an example of the webhook payload you’ll receive for a completed notarization:

{
  "webhook_id": "webhook_abcdef123456",
  "event": "notarization.completed",
  "message": "A document has been notarized.",
  "timestamp": "2024-10-18T12:00:00Z",
  "case": "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=b6V...km3",
  "client_reference": "REF-2025-001"
}

See Delivery and retries for how Beglaubigt delivers events, what acknowledgement we expect, and best practices for handling them safely. For payload authenticity, see Signature Verification.