Notifications API

De Notifications API implementeert het transactiepatroon voor het abonneren op wijzigingen in gegevens binnen het Edu-V Afsprakenstelsel. Hiermee kunnen systemen notificaties ontvangen over nieuwe, gewijzigde of verwijderde data-objecten.

Status: Beta — Implementation Draft (v0.9.1). Zie de EDU-V documentatie voor Notifications API.

Rol van de leverancier

Als leverancier ben je zowel producer (voor cataloguswijzigingen) als consumer (voor wijzigingen van andere partijen). Je kunt notificaties versturen wanneer producten in je catalogus wijzigen, en je kunt je abonneren op notificaties van bijv. de Aanspraakmanager.

Scope: eduv.notification

Het Notification-model

Name
id
Type
string (uuid)
Description
Unieke identifier van de notificatie.
Name
notificationType
Type
enum
Description
Type: object (enkel object) of bulk (meerdere objecten).
Name
objectType
Type
enum
Description
Type object: Product, ProductInfo, Course, Organisation, Student, Employee, Group, Enrollment, Assignment, etc.
Name
objectId
Type
string
Description
Identifier van het gewijzigde object.
Name
school
Type
object
Description
Onderwijsorganisatie (vereist voor onderwijs/leerling/medewerker-data).
Name
created
Type
datetime
Description
Tijdstempel van de wijziging.
Name
url
Type
string
Description
Endpoint waar het volledige object opgehaald kan worden.
Name
isDeleteNotification
Type
boolean
Description
Geeft aan dat het object is verwijderd.

POST/edu-v/v1/notifications-api/subscriptions

Abonneren op notificaties

Registreer een abonnement op wijzigingen voor een bepaald objecttype bij een producer.

Request

POST

/edu-v/v1/notifications-api/subscriptions

{
    "objectType": "Product",
    "callbackUrl": "https://api.wimpel.nl/edu-v/v1/notifications-api/receive"
}

POST/edu-v/v1/notifications-api/receive

Notificaties ontvangen

Dit endpoint ontvangt notificaties van producers. Na ontvangst kan het gewijzigde object worden opgehaald via de meegeleverde url.

Request

POST

/edu-v/v1/notifications-api/receive

{
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "notificationType": "object",
    "objectType": "Product",
    "objectId": "9789464421408",
    "created": "2026-03-16T10:30:00.000Z",
    "url": "https://api.leverancier.nl/edu-v/v2/catalogue-api/products/9789464421408",
    "isDeleteNotification": false
}