Přeskočit na hlavní obsah

Vytvoření a nastavení webhooků v aplikaci (Selfcare)

Tento článek vás provede nastavením webhooků přímo v uživatelském rozhraní DigiSign.

Jako administrátor pracovního prostoru můžete webhooky vytvářet, upravovat a monitorovat i jednoduše přímo z prostředí aplikace DigiSign.

Kde najdu nastavení webhooků?

V aplikaci přejděte do sekce Nastavení> Pro vývojáře> Webhooky. Zde uvidíte přehled všech vytvořených webhooků, jejich cílové URL adresy a aktuální stav.

U webhooků, které se dlouhodobě nedaří doručovat navíc zobrazujeme chybový indikátor "Problém s doručováním" - Pro tyto webhooky doporučujeme prověřit jejich nastavení a odpovědi vašeho serveru, jinak hrozí automatická deaktivace těchto webhooků.

Funkcionalita webhooku spadá pod placený modul API. Pokud jej nemáte dostupný ve vašem tarifu, můžete nás kontaktovat pro samostatné objednání na podpora@digisign.cz.

Vytvoření nového webhooku

Pro přidání nového propojení klikněte v pravém horním rohu na tlačítko Nový webhook. Otevře se dialogové okno s následujícím:

  • Výběr událostí: V nabídce rozklikněte jednotlivé sekce a zaškrtnutím vyberte ty události, na které má tento konkrétní webhook upozorňovat (např. pod sekcí Obálka události - Obálka odeslána, Obálka dokončena, pod sekcí Příjemce údalost - Příjemce podepsal atd.). Vždy musí být vybrána minimálně jedna událost.

  • URL: Zadejte cílovou adresu vašeho serveru nebo endpointu, kam má být zasláno oznámení.

  • Zabezpečit pomocí OAuth 2.0: Pokud váš systém vyžaduje autorizaci, přepněte přepínač do polohy zapnuto. Následně se zobrazí formulář pro zadání Token Endpointu, Client ID, Client Secret (tyto jsou povinné) a případně Scopes či Instrospect Ednpoint (nepovinné).

Detail a monitoring webhooku

Kliknutím na konkrétní webhook v seznamu se dostanete do jeho detailu, kde můžete sledovat historii všech proběhlých pokusů o doručení.

  • Historie pokusů: V levé části uvidíte seznam volání s HTTP kódy a možností filtrovat dle úspěšných či neúspěšných pokusů.

  • Detail pokusu: Po kliknutí na konkrétní pokus se v pravé části zobrazí přesná data, která DigiSign odeslal (Request), a odpověď, kterou vrátil váš server (Response) včetně případných chybových hlášení.

  • Ruční opakování: Pokud volání selhalo, můžete v detailu pokusu využít tlačítko Opakovat, kterým vynutíte nový pokus o provolání dané události.

💡 TIP: Pokud vás zajímá výsledek pro konkrétní entitu (např. obálku), tak zadejte její ID do vyhledávacího pole nad výpis pokusů. Tím se vám zobrazí pouze pokusy spojené s danou obálkou.

Správa existujících webhooků

U každého záznamu ve výpisu webhooků najdete vpravo ikonu tří teček (menu), která umožňuje:

  • Deaktivovat/Obnovit: Ručně ovlivnit, zda je webhook v provozu.

  • Smazat: Úplně odstranit webhook ze seznamu. Smazaný webhook již nelze obnovit.

V detailu webhooku je pak navíc možné:

  • Upravit: Změnit nastavení nebo cílovou URL.

  • Zobrazit Secret: Pro technické ověření integrity dat na straně vašeho serveru.

💡 TIP: Pokud se vám v historii zobrazují chyby (např. 404), zkontrolujte v logu Response zprávu od vašeho serveru. Často jde o chybně nastavený endpoint nebo neplatný autorizační token.

Dostali jste odpověď na svou otázku?