Nutzlaststruktur

Verstehe die JSON-Nutzlaststruktur, die von Webhooks und Integrationen gesendet wird.

Basis-Nutzlast

Alle Webhook-Nutzlasten enthalten diese Basisfelder. Buch-, Sitzungs- und Regalobjekte werden je nach Ereignistyp eingeschlossen.

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

eventTypeDer Ereignistyp, der diese Benachrichtigung ausgelöst hat (z. B. session.completed)

timestampISO-8601-Zeitstempel des Zeitpunkts, zu dem das Ereignis eingetreten ist

metadataOptionale zusätzliche Daten (derzeit null, für zukünftige Verwendung reserviert)

Buchobjekt

Enthalten bei buchbezogenen Ereignissen und Sitzungsereignissen. Enthält Buchinformationen.

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

Feld	Typ	Beschreibung
`id`	string	Eindeutige Kennung des Buches (UUID)
`title`	string	Titel des Buches
`authors`	string[]	Array von Autorennamen
`pages`	number	Gesamtanzahl der Seiten des Buches
`currentPage`	number	Aktuelle Leseposition (Seitenzahl)
`status`	string	Lesestatus (to_read, reading, finished, abandoned)
`isbn`	string?	ISBN-Nummer, falls verfügbar (optional)
`progressPercentage`	number	Lesefortschritt in Prozent (0-100)

Sitzungsobjekt

Enthalten bei Sitzungsereignissen. Enthält Informationen zur Lesesitzung.

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

Feld	Typ	Beschreibung
`id`	string	Eindeutige Kennung der Sitzung (UUID)
`startedAt`	string	ISO-8601-Zeitstempel des Sitzungsstarts
`endedAt`	string?	ISO-8601-Zeitstempel des Sitzungsendes (null, wenn aktiv)
`status`	string	Sitzungsstatus (active, paused, completed)
`durationMinutes`	number	Sitzungsdauer in Minuten
`pagesRead`	number	Anzahl der in dieser Sitzung gelesenen Seiten

Regalobjekt

Enthalten bei regalbezogenen Ereignissen. Enthält Regalinformationen.

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

Feld	Typ	Beschreibung
`id`	string	Eindeutige Kennung des Regals (UUID)
`name`	string	Name des Regals
`icon`	string?	SF-Symbol-Name des Regal-Icons (optional)
`bookCount`	number	Anzahl der Bücher in diesem Regal

Statuswerte

Buchstatus

to_readreadingfinishedabandoned

Sitzungsstatus

activepausedcompleted

Zurück zu Webhooks