Ausgehende Webhooks

Über ausgehende Webhooks

Im Allgemeinen ist ein Webhook eine Methode, mit der Anwendungen automatisch miteinander kommunizieren. Mit anderen Worten, eine Nachricht wird über das Web gesendet, die automatisch ausgelöst wird, wenn ein bestimmtes Ereignis eintritt. Die Automatisierung des ausgehenden Webhooks wird ausgelöst, wenn ein Teilnehmer Ihre Umfrage abschließt und seine Antwort an ein externes System Ihrer Wahl gesendet wird.

Jedes Mal, wenn die Automatisierung des ausgehenden Webhooks ausgelöst wird, wird ein neuer Automatisierungsdurchlauf erstellt. Diese Durchläufe repräsentieren die Instanzen, in denen Ihr ausgehender Webhook eine Umfrageantwort an das angegebene externe System sendet. Mit Enalyzer können Sie Ihre Automatisierungsdurchläufe leicht einsehen und verwalten.

Webhooks sind für Benutzer gedacht, die wissen, wie man sie handhabt. Bitte beachten Sie, dass wir Ihren Code nicht überprüfen oder schrittweise Entwicklungshinweise geben können.

Erstellung einer ausgehenden Webhook-Automatisierung

Um eine ausgehende Webhook-Automatisierung einzurichten, müssen Sie:

  1. Gehen Sie zum Bereich für Automatisierungen () und klicken Sie im Seitenmenü auf Enalyzer.
  2. Klicken Sie im Seitenmenü auf Enalyzer.
  3. Klicken Sie auf Automatisierung erstellen. Wenn Sie bereits eine oder mehrere Automatisierungen haben, klicken Sie auf das Symbol Automatisierung hinzufügen (), um eine Automatisierung hinzuzufügen.
  4. Wählen Sie die Option Webhooks und klicken Sie auf ausgehender Webhook.
  5. Wählen Sie aus, welche Variablen Sie in Ihrer Übertragung einschließen möchten. Sie können wählen, ob Sie alle Variablen oder spezifische Variablen in Ihrer Datentransfer einbeziehen möchten.
    1. Diese Option wird alle Ihre Umfragefragen und Hintergrundvariablen in die Datenübertragung einbeziehen.
      1. Verwenden Sie das Dropdown-Menü, um die Option alle Variablen einschließen zu wählen
      2. Klicken Sie auf weiter.
    2. Diese Option ermöglicht es Ihnen, bestimmte Umfragefragen und Hintergrundvariablen auszusuchen, die in Ihre Datenübertragung einbezogen werden sollen.
      1. Verwenden Sie das Dropdown-Menü, um die Option spezifische Variablen einschließen zu wählen und klicken Sie auf weiter.
      2. Wählen Sie die Fragen und Hintergrundvariablen aus, die Sie in Ihre Datenübertragung einbeziehen möchten und klicken Sie auf hinzufügen.
  6. Wählen Sie die Variablenbezeichnungen, die der Webhook verwenden soll. Sie können zwischen folgenden wählen:
    • Automatisch generierte Bezeichnungen: diese werden von Enalyzer generiert und sind die gleichen Bezeichnungen wie die automatisch generierten Bezeichnungen in den Antwortdaten-Downloads.
    • Datenbezeichnungen: Sie können Datenbezeichnungen verwenden, die Sie selbst unter Ihren Umfrageeinstellungen anpassen können. 
  7. Fügen Sie die URL hinzu, an die die Webhook-Automatisierung die Daten senden wird.
  8. Klicken Sie auf die Schaltfläche Verbindung testen. Sobald Ihre Verbindung erfolgreich ist, klicken Sie auf weiter.
  9. Benennen Sie Ihre Automatisierung und klicken Sie auf weiter.
  10. Legen Sie den Status der Automatisierung fest. Standardmäßig ist sie aktiviert, jedoch können Sie sie vor der Erstellung deaktivieren.
  11. Wenn Sie bereit sind, Ihre Automatisierung zu erstellen, klicken Sie auf erledigt.

Datenbeschriftungen anpassen

Wenn Sie eine Hintergrundvariable oder Frage erstellen, generiert Enalyzer automatisch eine Beschriftung, die Sie in den Daten-Downloads der Antworten finden können. Datenbeschriftungen ermöglichen es Ihnen, Beschriftungen für Ihre Umfrage-Hintergrundvariablen und Fragen für ausgehende Webhooks zu individualisieren, um die Ausgabe von API-Anrufen zu steuern.

Ihre Datenbeschriftungen werden unter Ihren Umfrageeinstellungen definiert, dafür müssen Sie lediglich:

  1. Zum Umfragebereich gehen (SurveyAreaIcon.png) und Ihre Umfrage öffnen.
  2. Im Seitenmenü auf Einstellungen klicken.
  3. Unter Dateneinstellungen auf Datenbeschriftungen klicken.
  4. Sie sehen eine Übersicht aller Umfragevariablen (Hintergrundvariablen und Frageelemente) auf der linken Seite. Auf der rechten Seite sehen Sie Ihre Datenbeschriftungen. Standardmäßig werden die Datenbeschriftungen automatisch generiert, basierend auf den entsprechenden Hintergrundvariablen/Umfrageelementen, jedoch können Sie Ihre eigenen Werte definieren.

Datenbeschriftungen müssen eindeutig sein, dürfen keine Sonderzeichen enthalten und sind auf 100 Zeichen begrenzt.

Datenbeschriftungen können nur für Hintergrundvariablen und Fragen definiert werden, aber nicht für Antwortoptionen.

Datenbeschriftungen werden beim Kopieren von Fragen nicht kopiert, jedoch werden sie beim Kopieren von Umfragen oder wenn die Umfrage als Vorlage geteilt wird, kopiert.

Details der Automatisierungsläufe ansehen

Jedes Mal, wenn die Automatisierung des ausgehenden Webhooks ausgeführt wird, erstellt sie einen neuen Lauf. Automatisierungsläufe sind die Instanzen, wenn Ihr ausgehender Webhook eine Umfrageantwort an das festgelegte externe System überträgt. Sobald die Automatisierung des ausgehenden Webhooks zu laufen beginnt, können Sie die Automatisierungsläufe, die sie erstellt, einsehen. Jeder Automatisierungslauf kann einen anderen Status haben. Die möglichen Status sind:

  • Geplant: Die Automatisierung des ausgehenden Webhooks wurde für einen späteren Zeitpunkt geplant, ist jedoch noch nicht ausgeführt worden.
  • Fehlgeschlagen: Die Automatisierung des ausgehenden Webhooks ist auf einen Fehler gestoßen und konnte nicht ausgeführt werden.
  • Wird ausgeführt: Die Automatisierung des ausgehenden Webhooks wird aktuell ausgeführt.
  • Erfolgreich: Die Automatisierung des ausgehenden Webhooks wurde erfolgreich abgeschlossen und die Umfrageantwort wurde an das externe System gesendet.

Um Details über einen Automatisierungslauf einzusehen, müssen Sie lediglich:

  1. Zum Bereich Automatisierungen gehen () und im Seitenmenü auf Enalyzer klicken.
  2. Im Seitenmenü auf Enalyzer klicken.
  3. Auf die Automatisierung klicken.
  4. Unter Log auf Automatisierungsläufe klicken.
  5. Um die Details eines Automatisierungslaufs einzusehen, einfach auf den Lauf klicken.
  6. Die Details eines Automatisierungslaufs beinhalten:
    • Vorname und Nachname: Der Lauf zeigt den Vornamen und den Nachnamen des Befragten an, sofern verfügbar.
    • Status: Der Laufstatus sowie das Datum und die Uhrzeit, wann der Status erreicht wurde.
    • Erstellungszeit: Das Datum und die Uhrzeit der Erstellung des Laufs.
    • Push-URL: Die URL, an die die Umfrageantwort gesendet wurde.
    • Ausgehende Nachricht: Die Daten, die an das externe System gesendet wurden.

Läufe aus anonymen Umfragen werden die Vornamen, Nachnamen oder E-Mails der Befragten nicht anzeigen. Stattdessen wird der Lauf als "Anonym" benannt.

Filterung von Automatisierungsdurchläufen

Sie können Ihre Automatisierungsdurchläufe nach Status, Zeitraum oder Name filtern. Dies wird Ihnen helfen, Ihre Durchläufe zu sortieren und leichter zu verwalten. Sie können zum Beispiel alle fehlgeschlagenen Durchläufe finden und sehen, was passiert ist oder sie erneut abspielen.

Um Ihre Automatisierungsdurchläufe zu filtern, müssen Sie:

  1. Gehen Sie zum Bereich Automatisierungen () und klicken Sie im Seitenmenü auf Enalyzer.
  2. Im Seitenmenü klicken Sie auf Enalyzer.
  3. Klicken Sie auf die Automatisierung.
  4. Unter Log klicken Sie auf Automatisierungsdurchläufe.
  5. Klicken Sie auf den Filter Knopf.
  6. Sie haben folgende Optionen, um Durchläufe zu filtern, und Sie können so viele Filter wie nötig hinzufügen, um sie eingehend zu durchsuchen:
    • Nach Name oder E-Mail-Adresse suchen: Geben Sie eine E-Mail-Adresse oder einen Namen in das Suchfeld ein. Dies bezieht sich auf den Wert der Umfrageantwort.
    • Status: Filtern nach dem Status des Durchlaufs.
    • Zeitraum: Filtern nach dem Zeitraum basierend auf dem Erstellungsdatum des Durchlaufs.

      Automatisierungsdurchläufe werden nur für 14 Tage gespeichert, daher ist der Zeitraumfilter auf die vergangenen 14 Tage beschränkt.

  7. Wenn Sie mit dem Hinzufügen aller Filter fertig sind, klicken Sie auf den anwenden Knopf, um die Liste der Automatisierungsdurchläufe zu filtern und das Bearbeiten-Filter-Durchläufe-Seitenmenü zu schließen.

Automatisierungsläufe wiederholen

Es gibt mehrere Gründe, warum Sie einen Durchlauf wiederholen möchten. Der häufigste Grund ist, dass er fehlgeschlagen ist, jedoch möchten Sie vielleicht die Daten erneut senden oder einen Lauf wiederholen, der für einen späteren Zeitpunkt geplant war. Um Ihre Durchläufe zu wiederholen, müssen Sie folgendes tun:

  1. Gehen Sie zum Bereich Automatisierungen () und klicken Sie im Seitenmenü auf Enalyzer.
  2. Klicken Sie im Seitenmenü auf Enalyzer.
  3. Klicken Sie auf die Automatisierung.
  4. Unter Log klicken Sie auf Automatisierungsläufe.
  5. Klicken Sie auf das Aktionsmenü und wählen Sie wiederholen.
  6. Wählen Sie den/die Durchlauf/Durchläufe, den/die Sie wiederholen möchten und klicken Sie auf den wiederholen Knopf.

Fehlerbenachrichtigungen erhalten

Ausgehende Webhooks können aus verschiedenen Gründen fehlschlagen und dazu führen, dass Ihre Automatisierung deaktiviert wird. Unabhängig vom Grund können Sie E-Mail-Benachrichtigungen bei Fehlern für Ihre Automatisierung aktivieren. Sie können die Person(en) festlegen, die diese Benachrichtigungen erhalten sollen.

Um Fehlerbenachrichtigungen zu aktivieren, müssen Sie:

  1. Zum Bereich Automatisierungen gehen (AutomationsIcon.png) und im Seitenmenü auf Enalyzer klicken.
  2. Auf die Automatisierung klicken, für die Sie Fehlerbenachrichtigungen aktivieren möchten.
  3. Unter Fehlerbenachrichtigungen die Einstellung für E-Mail-Benachrichtigungen aktivieren.
  4. Auf Empfänger hinzufügen klicken und die E-Mail-Adresse eingeben, die die Benachrichtigungs-E-Mails bei Fehlern erhalten soll. Wiederholen Sie diesen Schritt, um weitere Empfänger hinzuzufügen.
  5. Ihre Änderungen werden sofort gespeichert. 

War dieser Beitrag hilfreich?

0 von 0 fanden dies hilfreich