Send dokumenthændelser til dit system med webhooks
En webhook sender en signeret JSON-besked til din URL, når et dokument sendes, åbnes, underskrives, fuldføres, afvises, udløber eller annulleres. Kræver Pro; ejere og administratorer sætter den op.
Denne oversættelse er ældre end den engelske artikel, så nogle detaljer kan have ændret sig. Læs den engelske version
På denne side
En webhook sender en besked til en URL, du ejer, hver gang der sker noget med et dokument, så dit eget system kan reagere på det. Webhooks er en del af Pro: De virker i et arbejdsområde, så længe en af dets ejere har Pro, og kun ejere og administratorer kan administrere dem. Hvert arbejdsområde har sine egne.
Tilføj en webhook
- Åbn Indstillinger og branding i kontomenuen, og gå til Integrationer.
- Tryk på Tilføj webhook.
- Indtast Endpoint-URL. Den skal starte med
https://og være offentlig: Adresser i private netværk, Sealsimples egne adresser og URL'er med brugernavn og adgangskode bliver afvist. - Tilføj et Navn, hvis du vil, vælg Hændelser (alle er valgt til at begynde med), og tryk på Tilføj webhook.
- Kopiér den Signeringsnøgle, der vises, og tryk på Send testhændelse.
Et arbejdsområde kan have op til 10 webhooks.
Hændelser
document.sent: Dokument sendtdocument.viewed: Åbnet af en modtager, én gang pr. modtagerdocument.signed: Underskrevet af en underskriver, én gang pr. underskriverdocument.completed: Fuldført: alle har underskrevetdocument.declined: Afvistdocument.expired: Udløbetdocument.canceled: Annulleret
Det sender vi
En POST med en JSON-body: id (det samme ved hvert forsøg, så du kan springe dubletter over), event, created_at, workspace_id, et document med id, title, status og url og, ved hændelser om én person, en recipient med name, email og role. Et annulleret dokument har status voided. Selve den underskrevne PDF sendes ikke. Testhændelsen har hændelsen test og et opdigtet dokument og en opdigtet underskriver.
Tjek signaturen
Hver anmodning har en Sealsimple-Signature-header som t=1700000000,v1=… ud over Sealsimple-Event og Sealsimple-Delivery. Sådan tjekker du den:
- Tag den rå request-body, præcis som den kom.
- Læs
t(et Unix-tidspunkt i sekunder) ogv1fra headeren. - Beregn HMAC-SHA256 af
t, et punktum og body'en med hele din signeringsnøgle som nøgle, som hex med små bogstaver. - Acceptér kun anmodningen, hvis resultatet er lig med
v1(sammenlign i konstant tid), ogthøjst er et par minutter gammel.
Under Sådan forbinder du viser Tjek signaturen (Node.js) dette som kode med Kopiér kode. Ny nøgle erstatter nøglen med det samme, så opdater dit tjek lige bagefter.
Nye forsøg, loggen og pause
Svar med en 2xx-status inden for 10 sekunder. Ellers prøver vi igen senere, op til 6 forsøg i alt over cirka et døgn. Omdirigeringer følges ikke, og et svar med 410 stopper forsøgene. Leveringslog viser de seneste 50 beskeder med dit endpoints svar, og Send igen sender en besked igen.
Efter 20 mislykkede leveringer i træk sætter vi webhooken på pause (Sat på pause efter fejl) og sender en e-mail til arbejdsområdets ejere. Ret endpointet, slå webhooken til igen, og send det, du har brug for, igen fra loggen. Du kan også sætte en webhook på pause med dens kontakt: Hændelser, der sker, mens den er sat på pause, sendes ikke senere. Uden Pro bliver webhooks, men de sender intet.