Skip to content

Latest commit

 

History

History
38 lines (26 loc) · 1.4 KB

custom-scripts.md

File metadata and controls

38 lines (26 loc) · 1.4 KB
Raw
title description published date tags editor dateCreated
Prowlarr Custom Scripts
true
2021-12-20 16:40:47 UTC
prowlarr, needs-love, custom scripts
markdown
2021-06-23 06:40:30 UTC

If you're looking to trigger a custom script, you can find more details here. Scripts are added to Prowlarr via the Connect Settings.

Overview

Prowlarr can execute a custom script when an episode is newly imported or renamed. Depending on the action, different parameters are supplied. Parameters are passed to the script through environment variables.

Prowlarr Logs

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 Variables

Environment Variables vary based on the event type. Details coming soon^tm^

The code to review is here in the interim. Wiki contributions welcome {.is-info}

On Test

When adding the script to Prowlarr 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
prowlarr_eventtype Test