Payload-structuur

Begrijp de JSON-payload-structuur die via Webhooks en integraties wordt verzonden.

Basispayload

Elke Webhook-payload bevat deze basisvelden. De boek-, sessie- en boekenplankobjecten worden opgenomen op basis van het evenementstype.

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

eventTypeHet evenementstype dat deze melding heeft geactiveerd (bijv. session.completed)

timestampISO 8601-tijdstempel van het moment waarop het evenement plaatsvond

metadataOptionele aanvullende gegevens (momenteel null, gereserveerd voor toekomstig gebruik)

Boekobject

Opgenomen bij boekgerelateerde evenementen en sessie-evenementen. Bevat boekinformatie.

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

Veld	Type	Beschrijving
`id`	string	Unieke identificator van het boek (UUID)
`title`	string	Titel van het boek
`authors`	string[]	Array van auteurnamen
`pages`	number	Totaal aantal pagina's in het boek
`currentPage`	number	Huidige leespositie (paginanummer)
`status`	string	Leesstatus (to_read, reading, finished, abandoned)
`isbn`	string?	ISBN-nummer indien beschikbaar (optioneel)
`progressPercentage`	number	Leesvoortgang (0-100)

Sessieobject

Opgenomen bij sessie-evenementen. Bevat informatie over de leessessie.

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

Veld	Type	Beschrijving
`id`	string	Unieke identificator van de sessie (UUID)
`startedAt`	string	ISO 8601-tijdstempel bij het starten van de sessie
`endedAt`	string?	ISO 8601-tijdstempel bij het beëindigen van de sessie (null indien actief)
`status`	string	Sessiestatus (active, paused, completed)
`durationMinutes`	number	Sessieduur in minuten
`pagesRead`	number	Aantal pagina's gelezen tijdens deze sessie

Boekenplankobject

Opgenomen bij boekenplankgerelateerde evenementen. Bevat informatie over de boekenplank.

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

Veld	Type	Beschrijving
`id`	string	Unieke identificator van de boekenplank (UUID)
`name`	string	Naam van de boekenplank
`icon`	string?	SF Symbol-naam van het boekenplankpictogram (optioneel)
`bookCount`	number	Aantal boeken op deze boekenplank

Statuswaarden

Boekstatus

to_readreadingfinishedabandoned

Sessiestatus

activepausedcompleted

Terug naar Webhooks