Themenbereich: Account

Webhook einrichten


Um das Auslesen der Ergebnisse per API einfach zu gestalten, können Sie in Ihrem easyfeedback Account Webhooks einrichten.


Wie funktionieren Webhooks?

Webhooks sind kleine Benachrichtigungen, die an einen anderen Server gesendet werden, um diesen mitzuteilen, dass neue Daten/Informationen vorhanden sind.
Durch den Einsatz von Webhooks muss eine API-Schnittstelle nicht permanent prüfen, ob neue Ergebnisse vorhanden sind, sondern wird erst aktiviert, wenn der Webhook eine Benachrichtigung sendet.

Der easyfeedback Webhook wird immer dann aktiv, sobald eine neue abgeschlossene Teilnahme innerhalb einer Ihrer Umfragen vorhanden ist. Auf diese Weise weiß die Gegenstelle, dass sie jetzt per API neue Daten vom easyfeedback Server lesen kann.



So richten Sie einen Webhook ein:
 
  1. Gehen Sie über den Menüpunkt Account in Ihre Accountdaten und öffnen dort den Bereich Integrationen
  2. Im zweiten Bereich finden Sie die Webhooks
  3. Klicken Sie auf Neuen Webhook anlegen
  4. In dem sich nun öffnenden Dialog können Sie die Einstellungen für den Webhook vornehmen:

    Bezeichnung: Unter Bezeichnung vergeben Sie eine eigene Bezeichnung, um sich diesen Webhook thematisch merken zu können.
    Umfrage: Hier wählen Sie die betreffende Umfrage aus, wo der Webhook aktiv werden soll wenn neue Ergebnisse vorhanden sind.
    Endpunkt: Unter „Endpunkt“ tragen Sie eine URL ein an die der Webhook die Information senden soll. Die Gegenstelle muss dafür kompatibel sein und den Webhook lesen und akzeptieren können.
    Methode: Zum Senden des Webhooks haben Sie zwei Möglichkeiten „Get“ und „Post“.
    Bei der Methode „Get“ werden die Informationen (SurveyID und MemberID) in der URL übertragen. Bei der Methode „Post“ werden die Informationen nicht lesbar in der Post-Nachricht selbst übertragen.
     
  5. Sobald Sie mit den Einstellungen fertig sind, klicken Sie auf Speichern
  6. Um den Webhook zu aktivieren oder auch zu deaktivieren, schieben Sie den on/off Schalter nach links oder rechts.


Webhook testen

Um die Einstellungen des Webhooks zu testen, klicken Sie einfach auf den Button Webhook testen. Sobald Sie auf den Button klicken wird der Webhook ausgelöst und sendet Test-Daten an die Gegenstelle.

Für einen Live-Test bietet Ihnen webhook.site die Möglichkeit an Webhooks zu empfangen und zu überprüfen, ob die Einstellungen funktionieren.

Und über das Protokoll können Sie die einzelnen Sendungen nachverfolgen und ggf. noch einmal auslösen.