Webhooky
Práce s webhooky
Webhooky jsou uživatelsky definované HTTP callbacky, které umožňují, na základě určité události na Vašem dokumentu v Alice, provést definovanou akci. Pokud například chcete propojit Alice s další aplikací, mužete pomocí webhooku zavolat definovanou URL, kde poslouchá jiná aplikace.
Vytvoření webhooku
Webhook nastavíte na stejnojmenné kartě v Nastavení
Nový webhook přidáte tlačítkem
Vyplňte název webhooku a jeho url, která se zavolá při spuštění události. Událost při které se zavolá webhook vyberte ze seznamu.
Dostupné události
| Název | Popis |
|---|---|
| Dokončení extrakce | Po dokončení extrakce dokumentu |
| Uložení | Po uložení dokumentu / odeslání dokumentu ke schválení |
| Schválení dokumentu | Po schválení dokumentu (ručně nebo automaticky) |
| Zamítnutí dokumentu | Po zamítnutí dokumentu (ručně nebo automaticky) |
| Vrácení dokumentu | Po vrácení dokumentu odesilateli (pouze dokumenty zpracované z e-mailu) |
| První validace | Při prvním uložení dokumentu |
| Validace | Stejné jako uložení dokumentu |
| Před exportem | Před ručním nebo automatickým exportem dokumentu |
| Vlastní souborový export | Export dokumentu zpracuje vlastní služba |
Query požadavku
documentId = ID dokumentu, na kterém událost vznikla
eventType = druh události, která na dokumentu vznikla viz tabulka
HTTP požadavek
V požadavku se také posílá query, která obsahuje documentId a eventType
Díky tomu můžete identifikovat příchozí volání webhooku
Příklad
Můžete například zajistit volání konkrétní URL adresy ihned po vytěžení dokumentu. Např. na adresu https://mojewebhooky.cz/cekamnazavolani, kde může zpracovat požadavek další služba a odeslat upozornění, že došlo k vytěžení dokumentu.
