La API Notiondesk te permite publicar tus ediciones de Notion en el momento en que estén listas: sincroniza un centro de ayuda completo, una colección o un artículo, desde un script, una canalización de CI o tu propia herramienta. También puedes activar o desactivar la sincronización programada. Tu contenido permanece en Notion; la sincronización lo vuelve a leer y publica los cambios.
| Método | Camino | Alcance | Hace |
|---|---|---|---|
POST | /sites/{site_id}/sync | sync | Sincroniza todo el centro de ayuda |
POST | /sites/{site_id}/categories/{category_id}/sync | sync | Sincroniza una colección y sus artículos. |
POST | /sites/{site_id}/articles/{article_id}/sync | sync | Sincroniza un artículo |
PATCH | /sites/{site_id}/settings/auto-sync | sync | Activa o desactiva la sincronización programada. |
¿Eres nuevo en la sincronización? Primero, lee Cómo sincronizar tu centro de ayuda con Notion .
Sincroniza todo un centro de ayuda
Notiondesk lee todos los artículos y colecciones de Notion nuevamente y publica los cambios. La ruta responde a 204 No Content tan pronto como se pone en cola la sincronización, y la sincronización se ejecuta en segundo plano.
Solo se ejecuta una sincronización del sitio a la vez. Mientras se ejecuta o se pone en cola una sincronización del centro de ayuda, ya sea programada, iniciada desde el panel de control o a través de la API, otro activador responde con el código 409 conflict_error. Espere unos minutos y vuelva a intentarlo.
El contenido que no ha cambiado desde su última sincronización no se vuelve a traducir.
Sincronizar una colección
Utilice la colección id de la lista de colecciones . Notiondesk vuelve a leer la colección y cada uno de sus artículos desde Notion, y luego publica solo los artículos editados desde su última sincronización. Los artículos sin cambios no se traducen ni se facturan de nuevo.
Sincronizar un artículo
Utilice el id del artículo de la lista de artículos .
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"En qué se diferencian las sincronizaciones de colecciones y artículos de la sincronización de un sitio web.
| Sincronización del sitio | Sincronización de colecciones o artículos | |
|---|---|---|
| Lecturas de Notion | Cada artículo y colección | Una colección y sus artículos, o un artículo |
| Mientras se ejecuta otra sincronización del mismo elemento | Respuestas 409 __PRESERVADO_45__ | Se pone en cola otra sincronización. Nunca responde conflict_error |
| Limitado por | Una sincronización a la vez | El presupuesto de escritura de su clave es de 20 solicitudes por minuto. |
Cada sincronización completa actualiza todo el centro de ayuda. Sincroniza una vez después de cada edición en Notion, no con un temporizador. Para actualizaciones periódicas, usa la sincronización programada.
Confirmar una sincronización
Un disparador de sincronización responde a 204 cuando la sincronización se pone en cola, no cuando finaliza. Las sincronizaciones iniciadas a través de la API no aparecen en el estado de sincronización , que solo muestra las ejecuciones programadas.
Para confirmar la sincronización, lea el contenido que publica:
- Activa la sincronización y anota la hora.
- Lee el artículo editado con
GET /sites/{site_id}/articles/{article_id}cada 30 segundos.
- Detente cuando
last_updatedsea posterior a la hora que anotaste, o cuandotextmuestre tu edición.
- Si
sync_failedestrue,sync_error_codeexplica el motivo. Corrige el artículo en Notion y vuelve a sincronizar.
Activar o desactivar la sincronización programada
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}'| Campo | Tipo | Notas |
|---|---|---|
auto_sync_enabled | booleano | Si Notiondesk se sincroniza con Notion según un cronograma |
La ruta responde a 204 No Content. Lea el nuevo estado en auto_sync_enabled del centro de ayuda y el horario en su estado de sincronización.
- Envía los valores booleanos JSON
trueofalse. Los valores0y"false"se leen comotrue.
- La frecuencia de sincronización no se puede cambiar a través de la API: al enviar
auto_sync_frequencyse obtiene el código 400validation_error. Cámbiela en el panel de control.
- Tu plan debe incluir la sincronización programada.
- Al activar la sincronización programada, las sincronizaciones desatendidas inician la traducción facturada mientras la traducción automática está activada.
Esta ruta necesita el ámbito sync, no write, porque decide cuándo se ejecutan las sincronizaciones desatendidas.
Errores
| Estado | Cuando | code |
|---|---|---|
| 400 | Sincronización automática únicamente: el cuerpo contiene un campo desconocido, incluido auto_sync_frequency. | validation_error |
| 403 | La clave carece del ámbito sync | insufficient_scope |
| 403 | El centro de ayuda está deshabilitado, su plan no incluye la sincronización programada o el creador de la clave no puede sincronizar este centro de ayuda. | permission_denied |
| 404 | El centro de ayuda, la colección o el artículo no existen en tu espacio de trabajo. | not_found |
| 409 | Sincronización del sitio únicamente: ya hay una sincronización del centro de ayuda en cola o en ejecución. | conflict_error |
| 409 | Todavía se está procesando una solicitud con el mismo Idempotency-Key. | request_in_progress |
conflict_error y request_in_progress son errores diferentes con el mismo estado: bifurcación en code. Consulte Manejo de errores de API, límites de velocidad y reintentos de Notiondesk .
Preguntas frecuentes
¿Es seguro volver a intentar activar un disparador de sincronización?
Sí, con un Idempotency-Key. Un reintento con la misma clave responde a 204 con X-Idempotent-Replay: true y no pone nada en cola, incluso mientras la primera sincronización todavía se está ejecutando.
¿Cómo sé cuándo ha finalizado una sincronización?
Lee el artículo o la colección sincronizada hasta que last_updated sea posterior a tu activador, o hasta que text muestre tu edición. No te fíes solo de sync_in_progress: puede permanecer en false durante unos segundos después del activador, antes de que comience la sincronización en cola. Las sincronizaciones activadas por la API no aparecen en el estado de sincronización.
¿Debo sincronizar un solo artículo o todo el centro de ayuda?
Sincroniza un artículo después de editarlo y una colección después de editar varios artículos en ella. Sincroniza todo el centro de ayuda después de realizar cambios importantes, como mover artículos entre colecciones.
¿Puedo sincronizar desde GitHub Actions?
Sí. Almacene la clave como un secreto de repositorio y llame a la ruta de sincronización del sitio en un paso del flujo de trabajo. Consulte Automatizar tareas comunes del centro de ayuda con la API Notiondesk .