Inledning
I den här artikeln går vi igenom vad en webhook är, vad de används till och hur du skapar, redigerar och tar bort webhooks i Semesterlistan.
Vad är en webhook?
Webhooks är i grund och botten ett prenumerationssystem. Du väljer vilka händelser du vill prenumerera på, och när en sådan händelse inträffar så skickas meddelanden från Semesterlistan till ett annat system, som innehåller information om vad som hände. En händelse kan exempelvis vara att en ny frånvaroförfrågan lagts in, att en ny användare skapats eller att en förfrågan har blivit godkänd.
När detta inträffar så skapar Semesterlistan ett meddelande som innehåller informationen som rör händelsen: vad hände, vem var inblandad och när skedde den, och skickar sedan den här informationen i realtid till det system du väljer. Du får bara meddelanden för de händelser du väljer att prenumerera på.
Även om detta kanske låter som de påminnelser du som användare får av systemet så är webhooks inte samma sak. Webhooks innehåller teknisk information och är tänkt att användas för integrationer mellan olika system och tjänster, inte för att läsas direkt av människor.
Vad som i slutändan händer med en webhooks meddelande är upp till det mottagande systemet att bestämma, men vanligtvis så används det för att exempelvis uppdatera information i ett HR-system eller liknande. Med webhooks så är det bara fantasin (och systemet som mottar vår webhook) som sätter gränserna.
Vilka händelser kan jag prenumerera på?
Du kan välja att få en webhook från Semesterlistan när en eller fler av följande händer:
- En frånvaroförfrågan skapas
- En frånvaroförfrågan uppdateras (inkl. tas bort)
- En frånvaroförfrågan får en ny status (sker ENBART när en förfrågan godkänns, nekas eller väntar på godkännande)
- En användare skapas
- En användare uppdateras (inkl. tas bort)
- En frånvarotyp skapas
- En frånvarotyp uppdateras (inkl. tas bort)
- Företagsinställningar justeras
- En webhook skapas
- En webhook uppdateras (inkl. tas bort)
Du väljer själv vilka händelser du vill prenumerera på, och kan välja en eller flera i samma webhook.
Hur skapar jag en webhook?
- Logga in i Semesterlistan som administratör
- Gå in på Inställningar och klicka sedan på Webhooks i vänstermenyn
- Klicka på Lägg till
- Ge din webhook ett namn
- Fyll i vilken webbadress du vill att meddelandet ska skickas till
- Fyll i den hemliga koden (mer om denna nedan)
- Välj vilka händelser du vill prenumerera på
- Spara!
Den hemliga koden som nämns i steg 6 används för att säkerställa att det faktiskt är Semesterlistan som skickar över informationen till det system som tar emot webhook:en.
När en webhook skapas så skickar vi också med den hemliga koden på "kuvertet" för vårt meddelande, och det mottagande systemet vet också vad den hemliga koden är. Mottagaren jämför då vår hemliga kod med vad den förväntar sig; stämmer de överens så kommer meddelandet med största sannolikhet faktiskt från Semesterlistan.
Det spelar alltså ingen roll vad den hemliga koden är, men det viktiga är att både Semesterlistan och systemet ni skickar webhooks till vet om vad den gemensamma hemligheten är.
OBS. När du har skapat din webhook så kan du inte längre se vad den hemliga koden är, så spara den på ett säkert ställe först.
När du sparar din nya webhook så skickas också en "ping"-händelse till webbadressen du angav i steg 5.
Hur redigerar jag en webhook?
Inne på Inställningar -> Webhooks så listas alla era befintliga webhooks. Här ser du namnet, webbadressen som meddelandena skickas till, vilka händelser som varje webhook prenumererar på, en logg, papperskorgen för att ta bort en webhook och inte minst den gröna pennan för att redigera allt detta.
När du redigerar en webhook så kan du redigera allt som du fick välja när du skapade en helt ny webhook. Det enda undantaget är att du måste låsa upp fältet för ändra den hemliga koden. För att ändra den befintliga hemliga koden, klicka på Ändra hemlig kod och bekräfta ändringen genom att fylla i den nuvarande koden, och den nya koden du vill ändra till.
När du ändrar en webhook så skickas ingen "ping"-händelse som när du skapade den för första gången.
Hur tar jag bort en webhook?
Inne på Inställningar -> Webhooks så kan en Administratör eller Ägare klicka på papperskorgen för att ta bort en webhook. OBS. Det går inte att återställa borttagna webhooks!
Min webhook funkar inte!!
Semesterlistan sparar en logg på alla händelser som skickats via en webhook. Klicka på loggknappen vid den webhook du vill felsöka, så ser du historik på de 20 senaste händelserna och innehållet i dessa meddelanden.
Har du fler frågor?
Kontakta supporten så hjälper vi dig med alla dina frågor!