Pošiljajte dogodke dokumentov v svoj sistem z webhooki
Webhook pošlje podpisano sporočilo JSON na vaš URL, ko je dokument poslan, odprt, podpisan, dokončan, zavrnjen, potekel ali preklican. Potreben je Pro; nastavijo ga lastniki in skrbniki.
Ta prevod je starejši od angleškega članka, zato so se nekatere podrobnosti morda spremenile. Preberite angleško različico
Na tej strani
Webhook pošlje sporočilo na vaš URL vsakič, ko se z dokumentom kaj zgodi, da se lahko vaš lastni sistem na to odzove. Webhooki so del paketa Pro: v delovnem prostoru delujejo, dokler ima eden od njegovih lastnikov Pro, upravljajo pa jih lahko samo lastniki in skrbniki. Vsak delovni prostor ima svoje.
Dodajte webhook
- V meniju računa odprite Nastavitve in blagovna znamka in pojdite na Integracije.
- Pritisnite Dodaj webhook.
- Vnesite URL končne točke. Začeti se mora s
https://in biti javen: naslovi v zasebnih omrežjih, lastni naslovi Sealsimple in URL-ji z uporabniškim imenom in geslom so zavrnjeni. - Po želji dodajte Ime, izberite Dogodki (na začetku so označeni vsi) in pritisnite Dodaj webhook.
- Kopirajte prikazani Ključ za podpisovanje in pritisnite Pošlji testni dogodek.
Delovni prostor ima lahko do 10 webhookov.
Dogodki
document.sent: Dokument poslandocument.viewed: Odprl prejemnik, enkrat na prejemnikadocument.signed: Podpisal podpisnik, enkrat na podpisnikadocument.completed: Dokončano: vsi so podpisalidocument.declined: Zavrnjenodocument.expired: Poteklodocument.canceled: Preklicano
Kaj pošljemo
Zahtevo POST s telesom JSON: id (enak pri vsakem poskusu, da lahko dvojnike preskočite), event, created_at, workspace_id, document z id, title, status in url ter pri dogodkih, ki se nanašajo na eno osebo, recipient z name, email in role. Preklicani dokument ima stanje voided. Samega podpisanega PDF-ja ne pošljemo. Testni dogodek ima dogodek test ter izmišljen dokument in podpisnika.
Preverite podpis
Vsaka zahteva ima glavo Sealsimple-Signature, na primer t=1700000000,v1=…, poleg glav Sealsimple-Event in Sealsimple-Delivery. Preverite jo takole:
- Vzemite neobdelano telo zahteve, natanko takšno, kot je prispelo.
- Iz glave preberite
t(čas Unix v sekundah) inv1. - Izračunajte HMAC-SHA256 iz
t, pike in telesa, s celotnim ključem za podpisovanje kot ključem, v šestnajstiškem zapisu z malimi črkami. - Zahtevo sprejmite samo, če je rezultat enak
v1(primerjajte v konstantnem času) intni starejši od nekaj minut.
Pod Kako povezati razdelek Preverjanje podpisa (Node.js) to prikaže kot kodo, z gumbom Kopiraj kodo. Nov ključ takoj zamenja ključ, zato takoj zatem posodobite svoje preverjanje.
Ponovni poskusi, dnevnik in začasna ustavitev
Odgovorite s stanjem 2xx v 10 sekundah. Sicer poskusimo znova pozneje, skupaj največ 6-krat v približno enem dnevu. Preusmeritvam ne sledimo, odgovor 410 pa ustavi poskuse. Dnevnik dostav prikazuje zadnjih 50 sporočil z odgovorom vaše končne točke, Pošlji znova pa eno od njih pošlje znova.
Po 20 zaporednih neuspešnih dostavah webhook začasno ustavimo (Ustavljeno zaradi napak) in o tem po e-pošti obvestimo lastnike delovnega prostora. Popravite končno točko, webhook znova vklopite in iz dnevnika znova pošljite, kar potrebujete. Webhook lahko začasno ustavite tudi z njegovim stikalom: dogodki, ki se zgodijo, ko je ustavljen, se pozneje ne pošljejo. Brez paketa Pro webhooki ostanejo, vendar ne pošiljajo ničesar.