Nyttelaststruktur

Forstå JSON-nyttelaststrukturen som sendes av webhooks og integrasjoner.

Grunnleggende nyttelast

Alle webhook-nyttelaster inneholder disse grunnleggende feltene. Bok-, økt- og bokhylleobjekter inkluderes avhengig av hendelsestypen.

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

eventTypeHendelsestypen som utløste dette varselet (f.eks. session.completed)

timestampISO 8601-tidsstempel for når hendelsen inntraff

metadataValgfrie tilleggsdata (for øyeblikket null, reservert for fremtidig bruk)

Bokobjekt

Inkluderes ved bokrelaterte hendelser og økthendelser. Inneholder bokinformasjon.

{
  "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 boken (UUID)
`title`	string	Boktittelen
`authors`	string[]	Matrise med forfatternavn
`pages`	number	Totalt antall sider i boken
`currentPage`	number	Gjeldende leseposisjon (sidenummer)
`status`	string	Lesestatus (to_read, reading, finished, abandoned)
`isbn`	string?	ISBN-nummer hvis tilgjengelig (valgfri)
`progressPercentage`	number	Lesefremdrift i prosent (0–100)

Øktobjekt

Inkluderes ved økthendelser. Inneholder informasjon om leseøkten.

{
  "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 økten (UUID)
`startedAt`	string	ISO 8601-tidsstempel for øktstart
`endedAt`	string?	ISO 8601-tidsstempel for økt slutt (null hvis aktiv)
`status`	string	Øktstatus (active, paused, completed)
`durationMinutes`	number	Øktens varighet i minutter
`pagesRead`	number	Antall sider lest i denne økten

Bokhylleobjekt

Inkluderes ved bokhyllerelaterte hendelser. Inneholder bokhylleinformasjon.

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

Felt	Type	Beskrivelse
`id`	string	Unik identifikator for bokhyllen (UUID)
`name`	string	Bokhyllens navn
`icon`	string?	SF Symbol-navn for bokhylleikonet (valgfri)
`bookCount`	number	Antall bøker i denne bokhyllen

Statusverdier

Bokstatus

to_readreadingfinishedabandoned

Øktstatus

activepausedcompleted

Tilbake til webhooks