Dokumendisündmuste saatmine oma süsteemi webhookidega
Webhook (Pro) saadab teie URL-ile allkirjastatud JSON-i, kui dokument saadetakse, avatakse, allkirjastatakse, valmib, lükatakse tagasi, aegub või tühistatakse. Seadistab omanik või administraator.
See tõlge on ingliskeelsest artiklist vanem, seega võivad mõned üksikasjad olla muutunud. Loe ingliskeelset versiooni
Sellel lehel
Webhook saadab teie URL-ile sõnumi iga kord, kui dokumendiga midagi juhtub, et teie süsteem saaks sellele reageerida. Webhookid kuuluvad Pro-paketti: need töötavad tööruumis, kui ühel selle omanikest on Pro-pakett, ja neid saavad hallata ainult omanikud ja administraatorid. Igal tööruumil on oma webhookid.
Webhooki lisamine
- Avage kontomenüüs Seaded ja kujundus ja minge jaotisse Integratsioonid.
- Vajutage Lisa webhook.
- Sisestage Lõpp-punkti URL. See peab algama eesliitega
https://ja olema avalik: privaatvõrkude aadressid, Sealsimple'i enda aadressid ning kasutajanime ja parooliga URL-id lükatakse tagasi. - Soovi korral lisage Nimi, valige Sündmused (alguses on kõik märgitud) ja vajutage Lisa webhook.
- Kopeerige ilmuv Allkirjavõti ja vajutage Saada testsündmus.
Tööruumis võib olla kuni 10 webhooki.
Sündmused
document.sent: Dokument saadetuddocument.viewed: Saaja avas, üks kord saaja kohtadocument.signed: Allkirjastaja allkirjastas, üks kord allkirjastaja kohtadocument.completed: Valmis: kõik on allkirjastanuddocument.declined: Tagasi lükatuddocument.expired: Aegunuddocument.canceled: Tühistatud
Mida me saadame
POST-päring JSON-sisuga: id (iga katse puhul sama, et saaksite duplikaadid vahele jätta), event, created_at, workspace_id, document koos väljadega id, title, status ja url ning ühte inimest puudutavate sündmuste puhul recipient koos väljadega name, email ja role. Tühistatud dokumendi olek on voided. Allkirjastatud PDF-i ennast ei saadeta. Testsündmuse sündmus on test ning dokument ja allkirjastaja on väljamõeldud.
Allkirja kontrollimine
Igal päringul on päis Sealsimple-Signature kujul t=1700000000,v1=…, lisaks päised Sealsimple-Event ja Sealsimple-Delivery. Kontrollimiseks:
- Võtke päringu töötlemata sisu täpselt sellisena, nagu see saabus.
- Lugege päisest
t(Unixi aeg sekundites) jav1. - Arvutage
t, punkti ja sisu HMAC-SHA256, kasutades võtmena kogu oma allkirjavõtit, väiketähtedega kuueteistkümnendkujul (hex). - Aktsepteerige päring ainult siis, kui tulemus on võrdne väärtusega
v1(võrrelge konstantse ajaga) jaton kõige rohkem mõne minuti vanune.
Jaotises Kuidas ühendada näitab Allkirja kontrollimine (Node.js) seda koodina koos nupuga Kopeeri kood. Uus võti asendab võtme kohe, seega uuendage oma kontrolli kohe pärast seda.
Korduskatsed, logi ja peatamine
Vastake 10 sekundi jooksul 2xx-olekukoodiga. Muidu proovime hiljem uuesti, kokku kuni 6 katset umbes ööpäeva jooksul. Ümbersuunamisi ei järgita ja vastus 410 lõpetab katsed. Edastuslogi näitab viimased 50 sõnumit koos teie lõpp-punkti vastusega ja Saada uuesti saadab sõnumi uuesti.
Pärast 20 järjestikust ebaõnnestunud edastust peatame webhooki (Peatatud tõrgete tõttu) ja saadame tööruumi omanikele e-kirja. Parandage lõpp-punkt, lülitage webhook uuesti sisse ja saatke logist uuesti, mida vajate. Webhooki saate peatada ka selle lülitiga: peatamise ajal toimunud sündmusi hiljem ei saadeta. Ilma Pro-paketita jäävad webhookid alles, kuid ei saada midagi.