ReflexBlue Externe API V2 referentie: Webhooks API
Met de ReflexBlue Externe API V2 beheer je eenvoudig webhooks via een aantal eindpunten. Onderstaand vind je een compleet overzicht van de belangrijkste eindpunten waarmee je webhooks kan aanmaken, bijwerken, verwijderen en details kan opvragen.
Wil je meer technische details over deze API? Bekijk dan de Swagger documentatie.
Gedetailleerde informatie van één webhook opvragen
| HTTP-methode | Eindpunt |
|---|---|
| POST | /{administrationNumber}/api/external/v{version}/webhooks/{webhookId} |
Gebruik dit eindpunt om alle details van een specifieke webhook op te halen. Dit is handig als je de huidige instellingen van een webhook wilt inzien.
Nieuwe webhook aanmaken
| HTTP-methode | Eindpunt |
|---|---|
| POST | /{administrationNumber}/api/external/v{version}/webhooks |
Gebruik dit eindpunt om een nieuwe webhook toe te voegen. Dit is handig als je een applicatie wil laten reageren op specifieke gebeurtenissen binnen ReflexBlue.
Bestaande webhook bijwerken
| HTTP-methode | Eindpunt |
|---|---|
| PUT | /{administrationNumber}/api/external/v{version}/webhooks |
Gebruik dit eindpunt om de instellingen van een bestaande webhook aan te passen. Dit is bijvoorbeeld nodig als de URL of het type gebeurtenis moet veranderen.
Webhook verwijderen
| HTTP-methode | Eindpunt |
|---|---|
| DELETE | /{administrationNumber}/api/external/v{version}/webhooks/{webhookId} |
Gebruik dit eindpunt om een bestaande webhook te verwijderen wanneer deze niet langer nodig is.