Avista – Webhooks

Avista – Webhooks

Författare: Vera Orekh & Magnus Maurex Datum: Mars 2024

English version Avista – webhooks

 

 

Webhooks läggs till för att ge tredje parts tjänster möjlighet att spåra ändringar i Avista i realtid. Implementeringen måste vara skalbar (fler webhook-händelser kan läggas till, extra webhook-inställningar för en prenumerant, etc.) och lätt att underhålla och spåra hur det fungerar.

Tjänster

I Avistas integrationstjänster > Webhooks kan du hitta alla tjänster relaterade till webhooks.

Avista integrationstjänster > Webhooks: visar Inställningar > Integrationsinställningar > Webhooks menyalternativ

Avista integrationstjänster > Webhooks > Events: innehåller tjänster för alla tillgängliga webhook-evenemang. Det är möjligt att definiera en unik lista med händelser för varje prenumerant. Den tillgängliga listan just nu:

• Webhooks > Events > API > Orders > Engångsbeställningsstatus skapad via API: relaterar till api.order.oneTime.status webhook-händelse
• Webhooks > Events >INSTA & Hygiene > When ended: relaterar till INSTA&Hygiene.whenEnded webhook-event

Avista integrationstjänster > Webhooks > Inställningar: ger åtkomst till fliken Inställningar på sidan Inställningar > Integrationsinställningar > Webhooks

Tillåt webhooks-redigering: gör det möjligt att redigera en befintlig webhook
Tillåt att radera en webhook: tillåter att en befintlig webhook tas bort. Inte vanligt beteende. Som standard måste ett slutdatum anges för webhooks som inte använd

Avista integrationstjänster > Webhooks > Loggar: ger åtkomst till fliken Loggar på sidan Inställningar > Integrationsinställningar > Webhooks. Här kan du se listan över de senaste 1000 webhook-leveranserna. Det kan ändras och förbättras i framtiden. Lägg till exempel till filter för dataladdning.

 

Webhook skapande

1. Gå till sidan Inställningar > Integrationsinställningar > Webhooks
2. Välj en flik Inställningar
3. Klicka på knappen Lägg till
4. Fyll i följande fält:

Namn: vilket namn som helst kan anges. Det gör det lättare att hitta en specifik webhook i listan

URL: slutpunkten till vilken alla förfrågningar måste skickas

Hemlig nyckel

Det kan genereras på vår sida (tryck på knappen Generera) eller någon annan sträng du väljer

1. Innan webhooken sparas är det nödvändigt att kopiera den hemliga nyckeln och spara den. Just nu är det inte möjligt att ta emot en hemlig nyckel för befintliga webhooks, men den kan ändras senare.
2. Värdet används för att generera en X-Webhook-Signature header med hjälp av vilken en webhook leveransförfrågan måste valideras
3. Startdatum & Slutdatum: en aktiv period för en webhook
4. Kommentar: det är ett valfritt fält. Alla detaljer relaterade till webhook här.
5. Events: listan över webhook-händelser. Minst en webhook-händelse måste väljas
6. Tryck på knappen Spara

Webhook leveransbegäran

När en webhook-händelse utlöses skapas en webhook-leverans. Sedan skickas en

förfråganBegäran beskrivning

Rubriker:

• Content-Type: application/json
• X-Webhook-Signature: en signaturru
  Använd SHA256-algoritmen och din klienthemlighet för att skapa din version av HMAC-signaturen

Förslag: Fler rubriker kan läggas till som standard eller i webhook-inställningarna.

• Nyttolast:
• webhookDeliveryId: ett webhook-leverans-id
• eventName: en webhook-leveranshändelse
• tidsstämpel: en tidpunkt då en webhook-leverans skapas
• data: värden kan vara olika beroende på webhook-händelsen

INSTA&Hygiene.whenEnded:

• fil: base64-kodad rapportfilinnehåll
• fileExtension: ett filtillägg
• filnamn: ett genererat filnamn på basen av den valda sökvägen i webhook-inställningarna
• sökväg: en genererad sökväg till filen på basen av den valda sökvägen i webhook-inställningarna

Webhook leveransspårning

För att spåra om det finns några problem med att utlösa webhook eller om webhook-leveransen skickades eller inte, kan följande information i Avista vara användbar:

På fliken Inställningar > Integrationsinställningar > Webhooks > Inställningar finns dessa kolumner:

• Senast triggade: visar senast när en webhook-leverans skapades, spelar ingen roll om begäran lyckades eller inte
• Totalt utlöst antal: visar hur många gånger händelserna i webhook har utlösts
• Antal misslyckade: visar hur många misslyckade webhook-leveranser för närvarande. Värdet kan ändras eftersom det finns flera försök att skicka en förfrågan. Just nu är det bara 2.

I fliken Inställningar > Integrationsinställningar > Webhooks > Loggar finns en lista över de senaste 1000 webhookleveranserna med en detaljerad beskrivning av varje artikel.

• PublicId: fält för leverans-ID från förfrågans nyttolast
• Namn: ett webhook-namn
• Senaste försök: senaste gången då en förfrågan skickades
• Status: indikerar om begäran har skickats eller inte
• Event: ett webhook-händelsenamn
• URL: en angiven slutpunkt i webhook-inställningarna
• Nyttolast: informationen som skickades i förfrågan
• Status för senaste svar
• Senaste svarskropp