Webhooky

Hlavní nabídka Nastavení Webhooky

Práce s webhooky

Webhooky jsou uživatelsky definované HTTP callbacky, které umožňují provést na základě určité události na Vašem dokumentu v Alice 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

• dokončení extrakce: dokončení vytěžení dokumentu
• uložení: uložení dokumentu / odeslání dokumentu ke schválení
• schválení dokumentu: schválení dokumentu (ručně i automaticky)
• zamítnutí dokumentu: zamítnutí dokumentu (ručně i automaticky)
• vrácení dokumentu: po vrácení dokumentu odesílateli (platí pouze pro dokumenty zpracované z emailu)
• první validace: první uložení dokumentu
• validace: stejná situace jako při uložení dokumentu
• před exportem: před ručním nebo automatizovaný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 posílají také parametry (query), která obsahují documentId a eventType

Díky nim můžete identifikovat příchozí volání webhooku.

Pokud je vybrána klientská aplikace, odešle se v požadavku také ID klientské aplikace a token.

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.