Was ist Webhook?

Ein Webhook in der Webentwicklung ist eine Methode zum Erweitern oder Ändern des Verhaltens einer Webanwendung mit benutzerdefinierten Rückrufen. Diese Rückrufe können von Benutzern und Entwicklern von Drittanbietern gepflegt, geändert und verwaltet werden, die möglicherweise nicht unbedingt mit der ursprünglichen Anwendung verbunden sind.

QuestionPro unterstützt sowohl eingehende als auch ausgehende Webhooks. Webhooks können vor Beginn der Umfrage, während der Umfrage (vor oder nach einer Frage) oder nach Abschluss der Umfrage aufgerufen werden.

Eingehende Webhooks sind eine einfache Möglichkeit, die Daten aus externen Quellen in Ihre Umfrage abzurufen.

Ausgehende Webhooks können verwendet werden, um Umfragedaten an eine externe Quelle zu senden. Sie verwenden normale HTTP-Anforderungen mit einer JSON-Nutzlast.

So erstellen Sie einen Webhook:

• Gehen Sie zu: Survey >> Integrations >> Webhooks

• Klicken Sie auf die Schaltfläche Add New Webhook .
• Geben Sie eine Beschreibung für Ihren Webhook ein
• Wählen Sie den gewünschten Typ (eingehend / ausgehend)
• Wählen Sie aus, wann der Webhook aufgerufen werden soll.
• Klicken Sie auf Änderungen speichern

• API URL: Die Endpunkt-URL für einen API-Aufruf.
• Method: Die HTTP-Methode, mit der der Anruf getätigt wird.
• Request Header: HTTP-Headerfelder, die Komponenten des Headerabschnitts der Anforderung sind
• Request JSON: Von der API benötigte Nutzdaten. Sie können auch die Schaltfläche Antwort einfügen verwenden, um die Antwort in den Anforderungs-JSON einzufügen.

Sie können die aus der externen Ressource abgerufenen Daten speichern, indem Sie sie benutzerdefinierten Variablen zuordnen. Klicken Add Custom Mapping zum Öffnen des Zuordnungsdialogs auf die Schaltfläche Add Custom Mapping hinzufügen):

Sie können die Daten benutzerdefinierten Variablen zuordnen, indem Sie bestimmten benutzerdefinierten Variablen einzelne JSON-Schlüssel zuweisen. Sie können den benutzerdefinierten Variablen auch einen relevanten Namen zuweisen:

Sobald die Zuordnung festgelegt ist, können die gesammelten Daten in der Umfrage mit dem folgenden Code angezeigt werden: $ {DisplayName}

Bei ausgehenden Webhooks können Sie die in benutzerdefinierten Variablen erfassten Daten an einen externen Webdienst senden, indem Sie die benutzerdefinierten Variablen zum Request-JSON hinzufügen:

Um die Daten für benutzerdefinierte Variablen abzurufen, können Sie die folgenden Tags für die entsprechenden benutzerdefinierten Variablen in der Anforderungs-JSON verwenden:

Benutzerdefinierte Variable 1: $ {custom1}

Benutzerdefinierte Variable 2: $ {custom2}

Benutzerdefinierte Variable 3: $ {custom3}

Benutzerdefinierte Variable 4: $ {custom4}

Benutzerdefinierte Variable 5: $ {custom5}

Benutzerdefinierte Variable N: $ {customN}

Um Daten für Umfragefragen abzurufen, können Sie den entsprechenden Fragencode verwenden. Wenn Sie beispielsweise Daten für eine Frage mit Code Q1 abrufen möchten, können Sie $ {Q1} verwenden.

QuestionPro bietet Protokollierungsfunktionen für jeden Webhook, mit denen Sie die von diesem Webhook aufgerufenen API-Details sowie die Nutzdaten und die Antwort vom Endpunkt überprüfen können. Um auf die Protokolle zuzugreifen, gehen Sie zu einem bestimmten Webhook und scrollen Sie zum Ende der Seite, wo Sie die von diesem Webhook gestellten Anforderungen anzeigen können. Wenn Sie auf die ID klicken, können Sie die Details eines bestimmten Anrufs überprüfen.

Wenn bei einigen ausgehenden Anrufen die Daten nicht übertragen werden konnten, ist vor den API-Aufrufen eine Schaltfläche Manuelle Wiederholung verfügbar, auf die Sie jederzeit klicken können, um die Daten zurück zum API-Endpunkt zu übertragen.