Via de webhook-functionaliteit ‘abonneer’ je op een bepaalde wijzigingen, de API stuurt je dan onmiddelijk een standaardbericht met de data van de wijziging, op deze manier verkort je aanzienlijk de doorlooptijd en voorkom je ‘wachttijden’ in de keten.
Onderstaande is relevant voor ontwikkelaars van API-koppelingen.
Dit artikel beschrijft hoe je de webhook-functionaliteit kan toevoegen aan je API-applicatie en hoe je het kan testen.
De webhook-functionaliteit is gekoppeld aan een Youforce domein API, denk aan IAM Learning, WorkForceManagement etc. Je maakt bij de configuratie, wat in dit artikel wordt toegelicht, een keuze van de soort(en) mutatie(s) waarvan je een bericht wilt ontvangen.
Je dient een account aan te maken op de Visma Developer portal, hoe staat hier beschreven, heb je al een account dan kan je die vanzelfsprekend gebruiken.
Vanuit het account dien je een applicatie aan te maken met de benodigde Youforce domein API, denk aan IAM, Learning, WorkForceManagement etc. Hoe je een applicatie aanmaakt staat in datzelfde kennisartikel beschreven.
Wanneer de applicatie gereed is dien je de ‘invitatiecode’ te delen met de Raet consultant zodat de consultant de test-demo-klantomgeving aan de applicatie kan koppelen, je ontvangt dan de benodigde tenantID.
Als je applicatie gereed is, dus de applicatie is gekoppeld aan een Youforce domein API en geautoriseerd voor de test-demo-klantomgeving, dien je de webhook als volgt te configureren.
Navigeer binnen de Visma Developer portal naar je applicatie en voer de volgende stappen uit.
Vanuit het scherm 'Webhooks', kies voor 'My Subscriptions' en de knop 'New subscription', een wizard leidt je door de configuratie.
‘Select publisher’, zoek op Youforce en selecteer de Youforce API (met de term ‘Publisher’) waarmee je wilt testen en die je al reeds aan je applicatie hebt gekoppeld, kies voor ‘next’.
Selecteer de events waaruit je een bericht wilt ontvangen, selecteer desgewenst vanuit het test-perspectief alle events, de te selecteren events komen overeen met de aanwezige endpoints binnen de Youforce API, kies voor ‘next’.
Voeg de url toe waar het bericht naartoe gestuurd moet worden, als je geen webhook-url hebt staat verderop in dit artikel beschreven hoe je een test-url kan aanmaken.
Kies bij tenant voor de, via de invitatiecode, reeds gekoppelde klant-omgeving (PD Exp), kies voor ‘next’.
Een samenvatting wordt nu getoond, kies voor ‘create subscription and generate secret’.
Je ontvangt de subscriptionID en Secret, bewaar dit als je de webhook-berichten wilt authenticeren.
De configuratie is gereed, Raet moet de gedane configuratie accorderen, om de doorlooptijd te verkorten kan je een bericht sturen naar de consultant met de vraag dit te doen.
Je hebt nu vanuit je applicatie een:
ClientID
Secret
TenantID
Webhook subscriptionID
Webhook secret
Een webhook-bericht wordt verstuurd na een gedane mutatie in Youforce. Deze mutaties kan je zelf niet invoeren, maak hiervoor een afspraak met de Raet consultant. De Raet consultant voert de gewenste mutaties in zodat je de berichten ontvangt. In overleg wordt in Youforce de data aangepast die leidt tot het gewenste webhook-bericht.
Een voorbeeld, medewerker 205330 wordt gekoppeld aan een andere Organisatorische eenheid:
Wat leidt tot het volgende bericht, het bericht laat zien welke velden zijn aangepast.
Als je zelf nog geen Webhook url hebt, kan je een url genereren via https://webhook.site/
De url die je dient vast te leggen in je Visma Developer portal-applicatie zou dan vanuit bovenstaand voorbeeld zijn:
https://webhook.site/06841b60-6fe7-419f-a1c8-39b4fff88c9e
Deze url is dan wel maar beperkte tijd geldig, maar je kan hem altijd weer vernieuwen.
Volledig artikel weergeven