📖 Inhaltsverzeichnis
Was ist überhaupt ein Webhook ?
Mit Webhooks werden Sie direkt in den Lösungen oder Tools, in denen Sie die API integriert haben, über Ereignisse zur Unterzeichnung Ihrer Dokumente benachrichtigt.
Genauer gesagt ermöglichen Webhooks die Automatisierung von Aktionen rund um die Signatur wie beispielsweise das automatische Herunterladen von Dokumenten nach der Unterzeichnung oder das Anzeigen einer Benachrichtigung in einem dritten Tool, wenn ein Dokument in Yousign unterzeichnet wurde.
So greifen Sie in der Web-App auf Webhooks zu
Klicken Sie im Menü auf "API" und dann auf "Webhooks". >> Screenshots du menu
Falls es sich um Ihren ersten Webhook handelt, schlägt die Web-App vor, Ihren ersten Webhook hinzuzufügen. Falls Sie bereits aktive Webhooks haben, werden diese hier aufgelistet. Klicken Sie einfach auf einen der Webhooks, um mehr Details angezeigt zu bekommen.
So fügen Sie einen Webhook hinzu
Klicken Sie auf der Webhooks-Seite in der Web-Appauf „Webhook erstellen“.
Mit dem ersten Button können Sie den Webhook, den Sie gerade erstellen, sofort aktivieren oder deaktivieren.
Anschließend durchlaufen Sie 3 Schritte zur Erstellung des Webhooks Beginnen Sie mit der Eingabe der URL des Endpunkts. Hierbei handelt es sich um die Zieladresse des Webhooks, an die Sie das vom Webhook betroffene Ereignis senden möchten.
⚠️ Diese Adresse muss mit "https://" beginnen.
Sie können ebenfalls eine kurze Beschreibung des Webhooks hinzufügen, um anzugeben, warum Sie ihn erstellen. Diese Beschreibung ist für die Funktionsweise des Webhooks nicht notwendig, doch die Information wird in ihn eingebunden.
Wählen Sie anschließend die Umgebung des Webhooks.
Sie haben die Auswahl zwischen :
Sandbox: In dieser API-Testumgebung können Sie den Webhook testen, bevor Sie ihn in der Produktionsumgebung implementieren.
Produktion: Die Umgebung, in der Ihre Integration live ist.
Wählen Sie im Anschluss die Ereignisse aus, die Ihren Webhook auslösen Sie können alle gelisteten Ereignisse auswählen oder manuell einzeln die gewünschten Ereignisse aussuchen. Wählen Sie so viele aus wie nötig.
Es sind 3 Ereignistypen verfügbar :
Ereignisse, die mit der Unterschriftsanfrage verbunden sind
signature_request.activated: Wenn sich der Status einer Signaturanfrage von „Entwurf“ auf „Ausstehend“ ändert.signature_request.done: Wenn alle Unterzeichner:innen das Dokument unterschrieben haben.signature_request.expired: Wenn die Signaturanfrage abgelaufen ist.signature_request.reminder_executed: Wenn eine Signaturerinnerung an den/die Unterzeichner:in gesendet wurde.signature_request.canceledwenn der Absender die Signaturanforderung storniert.
signature_request.declinedwenn der Unterzeichner seine Unterschrift verweigert
signature_request.reactivatedwenn der Absender die Signaturanforderung reaktiviertsignature_request.deletedwenn die Signaturanforderung gelöscht wirdsignature_request.approvedwenn der Genehmigende die Signaturanforderung genehmigt
2. Ereignisse, die mit dem/der Unterzeichner:in verbunden sind
signer.notified: Wenn jetzt ein:e bestimmte:r Unterzeichner:in unterschreiben kann.signer.link_opened: Wenn ein:e bestimmte:r Unterzeichner:in den Signaturanfragelink geöffnet hat.signer.done: Wenn ein:e bestimmte:r Unterzeichner:in das Dokument unterschrieben hat.
3. Ereignisse, die mit Kontakten verbunden sind
contact.created: Wenn ein Kontakt erstellt wurde (außer für Kontakte, die aus einem CSV-Import stammen).
Um die Erstellung des Webhooks abzuschließen, klicken Sie bitte auf „Webhook erstellen“! Im Anschluss können Sie Ihren Webhook im Nachverfolgungs-Interface für Webhooks überwachen oder bearbeiten.
💡Mehr Informationen finden Sie in der Integrationsdokumentation hier :
