Integrations
This page is the user-facing walkthrough for connecting Sublarr to the rest of your stack. The settings reference for these connections lives at Settings → Connections — this page is the guide you follow first.
Sonarr / Radarr
Section titled “Sonarr / Radarr”The most common setup. Sonarr/Radarr sources truth — what’s in the library, what got imported, what got upgraded. Sublarr subscribes to that stream.
Connection
Section titled “Connection”In Sublarr → Settings → Connections → Sonarr (or Radarr) → Add instance:
| Field | Where to find it in Sonarr/Radarr |
|---|---|
| URL | The base URL you use to access the *arr UI. Example: http://sonarr:8989. |
| API key | Sonarr → Settings → General → API Key. |
| Label | Free text — used in dropdowns when you have multiple instances. |
Click Test — green = connected. Sublarr will start importing your library on the first scheduled sync; trigger immediate import via Trigger sync in the row.
Multiple instances
Section titled “Multiple instances”You can register as many Sonarr / Radarr instances as you have. Sublarr deduplicates by media ID across them. Common patterns:
| Pattern | Setup |
|---|---|
| Anime + Western split | Two Sonarrs (one anime, one western). Two rows in Sublarr. |
| 4K + 1080p split | Two Radarrs (one per resolution). Same. |
| Sonarr-A + Sonarr-B-test | Production + staging. Disable the staging row in Sublarr until ready to go live. |
Inbound webhooks (for fast import)
Section titled “Inbound webhooks (for fast import)”Without webhooks, Sublarr polls Sonarr/Radarr on its scheduled interval. With webhooks, the *arr pushes import events to Sublarr immediately, so a search for the new episode starts within seconds rather than waiting for the next poll cycle.
Set up in the *arr UI:
- Sonarr/Radarr → Settings → Connect → + → Webhook.
- Name:
Sublarr. - On Grab + On Import + On Upgrade.
- URL: copy from Sublarr → Settings → Connections → Webhooks → Sonarr URL.
- Method:
POST. - Headers: add
X-Webhook-Secret: <secret-from-Sublarr>. - Save.
After that, Sublarr’s manual_action_required event fires only on legitimate exceptions — most imports flow silently end-to-end.
Path Mapping
Section titled “Path Mapping”If Sonarr/Radarr’s view of paths differs from Sublarr’s view, configure path mapping. See Path Mapping for the full reference. The wizard offers this in step 4 of the onboarding wizard.
Plex needs a fresh library scan after Sublarr writes a subtitle, otherwise the new track won’t appear in the player.
| Field | Where to find it in Plex |
|---|---|
| URL | http://<plex-host>:32400 |
| Token | https://app.plex.tv/desktop/#!/account → log in → Plex Web app → URL shows ?X-Plex-Token=.... The Plex docs walk through this in detail. |
| Library scope | Default: refresh all libraries on update. Restrict to specific libraries if you have many. |
After saving, Test round-trips Plex’s identity endpoint (/identity) and reports the server name + version.
Jellyfin
Section titled “Jellyfin”| Field | Where to find it in Jellyfin |
|---|---|
| URL | http://<jellyfin-host>:8096 |
| API key | Dashboard → API Keys → Create. |
| User ID | Dashboard → Users → click user → URL shows userId=.... |
Same workflow — Test confirms connectivity, then library refreshes happen automatically on subtitle write.
Same as Jellyfin (Emby is the parent of Jellyfin’s UI):
| Field | Where to find it |
|---|---|
| URL | http://<emby-host>:8096 |
| API key | Dashboard → Advanced → API Keys → Create. |
| User ID | Dashboard → Users. |
Standalone (no *arr)
Section titled “Standalone (no *arr)”When you don’t run Sonarr/Radarr or want Sublarr to manage a folder outside their control:
- Settings → Connections → Standalone → Add folder.
- Path: absolute path inside Sublarr’s container (e.g.
/media/anime). - Label: sidebar display name.
- Scan interval: optional per-folder override; default uses the global cadence.
Standalone folders coexist with *arr instances. Files found there that aren’t in *arr show up in Library tagged “standalone”.
Outbound integrations
Section titled “Outbound integrations”For systems Sublarr should push to (e.g. custom CMS, in-house pipeline, alerting):
| Mechanism | Use for |
|---|---|
| Notification channels | Generic event delivery via Apprise — Discord, Slack, Telegram, email, custom JSON. See Notifications. |
| Outbound hooks | Direct HTTP POST per event. See Hooks & Webhooks. |
Health summary
Section titled “Health summary”Once everything’s connected, Settings → Diagnostics shows aggregate health across all integrations in one view — *arr instances reachable, media servers online, providers healthy, translation backends responsive.