Struttura del payload

Comprendi la struttura del payload JSON inviato dai Webhook e dalle integrazioni.

Payload base

Tutti i payload Webhook includono questi campi base. Gli oggetti libro, sessione e scaffale sono inclusi in base al tipo di evento.

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

eventTypeIl tipo di evento che ha attivato questa notifica (es. session.completed)

timestampTimestamp ISO 8601 del momento in cui si è verificato l'evento

metadataDati aggiuntivi facoltativi (attualmente null, riservato per uso futuro)

Oggetto libro

Incluso negli eventi relativi ai libri e negli eventi di sessione. Contiene le informazioni sul 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	Descrizione
`id`	string	Identificatore univoco del libro (UUID)
`title`	string	Titolo del libro
`authors`	string[]	Array dei nomi degli autori
`pages`	number	Numero totale di pagine del libro
`currentPage`	number	Posizione corrente di lettura (numero di pagina)
`status`	string	Stato di lettura (to_read, reading, finished, abandoned)
`isbn`	string?	Numero ISBN se disponibile (opzionale)
`progressPercentage`	number	Percentuale di avanzamento della lettura (0-100)

Oggetto sessione

Incluso negli eventi di sessione. Contiene le informazioni sulla sessione di lettura.

{
  "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	Descrizione
`id`	string	Identificatore univoco della sessione (UUID)
`startedAt`	string	Timestamp ISO 8601 dell'inizio della sessione
`endedAt`	string?	Timestamp ISO 8601 della fine della sessione (null se attiva)
`status`	string	Stato della sessione (active, paused, completed)
`durationMinutes`	number	Durata della sessione in minuti
`pagesRead`	number	Numero di pagine lette durante questa sessione

Oggetto scaffale

Incluso negli eventi relativi agli scaffali. Contiene le informazioni sullo scaffale.

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

Campo	Tipo	Descrizione
`id`	string	Identificatore univoco dello scaffale (UUID)
`name`	string	Nome dello scaffale
`icon`	string?	Nome SF Symbol dell'icona dello scaffale (opzionale)
`bookCount`	number	Numero di libri presenti in questo scaffale

Valori di stato

Stato libro

to_readreadingfinishedabandoned

Stato sessione

activepausedcompleted

Torna ai Webhook