Ställa in webhooks

Webhooks i Totara gör att din webbplats automatiskt kan skicka uppdateringar till externa system när specifika händelser inträffar, vilket förbättrar effektiviteten och möjliggör realtidsintegration med tredjepartstjänster. Denna funktion är särskilt användbar för att minska behovet av ständig API-avfrågning, vilket kan sakta ner processer och orsaka onödig belastning på dina system.

Vad används webhooks till?

Istället för att upprepade gånger kontrollera Totaras External API för att se om något har ändrats, meddelar webhooks andra system i samma ögonblick som något händer. Detta gör integrationer smidigare och snabbare.

Vanliga användningsområden inkluderar:

• Meddela en HR-plattform när en lärande slutför introduktionsträning.

• Utlösa ett e-postmeddelande med ett certifikat när en användare slutför en kurs.

• Skicka uppdateringar till ett CRM som Salesforce när en användare anmäler sig till träning.

• Skicka aviseringar till Slack när en ny kurs publiceras.

• Integrera med ett affärsintelligensverktyg som Power BI i realtid.

Behörigheter

Två behörigheter är tillgängliga i Totara för att kontrollera åtkomst till webhooks:

• Visa webhooks

• Hantera webhooks

Åtkomst till Webhooks

Webhooks är förinstallerade från Totara 19.1 och framåt, men de är inaktiverade som standard. För att aktivera webhooks:

1. Gå till snabbåtkomstmenyn > Konfigurera funktioner.

2. Markera kryssrutan för Aktivera Webhooks funktionen.

Skapa en Webhook

1. Gå till Snabbåtkomstmeny > Utveckling > API > Webhooks

2. För att lägga till en ny Webhook klicka på Skapa knappen.

3. Fyll i formuläret Skapa Webhook med följande fält:

4. Klicka på Spara. Du kommer att omdirigeras till webhooks listningssida där din nya webhook nu kommer att listas.

Redigera Webhooks

För att redigera en webhook, från webhooks listningssida, antingen:

• Klicka på de tre punkterna ( ) för den webhook du vill redigera, och från menyn välj Redigera.

  

• Eller öppna webhooks genom att klicka på webhooks namn, och klicka på Redigera knappen.

  

Gör sedan dina ändringar från Redigera Webhook formuläret med de aktuella webhook-inställningarna och klicka på Skicka för att bekräfta och spara dina ändringar, eller Avbryt för att återgå till webhooks listningssida och avbryta alla ändringar.

Deaktivera Webhooks

Webhooks kan deaktiveras genom att ändra deras status till inaktiverad. Inaktiverade webhooks kommer inte att ha några förfrågningar skickade till sig, och kommer heller inte ha några webhook-payloads i kö.

Ta bort Webhooks

För att ta bort en webhook, från listningssidan för webhooks:

1. Klicka på de tre prickarna ( ) för den webhook du vill ta bort, och välj Radera från menyn

2. Bekräfta borttagningen i dialogrutan som visas.

Klicka på Radera för att permanent ta bort webhooks. Klicka på Avbryt för att återvända utan att radera.

Webhook Payloads

När en webhook utlöses, skickar Totara en HTTP POST-begäran till den konfigurerade slutpunkten. Meddelandets kropp innehåller följande standardfält:

Svara på Webhooks

Totara anser att webhooken är framgångsrik när det mottagande systemet svarar med en HTTP-svarstatuskod i 200-serien. Om Totara får ett svar i 400-serien kommer det att anse att webhooken är felaktigt konfigurerad och flytta begärans nyttolast till dödsbrevkö. Allt utanför dessa serier (t.ex. 500), kommer att orsaka att webhooken köas om för att försöka igen vid ett senare tillfälle.

Händelseprenumerationer

Webhooks kan prenumerera på alla tillgängliga händelser i Totara. Dessa inkluderar användarskapande, kurskompletteringar, märkesutmärkelser och mer. Vid tiden för skrivandet finns det över 900 händelser som kan användas för att trigga webhooks.

Webhooks gör det möjligt för Totara att arbeta sömlöst med din organisations bredare digitala ekosystem. När de väl är inställda tillåter de automatisering i realtid mellan Totara och andra plattformar, vilket sparar tid och förbättrar datanoggrannhet.