Estructura de Carga

Comprende la estructura de carga JSON enviada a webhooks e integraciones.

Carga Base

Cada carga de webhook incluye estos campos base. Los objetos de libro, sesión y estante se incluyen dependiendo del tipo de evento.

{
  "eventType": "session.completed",
  "timestamp": "2024-12-04T10:30:00Z",
  "book": { ... },
  "session": { ... },
  "shelf": null,
  "metadata": null
}

eventTypeEl tipo de evento que activó esta notificación (ej., session.completed)

timestampMarca de tiempo en formato ISO 8601 de cuándo ocurrió el evento

metadataDatos adicionales opcionales (actualmente null, reservado para uso futuro)

Objeto Libro

Incluido en eventos relacionados con libros y eventos de sesión. Contiene detalles sobre el libro.

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "title": "The Great Gatsby",
  "authors": ["F. Scott Fitzgerald"],
  "pages": 180,
  "currentPage": 180,
  "status": "finished",
  "isbn": "9780743273565",
  "progressPercentage": 100
}

Campo	Tipo	Descripción
`id`	string	Identificador único del libro (UUID)
`title`	string	El título del libro
`authors`	string[]	Array de nombres de autores
`pages`	number	Número total de páginas del libro
`currentPage`	number	Posición actual de lectura (número de página)
`status`	string	Estado de lectura (por_leer, leyendo, terminado, abandonado)
`isbn`	string?	Número ISBN si está disponible (opcional)
`progressPercentage`	number	Progreso de lectura como porcentaje (0-100)

Objeto Sesión

Incluido en eventos de sesión. Contiene detalles sobre la sesión de lectura.

{
  "id": "660e8400-e29b-41d4-a716-446655440001",
  "startedAt": "2024-12-04T10:05:00Z",
  "endedAt": "2024-12-04T10:30:00Z",
  "status": "completed",
  "durationMinutes": 25,
  "pagesRead": 42
}

Campo	Tipo	Descripción
`id`	string	Identificador único de la sesión (UUID)
`startedAt`	string	Marca de tiempo ISO 8601 cuando comenzó la sesión
`endedAt`	string?	Marca de tiempo ISO 8601 cuando terminó la sesión (null si está activa)
`status`	string	Estado de la sesión (activa, pausada, completada)
`durationMinutes`	number	Duración de la sesión en minutos
`pagesRead`	number	Número de páginas leídas durante esta sesión

Objeto Estante

Incluido en eventos relacionados con estantes. Contiene detalles sobre el estante.

{
  "id": "770e8400-e29b-41d4-a716-446655440002",
  "name": "Favorites",
  "icon": "star.fill",
  "bookCount": 12
}

Campo	Tipo	Descripción
`id`	string	Identificador único del estante (UUID)
`name`	string	Nombre del estante
`icon`	string?	Nombre de SF Symbol para el icono del estante (opcional)
`bookCount`	number	Número de libros en este estante

Valores de Estado

Estado del Libro

to_readreadingfinishedabandoned

Estado de la Sesión

activepausedcompleted

Volver a Webhooks