Structure du payload

Comprenez la structure du payload JSON envoyé par les Webhooks et les intégrations.

Payload de base

Tous les payloads Webhook contiennent ces champs de base. Les objets livre, session et étagère sont inclus selon le type d'événement.

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

eventTypeLe type d'événement qui a déclenché cette notification (ex : session.completed)

timestampHorodatage ISO 8601 du moment où l'événement s'est produit

metadataDonnées supplémentaires optionnelles (actuellement null, réservé pour un usage futur)

Objet livre

Inclus dans les événements liés aux livres et dans les événements de session. Contient les informations du livre.

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

Champ	Type	Description
`id`	string	Identifiant unique du livre (UUID)
`title`	string	Titre du livre
`authors`	string[]	Tableau des noms d'auteurs
`pages`	number	Nombre total de pages du livre
`currentPage`	number	Position de lecture actuelle (numéro de page)
`status`	string	Statut de lecture (to_read, reading, finished, abandoned)
`isbn`	string?	Numéro ISBN si disponible (optionnel)
`progressPercentage`	number	Progression de lecture en pourcentage (0-100)

Objet session

Inclus dans les événements de session. Contient les informations de la session de lecture.

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

Champ	Type	Description
`id`	string	Identifiant unique de la session (UUID)
`startedAt`	string	Horodatage ISO 8601 du début de la session
`endedAt`	string?	Horodatage ISO 8601 de la fin de la session (null si active)
`status`	string	Statut de la session (active, paused, completed)
`durationMinutes`	number	Durée de la session en minutes
`pagesRead`	number	Nombre de pages lues durant cette session

Objet étagère

Inclus dans les événements liés aux étagères. Contient les informations de l'étagère.

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

Champ	Type	Description
`id`	string	Identifiant unique de l'étagère (UUID)
`name`	string	Nom de l'étagère
`icon`	string?	Nom SF Symbol de l'icône de l'étagère (optionnel)
`bookCount`	number	Nombre de livres dans cette étagère

Valeurs de statut

Statut du livre

to_readreadingfinishedabandoned

Statut de la session

activepausedcompleted

Retour aux Webhooks