Webhooks - Formulareinträge direkt an ein anderes System übermitteln

Nach dem Ausfüllen und Absenden eines Formulars werden die Einträge in die Formdesk-Datenbank übertragen. Mit Formdesk-Webhooks können Formulareinträge gleichzeitig an ein oder mehrere andere Systeme übertragen werden. Zum Beispiel, um einen neuen Kontakt in Ihrem CRM anzulegen oder einen Auftrag in Ihrem Buchhaltungssystem zu erstellen. Darüber hinaus ist es möglich, eine Antwort aus dem System in einem oder mehreren Feldern des Formulars zu übernehmen. Zusammen mit der Formdesk API bieten die Webhooks leistungsstarke umfassende Verbindungsmöglichkeiten.

Dieses Modul ist im Business-Abonnement inklusive. Standard-Abonnenten können das Zusatzmodul für 99,- Euro pro Jahr erwerben. Wenn das Modul Webhooks nicht in Ihrem Abonnement enthalten ist, können Sie es trotzdem ausprobieren. Sie erhalten 25 kostenlose Test-Webhooks, d. h. Sie können 25 Mal eingegebene Daten an ein anderes System senden.

Allgemeine Informationen über Daten an andere Anwendungen übermitteln

Diese Anleitung beschreibt folgende Teile:

	Welche Applikationen?
	Erste Schritte: Webhooks einrichten
	Vordefinierte Webhooks
	Allgemeine Einstellungen
	Daten
	PDF-Anhang
	Versandkriterien
	Webhook erneut ausführen
	Webhooks und Workflow

Welche Applikationen?

Das System, an das die Daten übermittelt werden sollen, muss für die Übermittlung der Daten offen sein. Das heißt, es muss den Empfang und die Verarbeitung der Daten zulassen. Für den Austausch von Daten können verschiedene Methoden verwendet werden. Formdesk unterstützt die folgenden:
- HTTP GET
- HTTP POST
- HTTP PUT
- HTTP DELETE
- HTTP PATCH

Einige Anbieter geben in ihrer Dokumention an, welche der oben genannten Methoden sie unterstützen, oder Sie wenden sich direkt an den Anbieter. Sie können auch uns eine Anfrage senden. Dann überprüfen wir gerne für Sie, ob das betreffende System für Webhooks geeignet ist.

Erste Schritte: Webhooks einrichten

Im Bearbeitungsmodus eines Formulars finden Sie das Webhook-Symbol auf der linken Seite unter dem Reiter Einstellungen. Klicken Sie auf "Neuer Webhook", um einen Webhook zu erstellen.

Vordefinierte Webhooks

Formdesk bietet mehrere vordefinierte Webhooks mit gängigen Systemen, aus denen Sie wählen können. In dieser Übersicht geben wir einen Überblick über die vordefinierten Webhooks und die entsprechenden Anleitungen dazu.

Allgemeine Einstellungen

Wenn Sie einen vordefinierten Webhook auswählen, müssen Sie ihn noch einrichten. Das wird in den Anleitungen näher erklärt.

Erstellen Sie Ihren eigenen Webhook. Die Informationen wie Methode (HTTP GET, POST, PUT, DELETE oder PATCH), URL, Header und Authentifizierung entnehmen Sie der Dokumentation des Systems.

Bei mehreren Webhooks können Sie auch die Reihenfolge festlegen, in der die Webhooks ausgeführt werden.

Daten

Im Abschnitt Daten können Sie festlegen, welche Daten Sie mit dem Webhook senden möchten und wie eine eventuelle Antwort verarbeitet werden soll, falls erforderlich.

Wenn Sie für die Methode HTTP GET oder HTTP POST PUT DELETE PATCH Form Data gewählt haben, können Sie ein sogenanntes Mapping erstellen. Hier legen Sie fest, welcher Wert zu welcher Variable des anderen Systems (Parameter) gehört. Die zu verwendenden Parameter finden Sie in der Dokumentation des Systems. Der "Wert" kann ein fester Wert, ein Verweis auf einen Eintrag (Kennzeichen), ein Systemcode oder eine Kombination davon sein. Ein Beispiel: "Übermittelt am [_fd_Add] von [Name]".

Wenn Sie für die Methode HTTP POST PUT DELETE PATCH Raw payload gewählt haben, wird ein Texteingabefeld angeboten, in dem Sie die Daten so angeben können, wie sie vom anderen System empfangen werden sollen. Beachten Sie die Dokumentation des jeweiligen Systems.

Ein Beispiel:

In manchen Fällen sendet ein System eine Antwort, nachdem es die Daten erhalten hat. Dabei kann es sich zum Beispiel um eine Identifikationsnummer handeln, unter der die Eingabe gespeichert wurde. Sie können angeben, dass diese Antwort in einem Textfeld gespeichert werden soll, das Sie bei Bedarf auch ausblenden können (im Abschnitt "Erweitert" des Textfeldes). Die Antworten können Sie in der Ergebnisübersicht oder in einer (E-Mail-)Nachricht nach dem Ausfüllen des Formulars anzeigen lassen. Werden mehrere Antworten in xml- oder json-Struktur gegeben, können diese Antworten in separaten Formdesk-Feldern gespeichert werden, wenn die Kennzeichen der Fragen im Formular mit den Feldnamen in der Antwort übereinstimmen. Sie wählen dann die Option "in Feldern mit entsprechenden Kennzeichen".

Wenn im Formular die Möglichkeit besteht, eine oder mehrere Dateien hochzuladen und/oder Sie einen PDF-Anhang definiert haben, können diese Dateien ebenfalls mit dem Webhook gesendet werden. In der nachfolgenden Tabelle können Sie nachlesen, ob Sie dafür die Funktion [_fd_file(Kennzeichen)] verwenden müssen oder ob Sie in Ihrer Situation einfach das Kennzeichen angeben können:

	HTTP GET Form data	HTTP POST PUT DELETE PATCH Form data		HTTP POST PUT DELETE PATCH Raw Payload
Dateikodierung		Base64	Binair
Hochgeladene Datei
[Kennzeichen]	Dateiname	Name und Inhalt der Datei	Name und Inhalt der Datei	Dateiname
[_fd_file(Kennzeichen)]	- - -	Inhalt der Datei	- - -	Inhalt der Datei (Base64 encoded string)
PDF-Anhang
[_fd_pdf]	- - -	Name und Inhalt der Datei	Name und Inhalt der Datei	Dateiname
[_fd_file(_fd_pdf)]	- - -	Inhalt der Datei	- - -	Inhalt der Datei (Base64 encoded string)

PDF-Anhang

Wenn Sie die Methode HTTP POST oder HTTP XML wählen, haben Sie die Möglichkeit, eine PDF-Datei mit dem Formdesk PDF-Generator zu erstellen und an das System zu senden. Genau wie bei der Verwendung des PDF-Anhangs in (E-Mail-)Nachrichten können Sie Formulareingaben einfügen oder beim Einrichten des PDF-Dokuments einen Systemcode für das ausgefüllte Formular verwenden.
In diesem Fall müssen Sie im Abschnitt "Daten" angeben, wie das PDF-Dokument im System empfangen werden soll. Bitte beachten Sie dazu die Tabelle im Abschnitt "Daten".

Versandkriterien

In manchen Fällen ist es nicht erwünscht, dass Daten an das andere System übermittelt werden sollen. Wenn Sie z.B. in einem Bestellformular abfragen, ob Ihre Kunden den Newsletter erhalten möchten, das Sie mit einem E-Mail-System verbinden möchten. Der Webhook muss nur dann ausgeführt werden, wenn die Person den Newsletter erhalten möchte.
Ebenso kann es gewünscht sein, dass der Webhook erst dann ausgeführt wird, wenn das ausgefüllte Formular im Rahmen des Workflows genehmigt wurde.
In diesen Situationen verwenden Sie Sendekriterien, um anzugeben, wann der Webhook ausgeführt werden muss.

Webhook erneut ausführen

Wenn der Webhook nicht auf das andere System zugreifen kann, setzt Formdesk den regulären Vorgang fort und der Webhook wird nicht ausgeführt. Sie können die Webhooks jedoch jederzeit manuell in der Ergebnisübersicht ausführen. Die Sendekriterien, die eingerichtet wurden, werden dabei berücksichtigt.

Webhooks und Workflow

Jedes Mal, wenn das Formular gesendet wird, entweder zu Beginn oder im Workflow, führt Formdesk zuerst alle Webhooks aus und sendet dann alle E-Mail-Nachrichten, natürlich unter Berücksichtigung der Versandkriterien. So können Sie einen Webhook erst nach einer Bestätigung innerhalb des Workflows ausführen lassen oder den Workflow von der durch den Webhook erhaltenen Antwort abhängig machen.

Nach dem letzten Workflow-Schritt, wenn der Status von "zu übermittelnder Workflow" in "beendet" wechselt, werden die Webhooks noch einmal ausgeführt. Das heißt, wenn Sie nur eine Workflow-Nachricht haben, wäre die Reihenfolge wie folgt:

Erstmaliges Senden durch den Benutzer
Ausführung des Webhooks
Versenden der Workflow-Nachricht
Ausführung von Webhooks

Sie können den Status des Workflows in die Versandkriterien Ihres Webhooks aufnehmen. Dies kann zum Beispiel praktisch sein, wenn Sie möchten, dass Ihr Webhook nur ausgeführt wird, sobald der Workflow vollständig abgeschlossen ist.

Haben Sie eine Frage oder eine Anmerkung zu diesem Handbuch?:

Anrede

Herr

Frau

Vorname:

Name:

E-Mail: