Skicka dokumenthändelser till ditt system med webhooks

En webhook skickar ett signerat JSON-meddelande till din URL när ett dokument skickas, öppnas, signeras, slutförs, avböjs, går ut eller dras tillbaka. Kräver Pro; ägare och admins konfigurerar den.

Den här översättningen är äldre än den engelska artikeln, så vissa detaljer kan ha ändrats. Läs den engelska versionen

En webhook skickar ett meddelande till en URL som du anger varje gång något händer med ett dokument, så att ditt eget system kan agera på det. Webhooks ingår i Pro: de fungerar i en arbetsyta så länge någon av dess ägare har Pro, och bara ägare och admins kan hantera dem. Varje arbetsyta har sina egna.

Lägg till en webhook

  1. Öppna Inställningar och varumärke i kontomenyn och gå till Integrationer.
  2. Tryck på Lägg till webhook.
  3. Ange Endpoint-URL. Den måste börja med https:// och vara offentlig: adresser i privata nätverk, Sealsimples egna adresser och URL:er med användarnamn och lösenord godtas inte.
  4. Lägg till ett Namn om du vill, välj Händelser (alla är ikryssade från början) och tryck på Lägg till webhook.
  5. Kopiera nyckeln som visas under Signeringsnyckel och tryck på Skicka testhändelse.

En arbetsyta kan ha upp till 10 webhooks.

Händelser

  • document.sent: Dokument skickat
  • document.viewed: Öppnat av en mottagare, en gång per mottagare
  • document.signed: Signerat av en undertecknare, en gång per undertecknare
  • document.completed: Slutfört: alla har signerat
  • document.declined: Avböjt
  • document.expired: Utgånget
  • document.canceled: Tillbakadraget

Det här skickar vi

En POST med en JSON-body: id (samma vid varje försök, så att du kan hoppa över dubbletter), event, created_at, workspace_id, ett document med id, title, status och url, och för händelser som gäller en person en recipient med name, email och role. Ett tillbakadraget dokument har statusen voided. Själva den signerade PDF:en skickas inte. Testhändelsen har händelsen test och ett påhittat dokument och en påhittad undertecknare.

Kontrollera signaturen

Varje förfrågan har en Sealsimple-Signature-header som ser ut som t=1700000000,v1=…, bredvid Sealsimple-Event och Sealsimple-Delivery. Så kontrollerar du den:

  1. Ta den råa request-bodyn, exakt som den kom.
  2. Läs t (en Unix-tid i sekunder) och v1 från headern.
  3. Beräkna HMAC-SHA256 av t, en punkt och bodyn, med hela signeringsnyckeln som HMAC-nyckel, i hex med gemener.
  4. Godta förfrågan bara om värdet är lika med v1 (jämför i konstant tid) och t är högst några minuter gammal.

Under Så kopplar du visar Kontrollera signaturen (Node.js) detta som kod, med Kopiera kod. Ny nyckel ersätter nyckeln direkt, så uppdatera din kontroll omedelbart efteråt.

Nya försök, loggen och paus

Svara med en 2xx-status inom 10 sekunder. Annars försöker vi igen senare, upp till 6 försök totalt under ungefär ett dygn. Omdirigeringar följs inte, och svaret 410 stoppar försöken. Leveranslogg visar de senaste 50 meddelandena med din endpoints svar, och Skicka igen skickar ett av dem igen.

Efter 20 misslyckade leveranser i rad pausar vi webhooken (Pausad efter fel) och mejlar arbetsytans ägare. Åtgärda endpointen, slå på webhooken igen och skicka det du behöver igen från loggen. Du kan också pausa en webhook med dess reglage: händelser som inträffar medan den är pausad skickas inte i efterhand. Utan Pro finns webhooks kvar men skickar ingenting.

Var den här artikeln till hjälp?

Prova med ditt nästa avtal.

5 gratis utskick varje kalendermånad. Inget kreditkort behövs.

Behöver du fortfarande hjälp?

Fråga vår assistent i chatten: den svarar direkt. Eller mejla oss, så svarar en människa inom en arbetsdag.