Šaljite događaje dokumenata u svoj sustav putem webhookova
Webhook šalje potpisanu JSON poruku na vaš URL kad se dokument pošalje, otvori, potpiše, dovrši, odbije, istekne ili otkaže. Potreban je Pro; postavljaju ga vlasnici i administratori.
Ovaj je prijevod stariji od članka na engleskom, pa su se neki detalji možda promijenili. Pročitajte englesku verziju
Na ovoj stranici
Webhook šalje poruku na vaš URL svaki put kad se nešto dogodi s dokumentom, kako bi vaš vlastiti sustav mogao reagirati. Webhookovi su dio paketa Pro: rade u radnom prostoru dok neki od njegovih vlasnika ima Pro, a njima mogu upravljati samo vlasnici i administratori. Svaki radni prostor ima vlastite.
Dodajte webhook
- Otvorite Postavke i vizualni identitet u izborniku računa i idite na Integracije.
- Pritisnite Dodaj webhook.
- Unesite URL krajnje točke. Mora počinjati s
https://i biti javan: adrese u privatnim mrežama, adrese usluge Sealsimple i URL-ovi s korisničkim imenom i lozinkom odbijaju se. - Po želji dodajte Naziv, odaberite Događaji (na početku su svi označeni) i pritisnite Dodaj webhook.
- Kopirajte Ključ za potpisivanje koji se pojavi i pritisnite Pošalji testni događaj.
Radni prostor može imati najviše 10 webhookova.
Događaji
document.sent: Dokument poslandocument.viewed: Otvorio primatelj, jednom po primateljudocument.signed: Potpisao potpisnik, jednom po potpisnikudocument.completed: Dovršeno: svi su potpisalidocument.declined: Odbijenodocument.expired: Isteklodocument.canceled: Otkazano
Što šaljemo
Zahtjev POST s JSON tijelom: id (isti pri svakom pokušaju, pa možete preskočiti duplikate), event, created_at, workspace_id, document s id, title, status i url te, za događaje o jednoj osobi, recipient s name, email i role. Otkazani dokument ima status voided. Sam potpisani PDF se ne šalje. Testni događaj ima događaj test te izmišljen dokument i potpisnika.
Provjerite potpis
Svaki zahtjev ima zaglavlje Sealsimple-Signature oblika t=1700000000,v1=…, uz Sealsimple-Event i Sealsimple-Delivery. Da ga provjerite:
- Uzmite neobrađeno tijelo zahtjeva, točno onako kako je stiglo.
- Pročitajte
t(Unix vrijeme u sekundama) iv1iz zaglavlja. - Izračunajte HMAC-SHA256 od
t, točke i tijela, s vašim cijelim ključem za potpisivanje kao ključem, u heksadecimalnom zapisu malim slovima. - Prihvatite zahtjev samo ako je ovo jednako
v1(usporedite u konstantnom vremenu) i ako jetstar najviše nekoliko minuta.
Pod Kako povezati, Provjera potpisa (Node.js) prikazuje ovo kao kôd, uz Kopiraj kod. Novi ključ odmah zamjenjuje ključ, pa provjeru ažurirajte odmah nakon toga.
Ponovni pokušaji, zapisnik i pauziranje
Odgovorite statusom 2xx u roku od 10 sekundi. Inače pokušavamo ponovno kasnije, ukupno najviše 6 pokušaja tijekom otprilike jednog dana. Preusmjeravanja se ne slijede, a odgovor 410 zaustavlja pokušaje. Zapisnik isporuka prikazuje zadnjih 50 poruka s odgovorom vaše krajnje točke, a Pošalji ponovno šalje jednu ponovno.
Nakon 20 neuspjelih isporuka zaredom pauziramo webhook (Pauzirano nakon pogrešaka) i šaljemo e-poruku vlasnicima radnog prostora. Ispravite krajnju točku, ponovno uključite webhook i iz zapisnika ponovno pošaljite ono što vam treba. Webhook možete pauzirati i njegovim prekidačem: događaji koji se dogode dok je pauziran ne šalju se kasnije. Bez paketa Pro webhookovi ostaju, ali ne šalju ništa.