Integrations
Integrations can be used to continuously update your media progress. They can be of two types:
- Yank: Progress data is downloaded from an externally running server at a periodic interval.
- Sink: An external client publishes progress updates to the Ryot server.
Yank integrations
For each integration you want to enable, credentials for the external server must be saved to your profile. To do so, go to the "Settings" tab and add a new integration under the "Integrations" tab.
You can configure the interval at which the data is fetched from the external using the
integration.pull_every_minutes
configuration key. Defaults to 5
(minutes).
Audiobookshelf
Warning
This will only import media that are in progress. Perform an import if you want to import media that are finished.
The Audiobookshelf integration can sync all media if they have an Audible ID or ITunes ID or ISBN.
- Obtain an API token as described in the Audiobookshelf authentication docs.
- Go to your Ryot user settings and add the correct details as described in the yank section.
Sink integrations
All webhook URLs follow this format:
https://<instance_url>/backend/_i/<slug>
https://app.ryot.io/backend/_i/int_a6cGGXEq6KOI # example
Warning
Keep your webhook urls private to prevent abuse.
Jellyfin
Automatically add new Jellyin movie and show plays to Ryot. It will work for all the media that have been a valid TMDb ID attached to their metadata.
Info
Requires the unofficial webhook plugin to be installed and active in Jellyfin.
- Generate a slug in the integration settings page. Copy the newly generated webhook Url.
- In the Jellyfin webhook plugin settings, add a new webhook using the
following settings:
- Webhook Url =>
<paste_url_copied>
- Payload format =>
Default
- Listen to events only for => Choose your user
- Events =>
Play
,Pause
,Resume
,Stop
andProgress
- Webhook Url =>
Plex
Automatically add Plex show and movie plays to Ryot. It will work for all the media that have been a valid TMDb ID attached to their metadata.
- Generate a slug in the integration settings page using the following settings:
- Username => Your Plex
Fullname
. If you have noFullname
specified in Plex, fallback to your PlexUsername
. This will be used to filter webhooks for the specified Plex account only.
- Username => Your Plex
- In your Plex Webhooks settings, add a new webhook using the following settings:
- Webhook Url =>
<paste_url_copied>
- Webhook Url =>
Warning
Since Plex does not send the expected TMDb ID for shows, progress will only be synced if you already have the show in the Ryot database. To do this, simply add the show to your watchlist.
Kodi
The Kodi integration allows syncing the current movie or TV show you are watching. It will work for all the media that have been a valid TMDb ID attached to their metadata.
- Generate a slug in the integration settings page. Copy the newly generated webhook Url.
- Download the addon from github releases.
The file will have a name of
script.ryot.zip
. - Install the zipped addon to your Kodi instance. Once installed, it will be visible under the "Services" sub category named "Ryot".
- Click on "Configure" to fill in the correct details.
Flow Launcher
Warning
This is a community maintained integration.
The plugin for Flow Launcher allows you to quickly search your Ryot tracker by media category:
To install, search for "Ryot" in the Flow Launcher plugin store. Or use pm install ryot
.
Refer to the documentation for post-install configuration.