Back
Download What's New FAQ Home
How To Setup Ultra

Installing the NZBClient Script into NZBGet

Requirements

  • NZBGet installed and running.
  • Python 3 installed on the system running NZBGet (for legacy versions).

Installation (v2.0+ - Recommended)

Use this script for NZBGet v23 and above.

For version 2.0 and above of the NZBClient Notifier script, installation is now managed via the Extension Manager in NZBGet.

Download

Download the latest version of the script here

Setup Instructions

  1. Unzip the downloaded file.
  2. Inside the zip, you’ll find a folder named NZBClient.
  3. Copy the entire NZBClient folder into your NZBGet scripts directory.
  • You can find your script directory by logging into NZBGet and going to: Settings → PATHS → ScriptDir 4. Remove any old copies of the NZBClient script from the scripts directory to avoid conflicts. 5. Reload NZBGet: Settings → SYSTEM → Reload NZBGet

Configure the Script

  1. After reload, go to Settings → Extension Manager.
  2. Locate NZBClient Notifier in the list.
  3. Press the green "Play" button to activate the script.
  4. Click the gear icon next to it to open the settings panel.
  5. Enter your User Key and App Token (available in the NZBClient app under Settings → NZBClient Ultra → Notifications).
  6. Save all changes.
  7. You can test notifications from within the settings panel.

Optional: Post-Processing Notifications

If you want notifications for post-processing:

  1. Go to Settings → CATEGORIES.
  2. For each custom category you want to receive notifications from:
  • Locate Category.X.Extensions
  • Click Choose → select NZBClient
  • Click Apply 3. Save all changes and reload NZBGet.

Legacy Installation (Pre-v2.0)

Use this script for NZBGet v22 and below.

If you're using an older version of NZBGet or the script, follow these legacy instructions:

Requirements

  • Python 3 installed on your system running NZBGet.
  • Access to your NZBGet setup to install a Queue/Post-Processing script.

Setup Instructions

  1. Download NZBClient.py (1.x.x) from here.
  2. Copy it into your NZBGet script directory.
  • To find the location: NZBGet → Settings → PATHS → ScriptDir 3. Reload NZBGet: Settings → SYSTEM → Reload NZBGet 4. After reload, open settings and scroll down to verify NZBCLIENT appears at the bottom of the settings menu. 5. Click it to open the script configuration. 6. Open the NZBClient app on your device:
  • Go to Settings → NZBClient Ultra
  • Follow the prompts to complete signup 7. Navigate to Ultra Settings → Notifications in the app:
  • Tap the three-dot menu next to User Key and App Token
  • Copy these into their corresponding fields in NZBGet 8. Save all changes and reload NZBGet. 9. Go back to the NZBClient script settings and tap "Test Push Notifications" to verify setup.

Enable Queue Script Notifications

  1. Go to Settings → EXTENSION SCRIPTS.
  2. Under Extensions, tap Choose → select NZBClient → click Apply.
  3. Save all changes and reload NZBGet.

Enable Post-Processing Notifications

  1. Go to Settings → CATEGORIES.
  2. For each category:
  • Under Category.X.Extensions click Choose
  • Select NZBClient, then Apply 3. Save all changes and reload NZBGet.

Optional: Encryption

If you’d like to set up message encryption, click here to learn more (Update with actual link if available)

Troubleshooting

If test notifications are not working:

  • Double-check your User Key and App Token for typos.
  • Reload NZBGet after any changes.
  • Ensure the script is correctly activated in Extension Manager (v2.0+).