Skip to content

Commit 135c9c9

Browse files
committed
chore: update readme
1 parent 8b8f7f9 commit 135c9c9

1 file changed

Lines changed: 36 additions & 2 deletions

File tree

‎README.md‎

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@ Scrob syncs your libraries from **Jellyfin**, **Plex**, and **Emby**, tracks you
2626
- [Configuration](#configuration)
2727
- [Development](#development)
2828
- [Webhooks](#webhooks-real-time-scrobbling)
29+
- [Jellyfin](#jellyfin)
30+
- [Plex](#plex)
31+
- [Emby](#emby)
32+
- [Kodi](#kodi)
2933
- [OIDC / Single Sign-On](#oidc--single-sign-on)
3034
- [Email Validation & SMTP](#email-validation--smtp)
3135
- [Contributing](#contributing)
@@ -36,7 +40,7 @@ Scrob syncs your libraries from **Jellyfin**, **Plex**, and **Emby**, tracks you
3640

3741
- **Multi-source sync**: Import your full library, watch history, and ratings from Jellyfin, Plex, and Emby. Incremental syncs keep everything up to date.
3842
- **Keep all servers in sync**: Keep your watched status in sync between all your servers. Supports multiple instances.
39-
- **Real-time scrobbling**: Webhooks from Jellyfin, Plex, and Emby update your watch state as you play — no manual sync needed.
43+
- **Real-time scrobbling**: Webhooks from Jellyfin, Plex, Emby, and Kodi update your watch state as you play — no manual sync needed.
4044
- **Trakt integration**: Sync your watched history and ratings from Trakt, and push Scrob activity back to Trakt automatically.
4145
- **Watch history & ratings**: Track every movie and episode you've watched. Rate them on a 10-point scale with optional reviews.
4246
- **Season ratings**: Rate individual seasons separately from the overall show.
@@ -242,7 +246,11 @@ DATABASE_URL: postgresql+asyncpg://user:password@your-db-host:5432/scrob
242246
Webhooks update your watch history and Continue Watching in real time. Each user's webhook URL is shown in **Settings** next to the relevant integration.
243247
244248
```
245-
https://your-scrob-url/api/proxy/webhooks/{jellyfin|plex|emby}?api_key=YOUR_API_KEY
249+
# Jellyfin, Plex, Emby — connection_id is shown in Settings next to each server
250+
https://your-scrob-url/api/proxy/webhooks/{jellyfin|plex|emby}/{connection_id}?api_key=YOUR_API_KEY
251+
252+
# Kodi — no connection, just the API key
253+
https://your-scrob-url/api/proxy/webhooks/kodi?api_key=YOUR_API_KEY
246254
```
247255

248256
### Jellyfin
@@ -270,6 +278,32 @@ Plex webhooks require a **Plex Pass** subscription.
270278
2. Paste your Scrob Emby webhook URL.
271279
3. Enable events: `Playback Start`, `Playback Progress`, `Playback Stop`.
272280

281+
### Kodi
282+
283+
Kodi does not have built-in webhook support, so you need a small add-on to forward playback events. **[script.service.kodi.webhooks](https://github.com/d8ahazard/service.webhooks.kodi)** is the recommended option.
284+
285+
1. Install the add-on in Kodi.
286+
2. In the add-on settings, add a new webhook destination pointed at your Scrob Kodi webhook URL (shown in **Settings → Connections → Kodi**).
287+
3. Enable the events: `playback_started`, `playback_paused`, `playback_resumed`, `playback_stopped`, and optionally `playback_seeked` (for in-progress tracking).
288+
289+
The webhook URL format is:
290+
291+
```
292+
https://your-scrob-url/api/proxy/webhooks/kodi?api_key=YOUR_API_KEY
293+
```
294+
295+
**Payload format** — Scrob accepts both the native Kodi JSON-RPC notification format (`method`/`params.data`) and the flatter add-on format (`event`/`item`/`player`). Supported event names:
296+
297+
| Kodi event | Scrob action |
298+
|---|---|
299+
| `Player.OnPlay` / `playback_started` | Start session |
300+
| `Player.OnPause` / `playback_paused` | Pause session |
301+
| `Player.OnResume` / `playback_resumed` | Resume session |
302+
| `Player.OnStop` / `playback_stopped` | End session, scrobble if ≥ 90 % |
303+
| `Player.OnAVChange` / `playback_seeked` | Update progress |
304+
305+
Kodi is scrobble-only — it does not sync a library into your collection. Run a sync from Jellyfin, Plex, or Emby if you want your Kodi-played items to appear in My Collection.
306+
273307
## OIDC / Single Sign-On
274308

275309
Scrob supports any OpenID Connect provider (Authelia, Authentik, Keycloak, Google, etc.).

0 commit comments

Comments
 (0)