Vor dem Start: Bereiten Sie den Empfänger vor
Das Feld mit der Adresse im Panel ist der letzte Schritt, nicht der erste. Zuerst muss der Empfänger vorhanden sein und JSON-Anfragen über HTTPS annehmen. Typischer Empfänger ist ein Workflow im Werkzeug n8n, der Einträge im Kanal des Werks auf einem Messenger veröffentlicht, Mattermost oder Telegram.
Die Ereignisse werden mit einem Zeitlimit von 5 Sekunden gesendet, daher sollte der Empfänger schnell antworten und aufwendigere Verarbeitung erst nach der Antwort ausführen. Ein Empfänger, der nach 8 Sekunden antwortet, gilt als nicht erreichbar.
- Die Adresse des Empfängers ist vom Server der Anwendung des Werks aus erreichbar.
- Ein Kanal im Messenger, in dem die Einträge erscheinen sollen.
- Eine Person, die den Eintrag auf Seiten des Werkschutzes bestätigt.
- Die Zustimmung der IT-Abteilung für den Verkehr zur Adresse des Empfängers.
Schritt 1 und 2: Tragen Sie die Adresse im Panel ein
Der Administrator öffnet im Panel die Einstellungen der Integration und findet das Feld webhook:reception_url. Er trägt darin die vollständige Adresse des Empfängers ein, mit Protokoll und Pfad, und speichert die Einstellung. Ein leeres Feld bedeutet, dass nichts hinausgeht, daher ist das Löschen der Adresse zugleich das Abschalten der Integration.
Die Änderung wirkt für die folgenden Ereignisse. Ereignisse, die vor dem Speichern der Adresse entstanden sind, werden nicht nachträglich gesendet, daher sollte man keine Historie im Kanal erwarten.
Was man eintragen und was man vermeiden sollte
Tragen Sie die Zieladresse ein, nicht eine weiterleitende Adresse. Fügen Sie in die Adresse keine Zugangsdaten im Klartext ein, wenn der Empfänger ein gesondertes Geheimnis unterstützt. Die Festlegungen zur Absicherung des Empfängers beschreiben wir im Material zu bewährten Praktiken.
Sechs Typen von Ereignissen nach Etappe des Besuchs
Schritt 3: Registrieren Sie einen Testgast
Um das erste Ereignis auszulösen, registrieren Sie einen Testgast am Arbeitsplatz oder im Panel. Das Ereignis guest_registered sollte innerhalb weniger Sekunden im Kanal erscheinen. Das Ereignis der Gästeregistrierung enthält bewusst keine Telefonnummer, daher ist ihr Fehlen im Eintrag erwartet.
Der Eintrag sollte den fertigen Text aus dem System und die Uhrzeit des Ereignisses in der Zeitzone Europe/Warsaw im Format ISO 8601 enthalten. Wirkt die Uhrzeit verschoben, prüfen Sie, ob der Empfänger sie nicht erneut in die eigene Zeitzone umrechnet.
Schritt 4 und 5: Prüfen Sie die Gruppenereignisse und die Warnung
Der Webhook veröffentlicht sechs Typen von Ereignissen, daher beweist der Test eines einzigen Typs nicht die Funktion der übrigen. Lösen Sie auch ein Ereignis mit einer Schulungsgruppe aus: Die Gruppe am Registrierungsarbeitsplatz besteht 34 Minuten, und nach Ablauf dieser Zeit oder nach einem Abbruch erhält der Empfänger das Ereignis über einen Misserfolg.
Prüfen Sie das Verhalten der Einträge. Ein Eintrag über eine laufende Gruppe sollte durch einen neuen ersetzt werden, und bei Abbruch oder Nichtbestehen sollte ein roter Eintrag mit Signalton erscheinen. Füllt sich der Kanal mit Wiederholungen, ersetzt der Workflow des Empfängers die Einträge nicht und muss überarbeitet werden.
Prüfen Sie, dass sich die Warnung nicht verdoppelt
Die Warnung über ein Nichtbestehen der Schulung ist durch eine Markierung SET NX in Redis gegen Duplikate geschützt. Sehen Sie trotzdem zwei Einträge, prüfen Sie, ob der Empfänger dieselbe Anfrage in der eigenen Dienstleistung nicht zweimal verarbeitet.
Schritt 6: Prüfen Sie das Verhalten bei einem Ausfall des Empfängers
Die Ereignisse gelangen in eine Warteschlange und werden asynchron gesendet, und ein Fehler des Webhooks unterbricht weder die Registrierung eines Gastes noch den Scan oder den Abschluss einer Schulung. Es lohnt sich, dies bewusst zu prüfen: Schalten Sie den Empfänger kurz ab, registrieren Sie einen Testgast und vergewissern Sie sich, dass der Empfang normal weiterläuft.
Nachdem Sie den Empfänger wieder eingeschaltet haben, registrieren Sie einen weiteren Gast und bestätigen Sie, dass die Einträge zurückkehren. Halten Sie das Ergebnis des Tests im Abnahmeprotokoll fest, damit Sie bei Zweifeln nach einer Änderung der Konfiguration darauf zurückgreifen können.
Typische Probleme und Fehlersuche
Die häufigste Ursache für einen fehlenden Eintrag ist eine Adresse, die der Server der Anwendung im Netz des Werks nicht erreicht. Blockiert das Netz den ausgehenden Verkehr vom Host der Anwendung, sollten Sie den Zustellmodus mit Abholung der Nachrichten durch einen Poller in Betracht ziehen, beschrieben im Material zur Wahl zwischen den Modi direct und outbox.
Die zweite Ursache ist ein Empfänger, der länger als 5 Sekunden antwortet. Die dritte ist ein leeres oder fehlerhaft gespeichertes Feld webhook:reception_url. Beginnen Sie die Fehlersuche mit dem Einfachsten: Öffnen Sie die Einstellung, prüfen Sie die Adresse und lösen Sie ein Testereignis aus.
Checkliste
Videomaterial
Häufig gestellte Fragen
Wo trägt man die Adresse des Empfangs-Webhooks ein?
Im Panel, im Feld webhook:reception_url. Ein leeres Feld bedeutet, dass kein Ereignis hinausgeht.
Werden Ereignisse gesendet, die vor dem Speichern der Adresse entstanden sind?
Nein. Die Änderung wirkt für Ereignisse, die nach dem Speichern entstehen, daher baut sich die Historie im Kanal ab der ersten Registrierung nach der Konfiguration auf.
Was tun, wenn das Netz des Werks den ausgehenden Verkehr blockiert?
Erwägen Sie den Modus outbox, in dem der Poller die Nachrichten über einen eingehenden Kanal abholt. Einzelheiten im Material zur Wahl zwischen den Modi direct und outbox.
Konfigurieren wir den Webhook gemeinsam
In einer Demo zeigen wir den gesamten Ablauf vom leeren Feld bis zum Eintrag im Kanal des Messengers. Vereinbaren Sie ein Gespräch mit dem Team von InnerWeb.
Sprechen wir