ds_wm_webhook_subscriptie

Operatie voor het beheren en inzien van webhook subscripties.
Een subscriptie kan veilig zonder wijzigingen ingezien worden met een request zonder parameters voor dataservice operaties.

Parameters

Attribuut	Type	Verplicht	Omschrijving
url	xsd:string(255)	O	URL endpoint om webhook requests naar te sturen over HTTPS. Alle subscripties worden opgehaald wanneer deze parameter niet of leeg is meegegeven.
medewerker	xsd:int	O	Registratienummer (idnr) van de medewerker.
stuurtestwebhook	xsd:boolean	O	Indicator of het sturen van een test webhook met voorbeeld events voor de meegestuurde url gewenst is. Standaard true.
eventtypes	array	O	Beschikbare event types om aan of uit te zetten. Klik hier voor meer info... ds_fw_apg_inkomstenverhouding ds_fw_arbeidscontract ds_fw_factuurgegevens ds_fw_fases ds_fw_inkomstenverhoudingen ds_fw_jaaropgavegegevens ds_fw_loonkostenvoordeel ds_fw_loonopgave ds_fw_loonspecificatiegegevens ds_fw_opleidingen ds_fw_persoonsgegevens_all ds_fw_profielfoto ds_fw_reserveringen ds_fw_tijdvoortijd_plaatsing ds_fw_timecards ds_fw_vaste_beloningen ds_fw_werkervaringen ds_fw_wwpremie ds_rf_declaraties_all ds_rf_documentgegevens ds_rf_loon_tarieven ds_rf_sollicitaties ds_rf_uitsluitingen ds_rl_aanvragen ds_rl_bedrijfsgegevens ds_rl_contactpersonen ds_rl_factuurgegevens ds_rl_ilb_functies_beroepsgroepen ds_rl_journaalposten ds_rl_kostenplaatsen ds_rl_loonschemas ds_rl_meld_werkadressen ds_rl_plaatsingen ds_rl_reserveringsschemas ds_rl_sectoren ds_rl_tariefschemas ds_wm_administratie ds_wm_businessunits ds_wm_document_folders ds_wm_document_types ds_wm_eigenaarsrechten ds_wm_financiele_administratie ds_wm_ilb_inleners ds_wm_ilb_versie ds_wm_inlenersbeloningen ds_wm_locaties ds_wm_loonbelasting ds_wm_looncomponenten ds_wm_loonjaren ds_wm_loonschemas ds_wm_medewerkers ds_wm_notificaties ds_wm_rekeningschema ds_wm_reserveringsschemas ds_wm_sectoren ds_wm_tariefschema_artiest ds_wm_tariefschemas ds_wm_vertalingen ds_wr_loonschema_spec ds_wr_tariefschema_spec Indien de parameter url is meegegeven, kan de status van event types worden aangepast met webhook_sub_status (standaard false). Als de status false is, dan worden er geen events gegenereerd voor dit event type. Voor de inrichting van een nieuwe subscriptie, moet er minstens 1 event type met webhook_sub_status true zijn. Een subscriptie wordt uitgezet, als alle event types op false worden gezet. De status van event types die niet zijn meegegeven, zullen niet veranderen.
webhook_sub_eventtype	xsd:string	V	Naam van een dataservice operatie.
webhook_sub_status	xsd:boolean	V	Indicator of het genereren van events voor wijzigingen, die voor de dataservice operatie zichtbaar zijn, gewenst is.
stopsubscriptie	xsd:boolean	O	Indicator of het stoppen van de subscriptie, van de meegestuurde url, gewenst is. Standaard false. Indien true, dan wordt webhook_sub_status voor alle event types op false gezet.
versie	xsd:string(40)	O	Vrij op te nemen tekst t.b.v. ontwikkelaar.

Fields

Attribuut	Type	Omschrijving
wm_whsub_url	xsd:string	De URL waar webhooks voor deze subscriptie naartoe gestuurd worden.
wm_whsub_eventtypes	array	Reeks van event types van de subscriptie. De status die wordt getoond, betreft de status na de verwerking van de huidige aanroep.
webhook_sub_eventtype	xsd:string	Naam van een dataservice operatie.
webhook_sub_status	xsd:boolean	Indicator of het genereren van events voor wijzigingen, die voor de dataservice operatie zichtbaar zijn, gewenst is.
wm_whsub_test_webhook_result	xsd:boolean	Indicator of het versturen van een test webhook naar de gegeven URL succesvol is.

Exceptions

Code	Detail	Omschrijving
39043	eventtypes - webhook_sub_eventtype	Webhook_sub_eventtype moet de naam zijn van een dataservice operatie die voor webhooks ondersteund zijn.
39043	parameter combinatie ongeldig voor nieuwe subscriptie	Voor het aanmaken van een nieuwe subscriptie dient minstens 1 event type met true meegestuurd te worden.
39043	parameter combinatie ongeldig voor stoppen subscriptie	De parameter stopsubscriptie mag niet op true staan als er eventtypes worden meegestuurd of als er geen url parameter is meegestuurd.
39043	url ongeldig	Deze url mag niet worden gebruikt, omdat deze url al in gebruik is door een andere partij.
39043	het limiet aan subscripties is bereikt	Zelfverklarend.