Nagenoeg alle gebeurtenissen die in vPlan plaatsvinden, zijn beschikbaar als webhook gebeurtenis. Webhooks zijn een manier om real-time communicatie en gegevensuitwisseling mogelijk te maken tussen verschillende applicaties. Een webhook is een verzoek dat automatisch wordt verzonden vanuit een applicatie of service naar een specifieke URL (endpoint) wanneer een bepaalde gebeurtenis of actie plaatsvindt.
Kort samengevat stellen de vPlan webhooks andere applicaties in staat om real-time meldingen te ontvangen over belangrijke gebeurtenissen, zoals het aanmaken van kaartjes, het wijzigen van een status of het toevoegen van een label, waardoor naadloze integraties en acties tussen verschillende systemen mogelijk worden.
Als administrator in vPlan kun je eenvoudig webhooks instellen. Volg hiervoor de volgende stappen:
Configuratie in de linker menubalk van vPlan.
Klik in de linker menubalk op Ontwikkelaars.
Klik rechts naast het kopje Webhooks op het plus-icoontje.
Geef je webhook een naam.
Vul een URL in waar je webhooks naar verstuurd worden.
Als laatste selecteer je voor welke vPlan gebeurtenissen een bericht verstuurd moet worden. Je mag meerdere gebeurtenissen selecteren.
Klik onderaan de pagina op Opslaan.
Als je de webhook wilt activeren, scroll dan naar boven en klik op Activeren.
Vanaf dat moment worden webhook berichten verstuurd naar het door jou opgegeven endpoint aan de hand van de door jouw gekozen gebeurtenissen in vPlan.
Tip
We adviseren om altijd eerst met een HTTP 2XX response te reageren op een goed ontvangen webhooks, om daarna pas het bericht te verwerken. Als vPlan geen HTTP 2XX response ontvangt wordt een bericht als mislukt gekenmerkt. Dit kan gevolgen hebben voor je webhook continuïteit.
In ditzelfde overzicht wordt nu ook een logboek getoond met alle pogingen van vPlan om berichten te versturen. Elk bericht heeft een van de statussen Gestart, Mislukt of Geslaagd. Ook kun je op de statusknop klikken om de inhoud van het webhook bericht te zien.
Berichten kunnen ook de status Geschorst hebben. Dat betekent dat vPlan al ruimte tijd geen response meer heeft gehad vanuit de ontvangende partij dat het bericht is ontvangen. Na 250 mislukte berichten krijgt de vPlan Administrator een e-mail notificatie. Na 500 mislukte berichten wordt je webhook uitgeschakeld.