Vernieuwingshooks
Geplande uitgaande webhooks die worden geactiveerd wanneer een dataset ververst. Tot ze beschikbaar zijn, poll de datasetmetadata of archieflijst om wijzigingen te detecteren.
Vernieuwingshooks
Gepland — vernieuwingswebhooks zijn nog niet beschikbaar. Vandaag, poll voor wijzigingen met de onderstaande methoden; abonneer je op updates via de geplande interface wanneer deze beschikbaar komt.
Datasets worden op een gepubliceerde frequentie ververst (zie metadata.accrualPeriodicity op Haal een dataset op). Vernieuwingshooks laten Topolab jouw service op de hoogte stellen op het moment dat een dataset verandert, in plaats van dat jij ervoor moet poll.
Detecteer vandaag wijzigingen (GA)
Beide onderstaande methoden zijn openbaar en kosten geen credits.
Bekijk metadata.modified
Poll het datasetrecord en vergelijk metadata.modified met de waarde die je laatst hebt gezien. Wanneer deze vooruitgaat, is de dataset ververst.
curl "https://api.topolab.nl/v1/dataset/nl-domino-poi" \
| jq '.metadata.modified'
"2026-05-01"
Poll niet vaker dan de frequentie van de dataset — een maandelijkse dataset heeft hooguit een dagelijkse controle nodig. Dit respecteert de snelheidslimieten en voorkomt verspilde verzoeken.
Bekijk de archieflijst
GET /v1/dataset/:table/archives/list retourneert de behouden maandelijkse snapshots. Een nieuwe maand die verschijnt betekent dat er een nieuwe vernieuwing heeft plaatsgevonden.
curl "https://api.topolab.nl/v1/dataset/nl-domino-poi/archives/list" \
| jq '.months[0]'
"2026-05"
Om precies te berekenen wat er is veranderd tussen twee vernieuwingen, download je beide archiefmaanden en vergelijk je ze — zie Bestanden downloaden (archiefdownloads vereisen de ARCHIVED_DATA add-on en kosten elk 20 credits).
De geplande interface
Wanneer de vernieuwingshooks beschikbaar komen, registreer je een HTTPS-eindpunt en Topolab zal POST een wijzigingsset naar dit eindpunt bij elke datasetvernieuwing. De ontworpen payload beschrijft welke records zijn toegevoegd, bijgewerkt en verwijderd:
{
"event": "dataset.refreshed",
"table": "nl-domino-poi",
"refreshedAt": "2026-06-01T02:14:00Z",
"previousModified": "2026-05-01",
"modified": "2026-06-01",
"changeSet": {
"added": ["NL-0512", "NL-0513"],
"updated": ["NL-0142", "NL-0317"],
"removed": ["NL-0099"]
}
}
De identificatoren in added, updated, en removed verwijzen naar de primaire sleutel van de dataset (voor nl-domino-poi, het store_id veld). Een consument kan dan alleen de gewijzigde records ophalen in plaats van de volledige export opnieuw te downloaden.
Deze structuur is het huidige ontwerp en kan veranderen voor de release. Leveringssemantiek, ondertekening en herhaalgedrag zullen dezelfde conventies volgen als andere Topolab-webhooks; zie Webhook-evenementen voor het platformbrede model.
Status
| Functionaliteit | Status |
|---|---|
Poll metadata.modified |
GA |
Poll archives/list |
GA |
Uitgaande dataset.refreshed webhook |
Gepland |
Wil je op de hoogte worden gesteld wanneer de vernieuwingshooks beschikbaar komen, of heb je input over het ontwerp? Neem contact met ons op.
Volgende
- Haal een dataset op — het
metadata.modifiedveld. - Bestanden downloaden — archiefmaanden voor diffing.
- Webhook-evenementen — het geplande webhook-platform.
Dit endpoint is ontworpen maar nog niet beschikbaar. Documentatie loopt vooruit op de implementatie.