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
Na této stránce
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
- Otevřete stránku Nastavení a značka v nabídce účtu a přejděte do části Integrace.
- Stiskněte Přidat webhook.
- 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í. - Pokud chcete, vyplňte Název, vyberte Události (zpočátku jsou zaškrtnuté všechny) a stiskněte Přidat webhook.
- 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ándocument.viewed: Otevřeno příjemcem, jednou za každého příjemcedocument.signed: Podepsáno podepisujícím, jednou za každého podepisujícíhodocument.completed: Dokončeno: všichni podepsalidocument.declined: Odmítnutodocument.expired: Vypršelodocument.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í:
- Vezměte nezměněné tělo požadavku přesně tak, jak dorazilo.
- Přečtěte z hlavičky
t(unixový čas v sekundách) av1. - 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. - Požadavek přijměte, jen pokud se výsledek rovná
v1(porovnávejte v konstantním čase) atnení 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í.