API Webhook

Met de API webhook is het mogelijk om notificaties te ontvangen op een eigen URL zodra een object wordt gewijzigd binnen OnlineAfspraken. Op moment van schrijven zijn de te ontvangen notificaties mogelijk voor: Afspraken, Consumenten

Om gebruik te maken van de webhook moet dit per account worden ingeschakeld. Ga in de OnlineAfspraken backend naar instellingen -> extra functionaliteiten -> API gegevens. Op dit scherm kun je de webhook inschakelen en aangeven voor welke objecten je notificaties wil ontvangen.

Zodra een object van dit type wijzigt ( aanmaken, bewerken, verwijderen ) wordt jouw eigen URL geopend met een aantal anonieme gegevens. Je kunt hierna het object zelf opnieuw ophalen over de API via de beveiligde API methodiek.

Let op: jouw eigen URL moet extern te openen zijn. Eventueel is het mogelijk om onze webserver te whitelisten maar dit is een proces wat niet via OA verloopt.

Het enige wat verwacht wordt van de webhook URL is een status 200 code binnen 10 seconden. Indien dit niet lukt, om technische redenen zoals een tijdelijke storing, wordt de push nogmaals geprobeerd na 5 minutes, en daarna na een uur. Een push vindt slechts eenmaal plaats tot succes of tot 3 pogingen.

De webhook URL wordt aangeroepen met de volgende GET parameters:

- entity ( het type object, zoals appointment of consumer )

- id ( id van het object )

- apiKey ( api key van het account. Bij meerdere accounts in bijv. een eigen OA subdomein is het hiermee mogelijk om onderscheid te maken binnen accounts op hetzelfde webhook URL )