Overzicht
Met een Webhook kan Appical automatisch informatie naar een ander systeem sturen zodra er een bepaalde gebeurtenis plaatsvindt. Bijvoorbeeld wanneer een gebruiker wordt uitgenodigd, de eerste werkdag aanbreekt of een cursus of formulier wordt afgerond.
Appical verstuurt hiervoor een HTTP-verzoek met gegevens in JSON-formaat naar een URL die je organisatie zelf instelt.
Voorbeeld
Je organisatie wil dat het HR-systeem automatisch een update ontvangt zodra een nieuwe medewerker de onboardingcursus heeft afgerond.
Hiervoor kun je een Webhook aanmaken met de Trigger course.completed. Zodra een medewerker de cursus afrondt, wordt deze informatie automatisch naar het HR-systeem verstuurd.
📌 Belangrijk
Webhooks moeten eerst voor je organisatie worden ingeschakeld. Zie je de optie Webhooks niet onder Instellingen? Neem dan contact op met je CSM of Appical Support.
Alleen gebruikers met de rol Admin kunnen Webhooks bekijken en beheren.
Stappen om een Webhook in te stellen
Als Admin kun je Webhooks instellen via Instellingen > Webhooks. Gebruikers met andere rollen hebben geen toegang tot deze optie.
→ Een Webhook aanmaken
Ga naar Instellingen > Webhooks.
Klik op Webhook toevoegen (Add Webhook).
Vul de volgende velden in:
Naam (Name)
Beschrijving (Description)
Methode (Method)
URL
Triggers
Signing Secret
Aangepaste headers (Custom headers)
Klik op Aanmaken (Create).
De Webhook wordt direct geactiveerd nadat je deze hebt aangemaakt.
→ De Webhookgegevens invullen
Veld | Verplicht? | Wat vul je in? |
Naam (Name) | Ja | Geef de Webhook een herkenbare naam, bijvoorbeeld 'HR-systeem – Cursus afgerond'. Maximaal 255 tekens. |
Beschrijving (Description) | Nee | Een korte toelichting waarvoor de Webhook wordt gebruikt. Maximaal 500 tekens. |
Methode (Method) | Ja | De HTTP-methode die het ontvangende systeem verwacht. Standaard is POST geselecteerd. Bekijk het artikel Webhook Methods and Triggers explained voor meer informatie. |
URL | Ja | Het adres waar de gegevens naartoe worden gestuurd. Dit moet beginnen met |
Triggers | Ja | Selecteer één of meerdere gebeurtenissen die de Webhook moeten activeren. Bekijk het artikel Webhook Methods and Triggers explained voor alle beschikbare opties. |
Signing Secret | Nee | Een geheime sleutel die je zelf aanmaakt en deelt met het ontvangende systeem. Hiermee kan het systeem controleren of het verzoek daadwerkelijk van Appical afkomstig is. De sleutel wordt na het opslaan niet opnieuw getoond. Bekijk het artikel Verifying Webhook signatures in Appical voor meer informatie. |
Aangepaste headers (Custom headers) | Nee | Extra naam-waardeparen die aan elk verzoek worden toegevoegd, bijvoorbeeld voor authenticatie bij het ontvangende systeem. |
📌 Tip: Weet je niet zeker welke methode of Trigger je moet kiezen? Bekijk dan ons artikel Webhook Methods and Triggers explained voor meer uitleg.
→ De Webhook opslaan en activeren
Controleer of alle gegevens goed zijn ingevuld en klik vervolgens op Aanmaken (Create).
De Webhook wordt direct geactiveerd en is vanaf dat moment klaar voor gebruik.
📌 Belangrijk: Alleen gebeurtenissen die plaatsvinden nadat de Webhook is aangemaakt en ingeschakeld, worden doorgestuurd. Eerdere gebeurtenissen worden niet met terugwerkende kracht verzonden.
→ Een bestaande Webhook beheren
Wil je een bestaande Webhook aanpassen, tijdelijk uitschakelen of verwijderen?
Ga dan naar Instellingen > Webhooks.
Hier kun je het volgende doen:
In- of uitschakelen: Gebruik de schakelaar Enabled om een Webhook tijdelijk te pauzeren of opnieuw te activeren.
Bewerken: Klik op het potloodicoon om de instellingen van een Webhook aan te passen.
Verwijderen: Klik op het prullenbakicoon om een Webhook definitief te verwijderen.
📌 Let op:
Gebeurtenissen die plaatsvinden terwijl een Webhook is uitgeschakeld, worden niet alsnog verstuurd zodra je deze weer inschakelt.
Als je een Webhook verwijdert, wordt ook de bijbehorende verzendgeschiedenis (Delivery History) verwijderd.
👉 Heeft dit artikel je geholpen? Laat het ons weten via de knoppen hieronder. Kom je er nog niet uit? Neem dan gerust contact op met ons Supportteam. We helpen je graag verder!