If you're looking to trigger a custom script, you can find more details here. Scripts are added to Readarr via the Connect Settings.
Readarr can execute a custom script when a book is newly imported or renamed. Depending on the action, different parameters are supplied. Parameters are passed to the script through environment variables.
Note that the following will only be logged for custom scripts:
- Script
stdout output will be logged as Debug
- Script
stderr output will be logged as Info
- The trigger of the script will be logged in
Trace
| Environment Variable |
Details |
readarr_eventtype |
Grab |
readarr_author_id |
Internal ID of the author |
readarr_author_name |
Name of the author |
readarr_author_grid |
Author goodreads id |
readarr_release_bookcount |
Number of books in the release |
readarr_release_bookreleasedates |
Release date of the book |
readarr_release_booktitles |
Book titles of the release |
readarr_release_bookids |
Book id |
readarr_release_grids |
Goodreads ids of the release |
readarr_release_title |
Title of the book |
readarr_release_indexer |
Indexer from which the release was grabbed |
readarr_release_size |
Release size |
readarr_release_quality |
Release quality |
readarr_release_qualityVersion |
Release quality version |
readarr_release_releasegroup |
Release group (empty if unknown) |
readarr_download_client |
Download client use to download the release |
readarr_download_id |
Download id |
| Environment Variable |
Details |
readarr_eventtype |
Download |
readarr_author_id |
Internal ID of the author |
readarr_author_name |
Name of the author |
readarr_author_path |
Path of the Author |
readarr_author_grid |
Author goodreads id |
readarr_book_id |
Book's id |
readarr_book_title |
Book's title |
readarr_book_grid |
Book's Goodreads id |
readarr_book_releasedate |
Release date of the book |
readarr_download_client |
Download client use to download the release |
readarr_download_id |
Download id |
| Environment Variable |
Details |
readarr_eventtype |
Rename |
readarr_author_id |
Internal ID of the author |
readarr_author_name |
Name of the author |
readarr_author_path |
Path of the Author |
readarr_author_grid |
Author goodreads id |
| Environment Variable |
Details |
readarr_eventtype |
TrackRetag |
readarr_author_id |
Internal ID of the author |
readarr_author_name |
Name of the author |
readarr_author_path |
Path of the Author |
readarr_author_grid |
Author goodreads id |
readarr_book_id |
Book's id |
readarr_book_title |
Book's title |
readarr_book_grid |
Book's Goodreads id |
readarr_book_releasedate |
Release date of the book |
readarr_bookfile_id |
Book file id |
readarr_bookfile_path |
Path to the book |
readarr_bookfile_quality |
Book file quality |
readarr_bookfile_qualityversion |
Book file quality version |
readarr_bookfile_releasegroup |
Release group of the book |
readarr_bookfile_scenename |
Scene name of the book |
readarr_tags_diff |
Tags differences |
readarr_tags_scrubbed |
Tags scrubbed |
| Environment Variable |
Details |
readarr_eventtype |
HealthIssue |
readarr_health_issue_level |
Type of health issue (Ok, Notice, Warning, or Error) |
readarr_health_issue_message |
Message from the health issue |
readarr_health_issue_type |
Area that failed and triggered the health issue |
readarr_health_issue_wiki |
Wiki URL (empty if does not exist) |
When adding the script to Readarr and clicking 'Test,' the script will be invoked with the following parameters. The script should be able to gracefully ignore any unsupported event type.
| Environment Variable |
Details |
readarr_eventtype |
Test |