Webhooks einrichten, um Dokumentstatusaktualisierungen zu erhalten

Verwendung von Webhooks zum Abrufen von Dokumentstatusaktualisierungen

🔔 Erhalten Sie automatische Benachrichtigungen, sobald Ihr Dokument fertig ist

Möchten Sie in Echtzeit über den Bearbeitungsstatus Ihrer Dokumente informiert werden? Nutzen Sie Webhooks , um Ihr System automatisch zu benachrichtigen, sobald eine Datei fertiggestellt ist.


🔑 Generieren Sie Ihren Webhook-Geheimschlüssel

  1. Gehen Sie zu Einstellungen > API-Integration

  2. Klicken Sie unter „Webhook-Geheimschlüssel generieren“ auf „Geheimschlüssel generieren“ .

  3. Dieser Schlüssel dient zum Signieren und Validieren eingehender Webhook-Benachrichtigungen.

Bewahren Sie Ihren Schlüssel sicher auf. Wenn Sie ihn neu generieren, stellen Sie sicher, dass Sie ihn in Ihrem Webhook-Verarbeitungssystem aktualisieren.


🔧 Webhook über die API einrichten

Um Dokumentabschlussereignisse zu empfangen, verwenden Sie den Abschnitt Webhooks unter Einstellungen > API-Dokumentation .

🔹 Webhook erstellen

POST /v1/admin/company/webhooks

Beispieltext:

Beispiel für einen Körper

  • Die url muss ein sicherer HTTPS Endpunkt sein, der POST Anfragen akzeptieren kann.

  • Das event sollte "file_processed" sein (derzeit ist dies das verfügbare Ereignis).

🔹 Alle Webhooks auflisten

GET /v1/admin/company/webhooks
Gibt die Liste der bereits in Ihrem Unternehmenskonto konfigurierten Webhooks zurück.

🔹 Einen Webhook löschen

DELETE /v1/admin/company/webhooks/{id}
Verwenden Sie diesen Endpunkt, um einen Webhook anhand seiner ID zu entfernen.

✅ Anwendungsbeispiel

Sobald Ihr Webhook registriert ist, erhalten Sie eine POST Anfrage, wenn die Verarbeitung eines Dokuments abgeschlossen ist.
Beispielantwort:

Stellen Sie sicher, dass Ihr Endpunkt die Anfrage mithilfe Ihres Webhook-Geheimschlüssels verarbeiten und verifizieren kann.

    • Related Articles

    • So generieren Sie Ihren API-Schlüssel

      Um die API nutzen zu können, müssen Sie zuerst Ihren API-Schlüssel generieren. Schritte: Gehen Sie zu Einstellungen > API-Integration Klicken Sie unter „API-Schlüssel generieren“ auf „API-Schlüssel generieren“ . Ihr Schlüssel wird im Feld angezeigt – ...

    • Abrufen und Herunterladen von Dateien mit der API

      ? Dokumente suchen, ansehen und herunterladen Nach dem Hochladen können Sie die API verwenden, um Dateien aufzulisten, zu überprüfen und herunterzuladen. ? Alle Dateien abrufen (Firmenadministratoren) GET /v1/external/admin/company/files ...

    • Hochladen von Dokumenten über die API

      ? Dokumente direkt von Ihrer Plattform hochladen Verwenden Sie die File Upload API , um Dateien zur Barrierefreiheitsverarbeitung von Ihrem eigenen System oder Ihrer eigenen App einzureichen. ? Upload-Endpunkt POST /v1/external/user/files ? ...

    • Verwendung von Bestellungen mit API-Uploads

      ? Dateien im Rahmen einer Bestellung hochladen Bei seitenbasierter Abrechnung müssen Ihre Dateien über ein Enterprise-Abonnement mit einer genehmigten Bestellung verknüpft sein. Die Vorgehensweise ist wie folgt über die API: ? Schritt 1: Bestellen ...

    • Hinzufügen von Teammitgliedern

      Sie können Teammitglieder zu Ihrem Konto einladen und hinzufügen sowie den Dokumentenzugriff verwalten . Schritte zum Hinzufügen eines Teammitglieds: Gehen Sie zu den Einstellungen: Klicken Sie auf Ihr Profilsymbol → „Einstellungen“ . Open ...