Mit der Notiondesk API können Sie Ihre Notion-Änderungen sofort veröffentlichen: Synchronisieren Sie ein komplettes Hilfecenter, eine Sammlung oder einen einzelnen Artikel – per Skript, CI-Pipeline oder Ihrem eigenen Tool. Sie können die geplante Synchronisierung auch aktivieren oder deaktivieren. Ihre Inhalte bleiben in Notion erhalten; bei einer Synchronisierung werden sie erneut gelesen und die Änderungen veröffentlicht.
| Verfahren | Weg | Umfang | Tut |
|---|---|---|---|
POST | /sites/{site_id}/sync | sync | Synchronisiert das gesamte Hilfezentrum |
POST | /sites/{site_id}/categories/{category_id}/sync | sync | Synchronisiert eine Sammlung und ihre Artikel |
POST | /sites/{site_id}/articles/{article_id}/sync | sync | Synchronisiert einen Artikel |
PATCH | /sites/{site_id}/settings/auto-sync | sync | Schaltet die geplante Synchronisierung ein oder aus |
Sie haben noch keine Erfahrung mit der Synchronisierung? Lesen Sie zuerst , wie Sie Ihr Hilfezentrum mit Notion synchronisieren .
Synchronisieren Sie ein ganzes Hilfezentrum
Notiondesk liest alle Artikel und Sammlungen von Notion erneut und veröffentlicht die Änderungen. Die Route antwortet mit 204 No Content, sobald die Synchronisierung in die Warteschlange gestellt wird, und die Synchronisierung läuft im Hintergrund.
Es wird immer nur eine Website-Synchronisierung gleichzeitig ausgeführt. Während die Synchronisierung des Hilfecenters in der Warteschlange steht oder läuft (unabhängig davon, ob sie geplant, über das Dashboard oder die API gestartet wurde), antwortet ein anderer Trigger mit dem Fehlercode 409 conflict_error. Warten Sie einige Minuten und versuchen Sie es erneut.
Inhalte, die sich seit der letzten Synchronisierung nicht geändert haben, werden nicht erneut übersetzt.
Eine Sammlung synchronisieren
Verwenden Sie die id-Kennung der Sammlung aus der Sammlungsliste . Notiondesk liest die Sammlung und alle darin enthaltenen Artikel erneut aus Notion ein und veröffentlicht anschließend nur die Artikel, die seit der letzten Synchronisierung bearbeitet wurden. Unveränderte Artikel werden nicht erneut übersetzt oder abgerechnet.
Einen Artikel synchronisieren
Verwenden Sie den Artikel mit der ID id aus der Artikelliste .
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"Wie sich die Synchronisierung von Sammlungen und Artikeln von einer Website-Synchronisierung unterscheidet
| Website-Synchronisierung | Sammlungs- oder Artikelsynchronisierung | |
|---|---|---|
| Liest aus Notion | Jeder Artikel und jede Sammlung | Eine Sammlung und ihre Artikel oder ein einzelner Artikel |
| Währenddessen läuft eine weitere Synchronisierung desselben Elements. | Antworten 409 __RESERVIERT_45__ | Es wird eine weitere Synchronisierung in die Warteschlange gestellt. Es antwortet nie. conflict_error |
| Beschränkt durch | Eine Synchronisierung nach der anderen | Ihr Schlüssel hat ein Schreibbudget von 20 Anfragen pro Minute. |
Nach jeder abgeschlossenen Synchronisierung wird das gesamte Hilfecenter aktualisiert. Starten Sie die Synchronisierung einmalig nach jeder Bearbeitung in Notion, nicht zeitgesteuert. Für regelmäßige Aktualisierungen verwenden Sie stattdessen die geplante Synchronisierung.
Synchronisierung bestätigen
Ein Synchronisierungstrigger antwortet mit 204, wenn die Synchronisierung in die Warteschlange gestellt wird, nicht nach deren Abschluss. Über die API gestartete Synchronisierungen werden nicht im Synchronisierungsstatus angezeigt, da dort nur geplante Ausführungen aufgelistet sind.
Um eine Synchronisierung zu bestätigen, lesen Sie die veröffentlichten Inhalte:
- Die Synchronisierung auslösen und die Uhrzeit notieren.
- Lesen Sie den bearbeiteten Artikel alle 30 Sekunden mit
GET /sites/{site_id}/articles/{article_id}.
- Stoppen Sie, wenn
last_updatednach dem von Ihnen notierten Zeitpunkt liegt odertextIhre Bearbeitung anzeigt.
- Wenn
sync_failedgleichtrueist, gibtsync_error_codeden Grund dafür an. Korrigieren Sie den Artikel in Notion und synchronisieren Sie ihn erneut.
Geplante Synchronisierung aktivieren oder deaktivieren
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}'| Feld | Typ | Anmerkungen |
|---|---|---|
auto_sync_enabled | boolescher Wert | Ob Notiondesk planmäßig mit Notion synchronisiert wird |
Die Route beantwortet 204 No Content. Lesen Sie den neuen Status in auto_sync_enabled des Hilfecenters und den Zeitplan in seinem Synchronisierungsstatus.
- Senden Sie die JSON-Booleschen Werte
trueoderfalse. Die Werte0und"false"werden alstrueinterpretiert.
- Die Synchronisierungsfrequenz kann nicht über die API geändert werden: Das Senden von
auto_sync_frequencyführt zu einer 400validation_error-Antwort. Ändern Sie sie im Dashboard.
- Ihr Plan muss eine geplante Synchronisierung beinhalten.
- Durch die Aktivierung der geplanten Synchronisierung können unbeaufsichtigte Synchronisierungen die kostenpflichtige Übersetzung starten, während die automatische Übersetzung aktiviert ist.
Diese Route benötigt den Bereich sync, nicht write, da sie festlegt, wann unbeaufsichtigte Synchronisierungen ausgeführt werden.
Fehler
| Status | Wann | code |
|---|---|---|
| 400 | Nur automatische Synchronisierung: Der Textkörper enthält ein unbekanntes Feld, einschließlich auto_sync_frequency | validation_error |
| 403 | Dem Schlüssel fehlt der Gültigkeitsbereich sync. | insufficient_scope |
| 403 | Das Hilfecenter ist deaktiviert, Ihr Tarif beinhaltet keine geplante Synchronisierung oder der Ersteller des Schlüssels kann dieses Hilfecenter nicht synchronisieren. | permission_denied |
| 404 | Das Hilfecenter, die Sammlung oder der Artikel ist in Ihrem Arbeitsbereich nicht vorhanden. | not_found |
| 409 | Nur Website-Synchronisierung: Die Synchronisierung des Hilfecenters ist bereits in der Warteschlange oder wird gerade ausgeführt. | conflict_error |
| 409 | Eine Anfrage mit derselben Idempotency-Key wird noch bearbeitet | request_in_progress |
conflict_error und request_in_progress sind unterschiedliche Fehler mit demselben Status: Verzweigung bei code. Siehe „Behandlung von Notiondesk API-Fehlern, Ratenbegrenzungen und Wiederholungsversuchen“ .
Häufig gestellte Fragen
Ist es sicher, einen Synchronisierungstrigger erneut auszulösen?
Ja, mit einem Idempotency-Key. Ein Wiederholungsversuch mit demselben Schlüssel beantwortet 204 mit X-Idempotent-Replay: true und reiht nichts in die Warteschlange ein, obwohl die erste Synchronisierung noch läuft.
Woran erkenne ich, wann eine Synchronisierung abgeschlossen ist?
Lesen Sie den synchronisierten Artikel oder die Sammlung, bis last_updated nach Ihrem Auslöser liegt oder text Ihre Bearbeitung anzeigt. Verlassen Sie sich nicht allein auf sync_in_progress: Der Wert kann nach dem Auslöser noch einige Sekunden lang false betragen, bevor die geplante Synchronisierung startet. API-gesteuerte Synchronisierungen werden nicht im Synchronisierungsstatus angezeigt.
Soll ich einen einzelnen Artikel oder das gesamte Hilfezentrum synchronisieren?
Synchronisieren Sie einen Artikel nach dessen Bearbeitung und eine Sammlung nach der Bearbeitung mehrerer Artikel darin. Synchronisieren Sie das gesamte Hilfecenter nach größeren Änderungen, z. B. dem Verschieben von Artikeln zwischen Sammlungen.
Kann ich von GitHub Actions synchronisieren?
Ja. Speichern Sie den Schlüssel als Repository-Geheimnis und rufen Sie die Site-Synchronisierungsroute in einem Workflow-Schritt auf. Siehe Automatisieren gängiger Hilfecenter-Aufgaben mit der Notiondesk-API .