Než začnete: připravte příjemce
Pole s adresou v panelu je posledním krokem, nikoli prvním. Nejprve musí příjemce existovat a přijímat žádosti ve formátu JSON přes HTTPS. Typickým příjemcem je workflow v nástroji n8n, které zveřejňuje záznamy v kanálu závodu na komunikátoru Mattermost nebo Telegram.
Události odcházejí s časovým limitem 5 sekund, takže příjemce má odpovídat rychle a náročnější zpracování provádět až po odeslání odpovědi. Příjemce, který odpoví po 8 sekundách, bude považován za nedostupný.
- Adresa příjemce dostupná z aplikačního serveru závodu.
- Kanál v komunikátoru, kam mají záznamy přicházet.
- Osoba, která záznam na straně bezpečnosti potvrdí.
- Souhlas oddělení IT s provozem na adresu příjemce.
Krok 1 a 2: zapište adresu v panelu
Správce otevře nastavení integrací v panelu a najde pole webhook:reception_url. Zapíše do něj úplnou adresu příjemce s protokolem a cestou a nastavení uloží. Prázdné pole znamená, že nic neodchází, takže vymazání adresy je zároveň vypnutím integrace.
Změna platí pro další události. Události, které vznikly před uložením adresy, se neodesílají zpětně, takže v kanálu nelze očekávat historii.
Co zapsat a čemu se vyhnout
Zapište cílovou adresu, nikoli adresu přesměrování. Do adresy nevkládejte přihlašovací údaje v čitelné podobě, pokud příjemce podporuje samostatný tajný klíč. Pravidla pro zabezpečení přijímače popisujeme v materiálu o osvědčených postupech.
Šest typů událostí podle fáze návštěvy
Krok 3: zaregistrujte zkušebního hosta
Pro vyvolání první události zaregistrujte zkušebního hosta na stanovišti nebo v panelu. Událost guest_registered by se měla v kanálu objevit během několika sekund. Událost registrace hosta záměrně nenese telefonní číslo, takže jeho absence v záznamu je očekávaná.
Záznam by měl obsahovat hotový text ze systému a čas události v pásmu Europe/Warsaw ve formátu ISO 8601. Pokud se čas jeví jako posunutý, zkontrolujte, zda jej příjemce znovu nepřepočítává do vlastního pásma.
Krok 4 a 5: ověřte události skupiny a upozornění
Webhook zveřejňuje šest typů událostí, takže test jednoho typu neprokazuje funkčnost ostatních. Vyvolejte také událost se skupinou školení: skupina na stanovišti registrace žije 34 minut a po uplynutí této doby nebo po přerušení příjemce obdrží událost o neúspěchu.
Zkontrolujte chování záznamů. Záznam o skupině v průběhu by měl být nahrazen novým a při přerušení nebo neúspěchu se má objevit červený záznam se zvukem. Pokud se kanál plní opakováními, workflow příjemce záznamy nenahrazuje a je třeba jej opravit.
Ověřte, že se upozornění nezdvojuje
Upozornění o neabsolvování školení chrání před duplicitami značka SET NX v Redisu. Pokud přesto vidíte dva záznamy, zkontrolujte, zda příjemce nezpracovává stejný požadavek dvakrát na své vlastní straně.
Krok 6: ověřte chování při výpadku příjemce
Události se řadí do fronty a odesílají asynchronně, a chyba webhooku nepřeruší registraci hosta, sken ani absolvování školení. Vyplatí se to ověřit záměrně: na chvíli příjemce vypněte, zaregistrujte zkušebního hosta a ujistěte se, že recepce funguje normálně.
Po obnovení příjemce zaregistrujte dalšího hosta a potvrďte, že se záznamy vracejí. Výsledek testu si zapište do protokolu převzetí, abyste se k němu mohli v případě pochybností po změně konfigurace vrátit.
Časté problémy a diagnostika
Nejčastější příčinou chybějícího záznamu je adresa, ke které aplikační server nemá přístup v síti závodu. Pokud síť blokuje odchozí provoz z hostitele aplikace, zvažte režim doručování s příjmem zpráv přes poller, popsaný v materiálu o volbě režimu direct nebo outbox.
Druhou příčinou je příjemce, který odpovídá déle než 5 sekund. Třetí je prázdné nebo chybně uložené pole webhook:reception_url. Diagnostiku začněte nejjednodušší kontrolou: otevřete nastavení, zkontrolujte adresu a vyvolejte zkušební událost.
Kontrolní seznam
Videomateriál
Často kladené otázky
Kde se zapisuje adresa webhooku recepce?
V panelu, do pole webhook:reception_url. Prázdné pole znamená, že žádná událost neodchází.
Odešlou se události, které vznikly před zapsáním adresy?
Ne. Změna platí pro události vzniklé po uložení, takže historii v kanálu začíná budovat první registrace po nastavení.
Co dělat, když síť závodu blokuje odchozí provoz?
Zvažte režim outbox, v němž poller odebírá zprávy přes příchozí kanál. Podrobnosti jsou v materiálu o volbě režimu direct nebo outbox.
Nastavme webhook společně
Na demu projdeme celý postup od prázdného pole po záznam v kanálu komunikátoru. Domluvte si konzultaci s týmem InnerWeb.
Pojďme si promluvit