Nyttelaststruktur

Forstå strukturen af JSON-nyttelaster sendt via Webhooks og integrationer.

Grundlæggende nyttelast

Alle Webhook-nyttelaster indeholder disse grundlæggende felter. Bog-, sessions- og hylde-objekter medtages afhængigt af begivenhedstypen.

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

eventTypeBegivenhedstypen der udløste denne notifikation (f.eks. session.completed)

timestampISO 8601-tidsstempel for hvornår begivenheden skete

metadataValgfrie yderligere data (i øjeblikket null, reserveret til fremtidig brug)

Bog-objekt

Medtages ved bogrelaterede begivenheder og sessionsbegivenheder. Indeholder boginformation.

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

Felt	Type	Beskrivelse
`id`	string	Unik identifikator for bogen (UUID)
`title`	string	Bogens titel
`authors`	string[]	Array af forfatternes navne
`pages`	number	Bogens samlede antal sider
`currentPage`	number	Nuværende læseposition (sidetal)
`status`	string	Læsestatus (to_read, reading, finished, abandoned)
`isbn`	string?	ISBN-nummer hvis tilgængeligt (valgfri)
`progressPercentage`	number	Læsefremgang i procent (0-100)

Sessions-objekt

Medtages ved sessionsbegivenheder. Indeholder information om læsesessionen.

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

Felt	Type	Beskrivelse
`id`	string	Unik identifikator for sessionen (UUID)
`startedAt`	string	ISO 8601-tidsstempel for sessionens start
`endedAt`	string?	ISO 8601-tidsstempel for sessionens afslutning (null hvis aktiv)
`status`	string	Sessionsstatus (active, paused, completed)
`durationMinutes`	number	Sessionens varighed i minutter
`pagesRead`	number	Antal sider læst i denne session

Hylde-objekt

Medtages ved hylde-relaterede begivenheder. Indeholder hylde-information.

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

Felt	Type	Beskrivelse
`id`	string	Unik identifikator for boghylden (UUID)
`name`	string	Boghyldens navn
`icon`	string?	SF Symbol-navn for boghyldens ikon (valgfri)
`bookCount`	number	Antal bøger på denne boghylde

Statusværdier

Bogstatus

to_readreadingfinishedabandoned

Sessionsstatus

activepausedcompleted

Tilbage til Webhooks