Webhooky: udalosti dokumentov do vášho systému
Webhook pošle na vašu URL podpísaný JSON pri odoslaní, otvorení, podpise, dokončení, odmietnutí, vypršaní alebo zrušení dokumentu. Vyžaduje Pro; nastavujú ho vlastníci a správcovia.
Tento preklad je starší ako anglický článok, takže niektoré podrobnosti sa mohli zmeniť. Prečítať anglickú verziu
Na tejto stránke
Webhook pošle správu na vašu URL zakaždým, keď sa s dokumentom niečo stane, aby na to mohol reagovať váš vlastný systém. Webhooky sú súčasťou plánu Pro: v pracovnom priestore fungujú, kým niektorý z jeho vlastníkov má Pro, a spravovať ich môžu len vlastníci a správcovia. Každý pracovný priestor má vlastné.
Pridanie webhooku
- V ponuke účtu otvorte Nastavenia a vzhľad značky a prejdite do časti Integrácie.
- Stlačte Pridať webhook.
- Zadajte URL endpointu. Musí začínať na
https://a byť verejná: adresy v súkromných sieťach, vlastné adresy Sealsimple a URL s používateľským menom a heslom sa odmietnu. - Ak chcete, pridajte Názov, vyberte Udalosti (na začiatku sú začiarknuté všetky) a stlačte Pridať webhook.
- Skopírujte Podpisový kľúč, ktorý sa zobrazí, a stlačte Odoslať testovaciu udalosť.
Pracovný priestor môže mať najviac 10 webhookov.
Udalosti
document.sent: Dokument odoslanýdocument.viewed: Otvorené príjemcom, raz za každého príjemcudocument.signed: Podpísané podpisovateľom, raz za každého podpisovateľadocument.completed: Dokončené: všetci podpísalidocument.declined: Odmietnutédocument.expired: Platnosť vypršaladocument.canceled: Zrušené
Čo posielame
Požiadavku POST s telom JSON: id (rovnaké pri každom pokuse, takže môžete vynechať duplicity), event, created_at, workspace_id, document s id, title, status a url a pri udalostiach týkajúcich sa jednej osoby aj recipient s name, email a role. Zrušený dokument má stav voided. Samotné podpísané PDF sa neposiela. Testovacia udalosť má udalosť test a vymyslený dokument a podpisovateľa.
Overenie podpisu
Každá požiadavka má hlavičku Sealsimple-Signature v tvare t=1700000000,v1=…, popri hlavičkách Sealsimple-Event a Sealsimple-Delivery. Ako ju overiť:
- Vezmite surové telo požiadavky presne tak, ako prišlo.
- Z hlavičky prečítajte
t(unixový čas v sekundách) av1. - Vypočítajte HMAC-SHA256 z
t, bodky a tela, s celým vaším podpisovým kľúčom ako kľúčom, v hexadecimálnom zápise malými písmenami. - Požiadavku prijmite, len ak sa výsledok rovná
v1(porovnávajte v konštantnom čase) atnie je staršie ako niekoľko minút.
V časti Ako prepojiť ukazuje Overenie podpisu (Node.js) tento postup ako kód, s tlačidlom Kopírovať kód. Nový kľúč kľúč okamžite nahradí, preto hneď potom aktualizujte svoje overovanie.
Opakované pokusy, protokol a pozastavenie
Odpovedzte stavom 2xx do 10 sekúnd. Inak to skúsime znova neskôr, spolu najviac 6-krát v priebehu približne jedného dňa. Presmerovania nesledujeme a odpoveď 410 pokusy zastaví. Protokol doručení ukazuje posledných 50 správ s odpoveďou vášho endpointu a Odoslať znova jednu z nich pošle znova.
Po 20 neúspešných doručeniach za sebou webhook pozastavíme (Pozastavený po chybách) a pošleme e-mail vlastníkom pracovného priestoru. Opravte endpoint, webhook znova zapnite a z protokolu znova odošlite, čo potrebujete. Webhook môžete pozastaviť aj jeho prepínačom: udalosti, ktoré nastanú počas pozastavenia, sa neskôr neodošlú. Bez Pro webhooky zostanú, ale nič neposielajú.