Webhooky

Přihlašovací údaje API slouží k tomu, aby se váš systém mohl Knowspreadu ptát. Webhooky jsou opačný směr: prostor sám oznámí, že se něco stalo, aniž by se ho někdo ptal.

K čemu se webhooky hodí

Bez webhooku se váš systém musí ptát dokola: každých pár minut zavolat API a zjistit, jestli se něco nezměnilo. Je to jako chodit každou chvíli ke dveřím kontrolovat, zda někdo nepřišel. Webhook je zvonek. Prostor zavolá vás, a to jen tehdy, když se opravdu něco stalo.

Čtyři nabízené události stačí na běžné situace, které firmy jinak řeší ručně:

• Školení se objeví tam, kde lidé pracují. Zaměstnanci přibude povinný kurz. Přijde content_assignment_created a váš intranet nebo kalendář mu založí úkol s termínem. Nikdo nemusí Knowspread otevírat, aby se dozvěděl, co má udělat.
• HR si odškrtne požadavek samo. Nový kolega dokončí školení BOZP. Přijde content_assignment_completed a personální systém označí požadavek za splněný. Odpadá páteční export tabulky a její ruční přepisování.
• Vedoucí se o zmeškaném termínu dozví ještě ten den. Někdo nestihne přiřazený obsah. Přijde content_assignment_overdue a váš systém pošle jeho vedoucímu zprávu do Teams nebo Slacku. Bez webhooku by to někdo hledal v přehledu plnění, až by si vzpomněl.
• Výsledek testu se zapíše do evidence. Někdo dokončí test. Přijde test_attempt_completed a evidence kvalifikací nebo auditní stopa dostane záznam ve chvíli, kdy vznikl, ne při příští revizi.

Webhook říká, že se něco stalo. Když váš systém potřebuje podrobnosti, zeptá se na ně přes API pomocí přihlašovacích údajů. Obě cesty se doplňují: událost je spouštěč, API je zdroj detailů.

Obrazovka

123

Nastavení webhooku s otevřeným katalogem událostí

• (1) Všechno přijímá jediný endpoint. Zadáte jeho URL a secret — Vygenerovat secret ho vyrobí za vás.
• (2) Auth type je oddělený od secretu a ve výchozím stavu je none. Údaje pro basic auth se objeví, až ho zvolíte.
• (3) Odběry se přidávají po jedné události, každá s verzí schématu. Ve výchozím stavu není odebíráno nic.

Nabízené události

Výběr nabízí čtyři události a všechny se týkají přiřazení a testů, ne změn lidí nebo obsahu.

Událost	Nastane, když
content_assignment_created	je někomu přiřazen obsah
content_assignment_completed	někdo přiřazený obsah dokončí
content_assignment_overdue	přiřazení překročí termín
test_attempt_completed	někdo dokončí pokus o test

Každý odběr nese verzi schématu — výběr nabízí v1.0 — takže tvar zprávy je verzovaný odděleně od názvu události.

Secret je podpis, ne heslo

Basic auth je oddělený a nepovinný — prokazuje volání na úrovni spojení, kdežto secret prokazuje obsah zprávy.

Na co si dát pozor

V osobním prostoru se formulář sice vykreslí, ale nic za ním nežije: webhooks, webhook_settings i webhooks/pending_requests odpovídají 403. Sekce odběrů zůstává prázdná proto, že byla odmítnuta, ne proto, že se nic neodebírá.