Met de Notiondesk API kunt u uw Notion-bewerkingen publiceren zodra ze klaar zijn: synchroniseer een volledig helpcentrum, een collectie of een artikel, vanuit een script, een CI-pipeline of uw eigen tool. U kunt geplande synchronisatie ook in- of uitschakelen. Uw content blijft in Notion; een synchronisatie leest deze opnieuw en publiceert de wijzigingen.
| Methode | Pad | Domein | Doet |
|---|---|---|---|
POST | /sites/{site_id}/sync | sync | Synchroniseert het volledige helpcentrum. |
POST | /sites/{site_id}/categories/{category_id}/sync | sync | Synchroniseert één collectie en de bijbehorende artikelen. |
POST | /sites/{site_id}/articles/{article_id}/sync | sync | Synchroniseert één artikel |
PATCH | /sites/{site_id}/settings/auto-sync | sync | Schakelt geplande synchronisatie in of uit. |
Nieuw met synchroniseren? Lees dan eerst Hoe u uw helpcentrum met Notion synchroniseert .
Synchroniseer een volledig helpcentrum
Notiondesk leest alle artikelen en collecties van Notion opnieuw en publiceert de wijzigingen. De route beantwoordt 204 No Content zodra de synchronisatie in de wachtrij staat, en de synchronisatie wordt op de achtergrond uitgevoerd.
Er wordt slechts één sitesynchronisatie tegelijk uitgevoerd. Terwijl een synchronisatie van het helpcentrum in de wachtrij staat of bezig is (ongeacht of deze is gepland, gestart vanuit het dashboard of via de API), geeft een andere trigger de foutmelding 409 conflict_error. Wacht een paar minuten en voer de trigger opnieuw uit.
Inhoud die sinds de laatste synchronisatie niet is gewijzigd, wordt niet opnieuw vertaald.
Synchroniseer één collectie
Gebruik de id van de collectie uit de collectielijst . Notiondesk leest de collectie en elk van de artikelen daarin opnieuw uit Notion en publiceert vervolgens alleen de artikelen die sinds de laatste synchronisatie zijn bewerkt. Onveranderde artikelen worden niet opnieuw vertaald of gefactureerd.
Synchroniseer één artikel
Gebruik het artikel id uit de artikellijst .
curl -i -X POST "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/sync" \
-H "Authorization: Bearer $NOTIONDESK_API_KEY" \
-H "nd-version: 2026-10-16" \
-H "Idempotency-Key: 9b2e4c1a-sync-after-notion-edit"curl -i -X POST "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/categories/1761493027/sync" \
-H "Authorization: Bearer $NOTIONDESK_API_KEY" \
-H "nd-version: 2026-10-16" \
-H "Idempotency-Key: 2c8e5b7d-sync-billing"curl -i -X POST "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/articles/1761580412/sync" \
-H "Authorization: Bearer $NOTIONDESK_API_KEY" \
-H "nd-version: 2026-10-16" \
-H "Idempotency-Key: 4d7a0f3e-sync-getting-started"Hoe het synchroniseren van collecties en artikelen verschilt van het synchroniseren van een hele site
| Site synchronisatie | Collectie- of artikelsynchronisatie | |
|---|---|---|
| Leest van Notion | Elk artikel en elke verzameling | Eén verzameling en de bijbehorende artikelen, of één artikel |
| Terwijl een andere synchronisatie van hetzelfde item wordt uitgevoerd | Antwoorden 409 __GERESERVEERD_45__ | Zet een nieuwe synchronisatie in de wachtrij. Het geeft nooit antwoord conflict_error |
| Beperkt door | Eén synchronisatie tegelijk | Het schrijfbudget van uw sleutel is 20 aanvragen per minuut. |
Elke voltooide synchronisatie vernieuwt het hele helpcentrum. Start een synchronisatie eenmaal na elke bewerking in Notion, niet op basis van een timer. Gebruik voor regelmatige updates de geplande synchronisatiefunctie.
Bevestig een synchronisatie
Een synchronisatietrigger geeft de foutmelding 204 wanneer de synchronisatie in de wachtrij wordt geplaatst, niet wanneer deze is voltooid. Synchronisaties die via de API worden gestart, verschijnen niet in de synchronisatiestatus , die alleen geplande uitvoeringen weergeeft.
Om een synchronisatie te bevestigen, lees je de inhoud die wordt gepubliceerd:
- Start de synchronisatie en noteer de tijd.
- Lees het bewerkte artikel met
GET /sites/{site_id}/articles/{article_id}elke 30 seconden.
- Stop wanneer
last_updatedlater is dan de tijd die je hebt genoteerd, of wanneertextje bewerking weergeeft.
- Als
sync_failedtrueis, geeftsync_error_codeaan waarom. Corrigeer het artikel in Notion en synchroniseer opnieuw.
Schakel geplande synchronisatie in of uit.
curl -i -X PATCH "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/settings/auto-sync" \
-H "Authorization: Bearer $NOTIONDESK_API_KEY" \
-H "nd-version: 2026-10-16" \
-H "Content-Type: application/json" \
-d '{"auto_sync_enabled": true}'| Veld | Type | Notities |
|---|---|---|
auto_sync_enabled | booleaans | Of Notiondesk volgens een schema synchroniseert vanuit Notion |
De route geeft antwoord 204 No Content. Lees de nieuwe status in auto_sync_enabled van het helpcentrum en de planning in de synchronisatiestatus.
- Verzend de JSON-booleans
trueoffalse. De waarden0en"false"worden gelezen alstrue.
- De synchronisatiefrequentie kan niet via de API worden gewijzigd: het verzenden van
auto_sync_frequencyresulteert in 400validation_error. Wijzig deze in het dashboard.
- Uw abonnement moet geplande synchronisatie omvatten.
- Door geplande synchronisatie in te schakelen, kunnen geautomatiseerde synchronisaties de gefactureerde vertaling starten terwijl automatische vertaling is ingeschakeld.
Deze route heeft de scope sync nodig, niet write, omdat deze bepaalt wanneer onbeheerde synchronisaties worden uitgevoerd.
Fouten
| Status | Wanneer | code |
|---|---|---|
| 400 | Alleen automatische synchronisatie: de inhoud bevat een onbekend veld, inclusief auto_sync_frequency | validation_error |
| 403 | De sleutel mist het bereik sync | insufficient_scope |
| 403 | Het helpcentrum is uitgeschakeld, uw abonnement omvat geen geplande synchronisatie of de maker van de sleutel kan dit helpcentrum niet synchroniseren. | permission_denied |
| 404 | Het helpcentrum, de collectie of het artikel bestaat niet in uw werkruimte. | not_found |
| 409 | Alleen sitesynchronisatie: er is al een synchronisatie van het helpcentrum in de wachtrij staan of deze is al bezig. | conflict_error |
| 409 | Een verzoek met dezelfde Idempotency-Key wordt nog steeds verwerkt. | request_in_progress |
conflict_error en request_in_progress zijn verschillende fouten met dezelfde status: vertakking op code. Zie API-fouten, snelheidslimieten en herhaalpogingen afhandelen voor Notiondesk .
Veelgestelde vragen
Is het veilig om een synchronisatietrigger opnieuw te proberen?
Ja, met een Idempotency-Key. Een nieuwe poging met dezelfde sleutel geeft als antwoord 204 een X-Idempotent-Replay: true en er wordt niets in de wachtrij geplaatst, zelfs terwijl de eerste synchronisatie nog steeds loopt.
Hoe weet ik wanneer een synchronisatie is voltooid?
Lees het gesynchroniseerde artikel of de gesynchroniseerde collectie totdat last_updated later is dan uw trigger, of totdat text uw bewerking weergeeft. Vertrouw niet alleen op sync_in_progress: deze kan enkele seconden na de trigger op false blijven staan, voordat de synchronisatie in de wachtrij start. API-getriggerde synchronisaties worden niet weergegeven in de synchronisatiestatus.
Moet ik één artikel synchroniseren of het hele helpcentrum?
Synchroniseer één artikel nadat u dat artikel hebt bewerkt, en één verzameling nadat u meerdere artikelen daarin hebt bewerkt. Synchroniseer het hele helpcentrum na grotere wijzigingen, zoals het verplaatsen van artikelen tussen verzamelingen.
Kan ik synchroniseren vanuit GitHub Actions?
Ja. Sla de sleutel op als een repository-geheim en roep de sitesynchronisatieroute aan in een workflowstap. Zie Veelvoorkomende helpcentrumtaken automatiseren met de Notiondesk API .