Skip to content

Notification Values

Mark edited this page Feb 27, 2026 · 1 revision

Notification Values

Event Types

AudioBookRequest has three types of events that can trigger notifications:

  • onNewRequest: A new book request is made.
  • onSuccessfulDownload: A book download has started
  • onFailedDownload: A book download has failed

Overview

The following values are available for use in notification templates.

Value Description
eventType The type of event that triggered the notification. One of onNewRequest, onSuccessfulDownload, onFailedDownload
eventUser The first user that requested the book.
eventUserExtraData Extra data field of the first user that requested the book.
joinedUsers All requesters joined together by comma+space , .
joinedUsersExtraData All non-empty extra data of all requesters joined together by comma+space , .
bookTitle The title of the requested book
bookAuthors The author(s) of the book
bookCover The cover image URL of the book
bookNarrators The narrator(s) of the audiobook
bookASIN The Amazon Standard Identification Number of the book

Successful Download Event

Successful download start events (onSuccessfulDownload) additionally have the following values:

Value Description
errorStatus The error status code of the failed download
errorReason The reason the download failed
torrentInfoHash The info hash of the torrent
sourceSizeMB The size of the source in megabytes
sourceTitle The title of the source being downloaded
indexerName The name of the indexer used
sourceProtocol The protocol used for the source. One of torrent or usenet.

Failed Download Event

Failed download events (onFailedDownload) additionally have the following values:

Value Description
errorStatus The error status code of the failed download
errorReason The reason the download failed

Clone this wiki locally