Legacy-Webhooks bei Legalesign

Was sind Legacy-Webhooks

Legacy-Webhooks sind unser älteres Webhook-System. Wenn Sie Webhooks zum ersten Mal verwenden möchten, nutzen Sie das neuere System - neue Webhooks

Wir werden Legacy-Webhooks auch in absehbarer Zukunft weiterhin unterstützen, um die Abwärtskompatibilität zu gewährleisten. Sollte sich das ändern, werden Sie rechtzeitig informiert. Wir empfehlen Ihnen in jedem Fall ein Upgrade, da die Echtzeit-Webhooks für mehr Ereignisse ausgelöst werden, mehr nützliche Informationen enthalten, effektiver gefiltert werden können und schneller eintreten.

Arten von Webhooks

Es gibt zwei Arten von Legacy-Webhooks.

• Bei [Ereignis] (veraltet)
• Alle Ereignisse alle 6 Minuten (veraltet)

Wie man einen Webhook hinzufügt oder entfernt

Hinzufügen oder Entfernen über die Web App

Gehen Sie zu Einstellungen und Sie sehen das Webhooks-Panel. Das Formular hat einfache Steuerelemente, um Webhooks hinzuzufügen oder zu entfernen.

Gefahr

Ihr API-Schlüssel basiert auf Ihrem Konto und nicht auf einer einzelnen Gruppe oder Organisation. Das gibt Ihrem API-Schlüssel mehr Flexibilität, aber Ihre Webhooks erhalten Informationen von allen Konten, bei denen Sie Administrator sind, sowohl Entwicklungs- als auch Produktionskonten. Um Webhooks nach Gruppen zu unterscheiden, verwenden Sie entweder den Filter oder (die alte Methode) erstellen Sie einen neuen Admin-Benutzer, der nur Mitglied der Zielgruppe(n) ist, erhalten Sie für diesen einen API-Schlüssel und verwenden Sie dieses Konto für Ihren Webhook.

Hinzufügen oder Entfernen über die API

Verwenden Sie einfache GET- und POST-Anfragen über die REST API, um Webhooks aufzulisten, zu erstellen oder zu löschen.

Weitere Informationen finden Sie in der Dokumentation: API Webhooks

Das Format eines 'Bei ...' Webhooks

Dies sind Webhooks, die für ein bestimmtes Ereignis ausgelöst werden - Signierung, Erstellung, Ablehnung oder ein fehlgeschlagener Aufruf.

Diese werden als POST-Anfragen an Ihre URL geliefert.

Diese enthalten den Dokumentnamen, Ereignis-Code, Ressourcen-URI, Tags und UUID des Dokuments. Hier ist die Ausgabe von ngrok.

Das Format eines allgemeinen Updates / 6-Minuten-Webhooks

Der 6-Minuten-Aufruf sieht so aus:

Wie Sie sehen, ist es ebenfalls eine POST-Anfrage. Diesmal sind jedoch alle Informationen im POST-Attribut 'data' als JSON-Objekt gespeichert.

Hier ist dieses JSON-Objekt im Detail:

[
  {
    "value": "5",
    "timestamp": "2022-07-11T07:28:25+00:00",
    "resource_uri": "/api/v1/signer/656926a1-a9e9-434b-91cc-9f9769254e99/",
    "name": "status"
  },
  {
    "value": "10",
    "timestamp": "2022-07-11T07:28:26+00:00",
    "resource_uri": "/api/v1/signer/656926a1-a9e9-434b-91cc-9f9769254e99/",
    "name": "status"
  },
  {
    "value": "20",
    "timestamp": "2022-07-11T07:28:55+00:00",
    "resource_uri": "/api/v1/signer/656926a1-a9e9-434b-91cc-9f9769254e99/",
    "name": "status"
  },
  {
    "value": "20",
    "timestamp": "2022-07-11T07:29:06+00:00",
    "resource_uri": "/api/v1/document/6619179c-95da-4d5c-b7be-7bac0bac4088/",
    "name": "status"
  },
  {
    "value": "30",
    "timestamp": "2022-07-11T07:29:06+00:00",
    "resource_uri": "/api/v1/signer/656926a1-a9e9-434b-91cc-9f9769254e99/",
    "name": "status"
  },
  {
    "value": "40",
    "timestamp": "2022-07-11T07:29:06+00:00",
    "resource_uri": "/api/v1/signer/656926a1-a9e9-434b-91cc-9f9769254e99/",
    "name": "status"
  },
  {
    "value": "30",
    "timestamp": "2022-07-11T07:29:06+00:00",
    "resource_uri": "/api/v1/document/6619179c-95da-4d5c-b7be-7bac0bac4088/",
    "name": "status"
  },
  {
    "value": "100",
    "timestamp": "2022-07-11T07:29:09+00:00",
    "resource_uri": "/api/v1/document/6619179c-95da-4d5c-b7be-7bac0bac4088/",
    "name": "status"
  }
]

Was passiert hier? Der allgemeine Update-Webhook gibt Ihnen nun alle Details darüber, was bei der Unterzeichnung eines Dokuments passiert ist und wann. Er enthält Ereignis-Updates sowohl für einen Unterzeichner als auch für ein Dokument.

Warnung

Sie werden bemerkt haben, dass wir die Begriffe 'Empfänger' und 'Unterzeichner' verwenden. Diese sind austauschbar. Die Verwendung von Empfänger spiegelt die komplexeren Rollen wider, die jetzt in Legalesign verfügbar sind, und wird der neue Begriff für 'Unterzeichner' sein, während wir die Entwicklung fortsetzen.

Die Geschichte dieser Webhook-Daten ist, dass das Unterzeichnerobjekt erstellt wurde (Unterzeichner 5), versendet (Unterzeichner 10), der Unterzeichner sein Feld ausgefüllt hat (Unterzeichner 30) und unterschrieben hat (Unterzeichner 40), das Dokument festgestellt hat, dass seine Felder ausgefüllt sind (Dokument 20), dann als unterschrieben markiert wurde (Dokument 30) und dann zum Download bereitsteht (Dokument 100).

'100' ist ein spezieller Ereignis-Code zur Bestätigung, dass ein Dokument zum Herunterladen bereit ist.

Dokumentenstatus

Status	Erklärung
10	Versendet
20	Felder ausgefüllt
30	Abgeschlossen
40	Entfernt (vor dem Signieren)
50	Abgelehnt

Status des Unterzeichners

Status	Erklärung
4	Nicht versendet
5	Zum Versand geplant
10	Versendet
15	E-Mail geöffnet
20	Aufgerufen
30	Felder ausgefüllt
35	Felder bis auf Unterschriftsfelder fertig
39	Zeuge zum Unterschreiben
40	Abgeschlossen
50	Heruntergeladen
60	Abgelehnt

Debuggen von Webhooks im API-Dashboard

Alle Webhooks werden protokolliert, und Sie können deren Inhalt sowie den HTTP-Statuscode in Ihrem API-Dashboard prüfen. Um mehr zu erfahren, sehen Sie sich das Dashboard-Tutorial an.

Gehen Sie direkt zum API-Dashboard.

Kontaktieren Sie uns

Das sollte alles abdecken, was Sie über Legacy-Webhooks wissen müssen.

Wenn Sie weitere Fragen haben, nehmen Sie bitte Kontakt auf - support.legalesign.com.