Benutzerhandbuch Abbrechen

Neuen Webhook konfigurieren

 

Adobe Acrobat Sign-Handbuch

Neue Funktionen

Erste Schritte

Verwaltung

Senden, Signieren und Verwalten von Vereinbarungen

Erweiterte Vereinbarungsfunktionen und Workflows

Integration in andere Produkte

Acrobat Sign-Entwickler

Support und Fehlerbehebung

Konfigurationsoptionen

Die Konfiguration des Webhook erfordert fünf Elemente definiert werden:

  • Name: Wir empfehlen einen intuitiven Namen, den andere Administrierende sofort verstehen können.
  • Umfang: Welches Ausmaß eines Netzwerks wird von dem Webhook abgedeckt? Konto und Gruppe sind auf der Oberfläche verfügbar.
    • Die API unterstützt die Bereiche „Konto“, „Gruppe“, „Benutzer“ und „Ressourcen“.
    • Pro Webhook kann nur ein Umfang definiert werden.
  • URL: die Ziel-URL, an die Acrobat Sign die JSON-Nutzlast überträgt.
  • Ereignisse: der Auslöser, der Acrobat Sign dazu veranlasst, die JSON-Datei zu erstellen und an die URL zu übertragen.
    • Jedes Ereignis erstellt eine andere Nutzlast, die für das Auslöserereignis relevant ist.
    • In einem Webhook können mehrere Ereignisse enthalten sein.
  • Benachrichtigungsparameter: Mit den Benachrichtigungsparametern werden die Abschnitte der JSON-Ereignis-Nutzlast identifiziert, sodass du nur die Abschnitte des Ereignisses auswählen kannst, die für den betreffenden Webhook relevant sind (damit reduzierst du nicht notwendige Daten, die an deine URL gesendet werden).

Wenn der Webhook vollständig definiert ist, klicke auf Speichern, und der neue Webhook reagiert sofort auf auslösende Ereignisse.

Hinweis:

Konfiguriere die Webhook-URL so, dass sie auf die Webhook-Überprüfungs- und Webhook-Benachrichtigungsanforderungen gemäß dem oben erläuterten Überprüfungsprotokoll reagiert. Die Client-ID (Anwendungs-ID), die an über die Acrobat Sign-Webanwendung erstellte Webhooks gesendet wird, lautet „UB7E5BXCXY“.

Webhook konfigurieren

Geltungsbereiche

  • Konto: Alle abonnierten Ereignisse, die im Konto auftreten, lösen den Push-Vorgang aus.
    • Konto-Admins sind berechtigt, alle für das Konto definierten Webhooks und alle Gruppen innerhalb dieses Kontos anzuzeigen.
  • Gruppe: Alle abonnierten Ereignisse, die in der Gruppe auftreten, lösen den Push-Vorgang aus. HINWEIS: Webhooks im Geltungsbereich der Gruppe existieren nur für diese eine Gruppe.
    • Gruppen-Admins sehen nur die Webhooks für ihre Gruppe. Du kannst die Webhooks auf Kontoebene oder die Webhooks, die an andere Gruppen gebunden sind, nicht sehen.
    • Bei Konten, bei denen die Option Nutzende in mehreren Gruppen aktiviert ist, wird eine Option angezeigt, mit der die Gruppe festgelegt werden kann, auf die der Geltungsbereich angewendet werden soll.
  • Benutzerkonto: Alle abonnierten Ereignisse für ein Benutzerkonto lösen den Push-Vorgang aus. Webhooks auf Benutzerebene können nur über die API erstellt werden.
  • Webhook auf Ressourcenebene: Werden für eine spezifische Ressource erstellt. Die Ereignisse, die für diese Ressource spezifisch sind, werden an die Webhook-URL weitergeleitet. Webhooks auf Ressourcenebene können nur über die API erstellt werden.

URL

Eine Webhook-URL ist ein Server, der auf eingehende HTTPS-POST-Benachrichtigungsmeldungen wartet, die ausgelöst werden, wenn Ereignisse auftreten.

Du benötigst diese URL, damit du dein Webhook Ereignisse abonnieren kannst.

  • Der Client muss eine HTTPS-URL enthalten, an die Acrobat Sign POST-Anforderungen senden kann. Diese URL muss im öffentlichen Internet verfügbar sein.  
    • 127.0.0.1- und localhost-URIs funktionieren beispielsweise nicht.
    • Der URL-Endpunkt muss den Port 443 oder 8443 überwachen (wird von der Kundschaft beim Definieren der Callback-URL festgelegt).
  • Stelle sicher, dass der Webhook POST-Anforderungen für eingehende Ereignisbenachrichtigungen und GET-Anforderungen für die Überprüfungsanforderung unterstützt.
  • Die URL sollte nicht von einer Firewall blockiert werden.

Ereignisse

Im Folgenden findest du die Ereignisse, die eine Push-Übertragung an die Webhook-URL auslösen können, nach Objekten zusammengefasst und in derselben Reihenfolge aufgeführt wie in der Bedienoberfläche.

Der Wert auf der linken Seite ist der Wert, der in der Acrobat Sign-Bedienoberfläche angezeigt wird. Der Wert auf der rechten Seite ist der Webhook-Name in der API.

Ausführliche Informationen zu Webhooks und ihren Nutzlasten findest du im Acrobat Sign-Entwicklungshandbuch.

Vereinbarungen:

UI-Element Webhook-Name
Vereinbarung – alle Ereignisse AGREEMENT_ALL
Vereinbarung erstellt AGREEMENT_CREATED
Vereinbarung gesendet AGREEMENT_ACTION_REQUESTED
Vereinbarungsteilnehmende abgeschlossen AGREEMENT_ACTION_COMPLETED
Vereinbarungs-Workflow abgeschlossen AGREEMENT_WORKFLOW_COMPLETED
Vereinbarung abgelaufen AGREEMENT_EXPIRED
Vereinbarung gelöscht AGREEMENT_DOCUMENTS_DELETED
Vereinbarung storniert AGREEMENT_RECALLED
Vereinbarung abgelehnt AGREEMENT_REJECTED
Vereinbarung freigegeben AGREEMENT_SHARED
Vereinbarungsfreigabe aufgehoben AGREEMENT_UNSHARE
Vereinbarungsfreigabe automatisch aufgehoben AGREEMENT_UNSHARE_AUTO
Vereinbarung delegiert AGREEMENT_ACTION_DELEGATED
Vereinbarungsteilnehmende ersetzt AGREEMENT_ACTION_REPLACED_SIGNER
Vereinbarung geändert AGREEMENT_MODIFIED
Vereinbarungsänderung bestätigt AGREEMENT_USER_ACK_AGREEMENT_MODIFIED
Vereinbarungs-E-Mail angezeigt AGREEMENT_EMAIL_VIEWED
Vereinbarungs-E-Mail nicht zustellbar AGREEMENT_EMAIL_BOUNCED
Vereinbarungsdokument angezeigt AGREEMENT_DOCUMENTS_VIEWED
Vereinbarungsdokument angezeigt, wenn ein Kennwort zum Anzeigen des Dokuments angewendet wurde AGREEMENT_DOCUMENTS_VIEWED_PASSWORD_PROTECTED
Fehler bei Vereinbarungserstellung AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM
Vereinbarung nach Offlineereignis synchronisiert AGREEMENT_OFFLINE_SYNC
Vereinbarung archiviert AGREEMENT_VAULTED
Soziale Identität der an der Vereinbarung teilnehmenden Partei authentifiziert AGREEMENT_WEB_IDENTITY_AUTHENTICATED
Vereinbarungsteilnehmende per KBA authentifiziert AGREEMENT_KBA_AUTHENTICATED
E-Mail-OTP von Vereinbarungsbeteiligtem authentifiziert
AGREEMENT_EMAIL_OTP_AUTHENTICATED
Vereinbarungsablauf aktualisiert AGREEMENT_EXPIRATION_UPDATED
Vereinbarungserinnerung gesendet AGREEMENT_REMINDER_SENT
Der Name der die Vereinbarung unterzeichnenden Partei wurde von der unterzeichnenden Partei geändert AGREEMENT_SIGNER_NAME_CHANGED_BY_SIGNER
Vereinbarungserinnerung gestartet AGREEMENT_REMINDER_INITIATED
   
Nur über die API verfügbare Vereinbarungs-Webhooks
UI-Element Webhook-Name
N/A
AGREEMENT_READY_TO_NOTARIZE
N/A
AGREEMENT_READY_TO_VAULT

 

Massenversand:

UI-Element Webhook-Name
Massenversand – alle Ereignisse MEGASIGN_ALL
Massenversand – erstellt
MEGASIGN_CREATED
Massenversand – freigegeben
MEGASIGN_SHARED
Massenversand – zurückgerufen
MEGASIGN_RECALLED
Massenerinnerung gesendet MEGASIGN_REMINDER_SENT
Massenversand-Erinnerung gestartet MEGASIGN_REMINDER_INITIATED

 

Webformulare:

UI-Element Webhook-Name
Webformular – alle Ereignisse WIDGET_ALL
Webformular erstellt
WIDGET_CREATED
Webformular aktiviert
WIDGET_ENABLED
Webformular deaktiviert
WIDGET_DISABLED
Webformular geändert
WIDGET_MODIFIED
Webformular freigegeben
WIDGET_SHARED
Erstellen von Webformular fehlgeschlagen
WIDGET_AUTO_CANCELLED_CONVERSION_PROBLEM

 

Bibliotheksvorlagen (nur API):

UI-Element Webhook-Name
N/A LIBRARY_DOCUMENT_ALL
N/A LIBRARY_DOCUMENT_CREATED
N/A LIBRARY_DOCUMENT_AUTO_CANCELLED_CONVERSION_PROBLEM
N/A LIBRARY_DOCUMENT_MODIFIED

 

Benachrichtigungsparameter

Mitteilungs-Parameter ermöglichen es dir, die JSON-Nutzlast nur bestimmten Elementen des Ereignisses anzupassen.

Bei einem Vereinbarungsteilnehmende ersetzt-Ereignis könntest du zum Beispiel nur die Vereinbarungsinformationen und die Teilnahmeinformationen erhalten wollen, nicht die Dokumentinformationen, wodurch sich das Gesamtvolumen der an deine Webhook-URL gesendeten JSON-Daten verringert.

 

  • Vereinbarung
    • Vereinbarungsinformationen: detaillierte Vereinbarungsinformationen basierend auf dem Status der Vereinbarung zum Zeitpunkt des auslösenden Ereignisses.
    • Vereinbarungs-Dokumenten-Informationen: enthält alle Dokumentinformationen, die aufgrund des Ereignisses generiert werden.
    • Informationen zur Vereinbarungsteilnahme: Enthält alle Informationen zu den Teilnehmenden als Ergebnis des Ereignisses.
    • Bei der Vereinbarung unterzeichnetes Dokument: Stellt die signierte PDF-Datei zur Verfügung.
      • Gilt für die Ereignisse Vereinbarungsworkflow abgeschlossen und Vereinbarung alle.
  • Massenversand
    • Massenversand – Informationen: detaillierte Informationen über das Massenversand-Objekt, das das Ereignis ausgelöst hat.
  • Webformular
    • Widget-Informationen: detaillierte Informationen über das Webformular, das das Ereignis ausgelöst hat.
    • Informationen zum Widget-Dokument: die Dokumentinformationen, die mit dem Webformular verknüpft sind.
    • Informationen zur Widget-Teilnahme: Informationen zu den im Webformular definierten Teilnehmenden.

Schneller und einfacher Hilfe erhalten

Neuer Benutzer?