Webhooks och leveranskontroll

Ta emot besked när en försändelse är förseglad och följ testning, verifiering och omförsök.

Webhooks

En webhook skickar ett HTTP-anrop till ert system när den valda händelsen inträffar. Som administratör anger du namn, mottagaradress och händelse på utvecklarsidan.

Händelsen envelope.sealed i version 2 gäller en färdig försegling av en försändelse. En enskild deltagares signering är ett tidigare moment i processen. Skapande av webhooks är avstängt i demosandlådan.

Mer om webhooks

Den vanliga valbara webhookhändelsen gäller en förseglad försändelse och heter envelope.sealed i version 2. Den meddelar att förseglingen är klar. En enskild deltagares underskrift är inte samma händelse, och andra registrerade systemhändelser blir inte automatiskt valbara webhookhändelser.

Verifieringsnyckel för webhook

Webhooks i version 2 har en egen verifieringshemlighet som kan kopieras från webhookens rad på utvecklarsidan. Mottagarsystemet använder den för att kontrollera meddelandets signatur.

Version 2 följer Standard Webhooks och skickar huvudena webhook-id, webhook-timestamp och webhook-signature. Verifiera den ursprungliga meddelandekroppen och tidsstämpeln med rätt hemlighet. API-nyckeln är separat. Äldre webhooks använder ett annat signaturformat.

Mer om verifieringsnyckel för webhook

Version 2 signerar med Standard Webhooks och skickar webhook-id, webhook-timestamp och webhook-signature i HTTP-huvudena. Mottagaren behöver verifiera den skickade meddelandekroppen och tidsstämpeln med rätt hemlighet. Den äldre versionen använder ett annat format med hash och RSA-signatur i kroppen.

Webhookhändelser och leveransförsök

Händelselistan visar organisationens senaste webhookhändelser och deras leveransförsök. Öppna en händelse för att se skickat underlag, svar och detaljer för ett visst försök.

Översikten visar högst 30 händelser. Ett lyckat HTTP-anrop bekräftar leveransen på den nivån. Kontrollera även ert mottagarsystem om du behöver veta att dess efterföljande behandling är klar.

Mer om webhookhändelser och leveransförsök

Listan visar organisationens senaste webhookhändelser, högst 30, med de senaste leveransförsöken först. Öppna en händelse för att granska det skickade underlaget, svaret och detaljer om ett visst försök. Översikten innehåller färre detaljer än händelsens detaljvy och är inte en fullständig historik när fler än 30 händelser finns. Ett lyckat HTTP-anrop visar att webhookleveransen lyckades på den nivån. Det bekräftar inte att mottagarsystemets efterföljande behandling, till exempel lagring eller en annan affärsåtgärd, har blivit klar.

Nya leveransförsök

Misslyckade webhookanrop försöks igen med ökande väntetid. Kontrollera händelser och svar från mottagarsystemet när ett fel återkommer. Efter försöksgränsen markeras händelsen som övergiven.

I version 2 behåller händelsen samma webhook-id vid nya försök, medan tidsstämpeln för signeringen förnyas. Mottagarsystemet behöver därför kunna hantera dubbletter. Samma händelse kan levereras flera gånger.

Mer om nya leveransförsök

När försöksgränsen passeras markeras händelsen som övergiven. I version 2 behåller samma händelse sitt webhook-id vid nya försök, medan signeringens tidsstämpel förnyas. Mottagarsystemet behöver hantera dubbletter. Leveransen är inte garanterad och samma händelse kan komma flera gånger.

Testa webhook

Administratörer kan testa en webhook av version 2 från dess meny. Testet skickar exempeldata till den sparade adressen med samma signering och leverans som ett vanligt meddelande. Dialogen visar underlag och svar.

Testresultatet sparas inte i den vanliga händelseloggen. Gör ett nytt test efter att mottagarsystemet har ändrats. Testutskick är avstängda i demosandlådan.

Mer om testa webhook

Testet är tillgängligt för administratörer och webhooks av version 2. Det använder exempeldata för en prenumererad händelse och samma signering och leverans som ett vanligt meddelande. Resultatet visas i testdialogen men sparas inte i den vanliga händelseloggen. Ett lyckat testsvar bekräftar inte att framtida leveranser eller mottagarsystemets fortsatta behandling lyckas. Testutskick är avstängda i demosandlådan.

Ta bort webhook

Administratörer kan välja borttagning i webhookens meny och bekräfta. Konfigurationen och dess händelsehistorik tas bort.

Tidigare levererade anrop återkallas inte, och ett redan påbörjat anrop kan fortsätta. Borttagning av webhooks är avstängd i demosandlådan.

Mer om ta bort webhook

Först tas händelsehistoriken för den aktuella webhooken bort, därefter själva webhooken. Åtgärden återkallar inte anrop som redan levererats till mottagarsystemet och garanterar inte att ett redan påbörjat anrop avbryts.

Ändra webhook

Administratörer kan redigera en webhook från dess meny. Minst en händelse behöver vara vald. Äldre webhooks av version 1 saknar redigeringsval.

Sparandet byter inte verifieringshemligheten, testar inte adressen och skickar inte om tidigare misslyckade anrop. Kontrollera testresultat och händelsehistorik separat. Redigering är avstängd i demosandlådan.

Mer om ändra webhook

Minst en händelse måste vara vald. Ändringen byter inte automatiskt verifieringshemligheten. Den bekräftar inte heller att mottagaradressen går att nå eller skickar om ett tidigare misslyckat anrop. Kontrollera testresultat och leveranshistorik separat. Redigering är avstängd i demosandlådan.