Webhooky: události dokumentů do vašeho systému

Webhook pošle podepsanou zprávu JSON na vaši URL, když je dokument odeslán, otevřen, podepsán, dokončen, odmítnut, vyprší nebo je zrušen. Vyžaduje Pro; nastavují ho vlastníci a správci.

Tento překlad je starší než anglický článek, takže se některé podrobnosti mohly změnit. Přečíst anglickou verzi

Webhook pošle zprávu na vaši URL pokaždé, když se s dokumentem něco stane, aby na to mohl reagovat váš vlastní systém. Webhooky jsou součástí Pro: fungují v pracovním prostoru, dokud některý z jeho vlastníků má Pro, a spravovat je mohou jen vlastníci a správci. Každý pracovní prostor má vlastní.

Přidání webhooku

  1. Otevřete stránku Nastavení a značka v nabídce účtu a přejděte do části Integrace.
  2. Stiskněte Přidat webhook.
  3. Zadejte URL endpointu. Musí začínat na https:// a být veřejná: adresy v soukromých sítích, vlastní adresy Sealsimple a URL s uživatelským jménem a heslem se odmítají.
  4. Pokud chcete, vyplňte Název, vyberte Události (zpočátku jsou zaškrtnuté všechny) a stiskněte Přidat webhook.
  5. Zkopírujte zobrazený Podpisový klíč a stiskněte Odeslat testovací událost.

Pracovní prostor může mít až 10 webhooků.

Události

  • document.sent: Dokument odeslán
  • document.viewed: Otevřeno příjemcem, jednou za každého příjemce
  • document.signed: Podepsáno podepisujícím, jednou za každého podepisujícího
  • document.completed: Dokončeno: všichni podepsali
  • document.declined: Odmítnuto
  • document.expired: Vypršelo
  • document.canceled: Zrušeno

Co posíláme

Požadavek POST s tělem JSON: id (stejné při každém pokusu, takže můžete přeskočit duplicity), event, created_at, workspace_id, document s id, title, status a url a u událostí týkajících se jedné osoby recipient s name, email a role. Zrušený dokument má stav voided. Samotné podepsané PDF se neposílá. Testovací událost má událost test a smyšlený dokument a podepisujícího.

Ověření podpisu

Každý požadavek má hlavičku Sealsimple-Signature ve tvaru t=1700000000,v1=…, vedle hlaviček Sealsimple-Event a Sealsimple-Delivery. Postup ověření:

  1. Vezměte nezměněné tělo požadavku přesně tak, jak dorazilo.
  2. Přečtěte z hlavičky t (unixový čas v sekundách) a v1.
  3. Spočítejte HMAC-SHA256 z t, tečky a těla, s celým podpisovým klíčem jako klíčem, v hexadecimálním zápisu malými písmeny.
  4. Požadavek přijměte, jen pokud se výsledek rovná v1 (porovnávejte v konstantním čase) a t není starší než několik minut.

V části Jak propojit ukazuje Ověření podpisu (Node.js) tento postup jako kód, s tlačítkem Kopírovat kód. Nový klíč klíč okamžitě nahradí, takže hned potom aktualizujte své ověřování.

Opakované pokusy, protokol a pozastavení

Odpovězte stavem 2xx do 10 sekund. Jinak to zkusíme později znovu, celkem až 6krát v průběhu zhruba jednoho dne. Přesměrování nesledujeme a odpověď 410 další pokusy zastaví. Protokol doručení ukazuje posledních 50 zpráv s odpovědí vašeho endpointu a Odeslat znovu kteroukoli z nich pošle znovu.

Po 20 neúspěšných doručeních za sebou webhook pozastavíme (Pozastaveno po chybách) a pošleme e-mail vlastníkům pracovního prostoru. Opravte endpoint, webhook znovu zapněte a z protokolu znovu odešlete, co potřebujete. Webhook můžete pozastavit i jeho přepínačem: události, ke kterým dojde během pozastavení, se později neodešlou. Bez Pro webhooky zůstanou, ale nic neposílají.

Byl pro vás tento článek užitečný?

Vyzkoušejte to na další smlouvě.

5 dokumentů k odeslání zdarma každý kalendářní měsíc. Bez platební karty.

Potřebujete ještě pomoc?

Zeptejte se našeho asistenta v chatu: odpoví hned. Nebo nám napište e-mail a do jednoho pracovního dne vám odpoví člověk.