Skip to main content

TaskProgressEvent

Task progress event for background operations

bookIdstring,null<uuid>nullable

Book ID if this task is related to a book

completedAtstring,null<date-time>nullable

When the task completed (success or failure)

errorstring | nullnullable

Error message (for failed tasks)

libraryIdstring,null<uuid>nullable

Library ID if this task is related to a library

progress object
oneOf
null
seriesIdstring,null<uuid>nullable

Series ID if this task is related to a series

startedAtstring<date-time>required

When the task started

statusTaskStatus (string)required

Current status of the task

Possible values: [pending, running, completed, failed]

taskIdstring<uuid>required

Unique identifier for this task instance

taskTypestringrequired

Type of task being executed

TaskProgressEvent
{
  "bookId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "completedAt": "2024-07-29T15:51:28.071Z",
  "error": "string",
  "libraryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "progress": "null",
  "seriesId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "startedAt": "2024-07-29T15:51:28.071Z",
  "status": "pending",
  "taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "taskType": "string"
}