Emby
App · 41 actions
Run your Emby media server from workflows: search and list films, shows and music, see who is watching what, message, pause or stop a player, scan libraries, fix an item's details, manage playlists, collections and users, and read the activity log. Start a workflow when something is added, playback starts or stops, someone finishes a film, a sign-in fails or a user is added.
Actions
| Action | What it does |
|---|---|
| Add to collection | Add films or shows to a collection. |
| Add to favourites | Make an item one of a user's favourites. |
| Add to playlist | Add films, episodes or songs to the end of a playlist. |
| Control playback | Pause, resume or stop what a player is playing, or skip to the next or previous track. |
| Create collection | Make a collection of films or shows. |
| Create playlist | Make a playlist, empty or with items already in it. |
| Create user | Add a user who can sign in to Emby, such as a family member. |
| Delete an item | Delete an item from Emby and its files from the server's disk, as Emby's own Delete does. |
| Delete collection | Delete a collection. |
| Delete playlist | Delete a playlist. |
| Delete user | Delete a user, with what they have played and their favourites. |
| Disable user | Stop a user signing in, and sign them out of their devices, without deleting them or what they have watched. |
| Enable user | Let a disabled user sign in again. |
| Get a user | Get one user: whether they are an administrator, disabled or hidden, what they may do, and when they last signed in. |
| Get an item | Get everything Emby knows about one film, show, episode, song or album: its summary, genres, tags, cast, file and, for a user, whether they have played it. |
| Get server info | Get the server's name, version, whether an update or restart is waiting, and how many films, shows, episodes, albums and songs it has. |
| List activity | Read Emby's activity log, newest first: who signed in or failed to, what was played, users added and removed, plugin and server updates. |
| List collection items | List what is in a collection. |
| List collections | List the server's collections, such as a film series kept together. |
| List continue watching | List what a user is partway through, as Emby's Continue Watching row shows it, with how far they got. |
| List devices | List the devices and apps that have signed in to Emby, with who last used each and when. |
| List libraries | List the server's libraries, with what each holds and the folders it reads. |
| List next up | List the next episode of each show a user is watching, as Emby's Next Up row shows it. |
| List playlist items | List what is in a playlist, in its order. |
| List playlists | List the server's playlists. |
| List recently added | List what was added to Emby lately, newest first: films, episodes and albums, or one kind, in every library or one. |
| List scheduled tasks | List Emby's scheduled tasks, such as Scan media library, with whether each is running and how its last run ended. |
| List sessions | List the apps and devices signed in to Emby and what each is playing now: who is watching what, how far in, and whether it is paused. |
| List users | List the server's users, with whether each is an administrator or disabled and when they were last active. |
| Mark as played | Mark a film, episode or song as played for a user; a show or album marks everything in it. |
| Mark as unplayed | Mark a film, episode or song as not played for a user, so it shows as new to them again. |
| Play on a session | Have a player start playing a film, episode, song or several, now or after what it is playing. |
| Refresh metadata | Have Emby look up an item's details and pictures again, as Refresh Metadata does. |
| Remove from collection | Take films or shows out of a collection. |
| Remove from favourites | Take an item out of a user's favourites. |
| Remove from playlist | Take films, episodes or songs out of a playlist. |
| Run a scheduled task | Start one of Emby's scheduled tasks now, as its play button does. |
| Scan library | Have Emby look through its libraries' folders for new, changed and removed files, as Scan Library Files does, such as after a download lands. |
| Search media | Find films, shows, episodes, albums and songs: by words in the title, kind, library, genre, tag, year, when they were added, and whether a user has played them or made them a favourite. |
| Send message to a session | Show a message on a player's screen, such as that dinner is ready or the server is going down for maintenance. |
| Update an item | Change an item's name, overview, genres, tags or year. |
Add to collection
Add films or shows to a collection.
Inputs
- Collection
collectiontextRequired - The collection, by name or ID, or one an earlier step made.
- Items
itemstextRequired - One or more films, episodes or songs: exact names, links from Emby or IDs from an earlier step, separated by commas.
Outputs
addedlist- The items added
countnumber- How many were added
created_attext- When it was made (UTC)
idtext- Its ID, for other Emby steps
nametext- Its name
overviewtext- Its description
runtime_minutesnumber- How long everything in it runs, in minutes
web_urltext- A link to it in Emby
Example output
{
"added": [
{
"id": "12",
"name": "Harbor Lights"
}
],
"count": 1,
"created_at": "2026-11-12T22:36:10Z",
"id": "48",
"name": "Harbor films",
"overview": "",
"runtime_minutes": 0.0,
"web_url": "http://192.168.1.20:8096/web/index.html#!/item?id=48&serverId=c82de17ac3364560b5f0d5371f9d82d6"
}Add to favourites
Make an item one of a user's favourites.
Inputs
- Item
itemtextRequired - The film, show, episode, song or album: its exact name, its link from Emby, or the ID an earlier step found, such as Search media.
- User
usertext - Whose viewing this is about, by name or ID. Leave blank when the server has one user.
Outputs
favouritetrue/false- Whether it is now one of their favourites
idtext- The item's ID
last_played_attext- When they last played it (UTC)
nametext- Its title
play_countnumber- How many times they have played it
playedtrue/false- Whether the user has now played it
typetext- What it is, such as Movie
user_idtext- The user's ID
user_nametext- The user's name
web_urltext- A link to it in Emby
Example output
{
"favourite": false,
"id": "12",
"last_played_at": "2026-11-12T22:36:10Z",
"name": "Harbor Lights",
"play_count": 1,
"played": true,
"type": "Movie",
"user_id": "b3f34c08a38848c5818c168153ff70c2",
"user_name": "sam",
"web_url": "http://192.168.1.20:8096/web/index.html#!/item?id=12&serverId=c82de17ac3364560b5f0d5371f9d82d6"
}Add to playlist
Add films, episodes or songs to the end of a playlist.
Inputs
- Playlist
playlisttextRequired - The playlist, by name or ID, or one an earlier step made.
- Items
itemstextRequired - One or more films, episodes or songs: exact names, links from Emby or IDs from an earlier step, separated by commas.
Outputs
addedlist- The items added
countnumber- How many were added
created_attext- When it was made (UTC)
idtext- Its ID, for other Emby steps
nametext- Its name
overviewtext- Its description
runtime_minutesnumber- How long everything in it runs, in minutes
web_urltext- A link to it in Emby
Example output
{
"added": [
{
"id": "12",
"name": "Harbor Lights"
}
],
"count": 1,
"created_at": "2026-11-12T22:36:10Z",
"id": "45",
"name": "Friday night",
"overview": "",
"runtime_minutes": 208.0,
"web_url": "http://192.168.1.20:8096/web/index.html#!/item?id=45&serverId=c82de17ac3364560b5f0d5371f9d82d6"
}Control playback
Pause, resume or stop what a player is playing, or skip to the next or previous track.
Inputs
- Session
sessiontextRequired - The player: a session from List sessions, or the name of a user or device that is signed in on one.
- Command
commandtextRequired - What the player should do.One of:
pause,unpause(Resume),play_pause(Play or pause),stop,next(Next track),previous(Previous track).
Outputs
apptext- The app, such as Emby Web or Emby for Android
app_versiontext- The app's version
can_be_controlledtrue/false- Whether it takes messages and playback commands
commandtext- The command sent: pause, unpause, play_pause, stop, next or previous
devicetext- The device's name
device_idtext- The device's own ID
idtext- The session's ID, for Send message, Control playback and Play
is_pausedtrue/false- Whether what it is playing is paused
is_playingtrue/false- Whether it is playing something (paused counts)
item_idtext- The ID of what is playing; empty when idle
item_nametext- The title of what is playing
item_typetext- What is playing, such as Movie or Episode
last_activity_attext- When it was last heard from (UTC)
play_methodtext- DirectPlay, DirectStream or Transcode
position_minutesnumber- How far in it is, in minutes
runtime_minutesnumber- How long what is playing runs, in minutes
senttrue/false- True once Emby has passed it on
show_nametext- For an episode, its show
user_idtext- The ID of the user signed in
user_nametext- Their name
Example output
{
"app": "Emby Web",
"app_version": "4.10.2.0",
"can_be_controlled": true,
"command": "pause",
"device": "Chrome Windows",
"device_id": "a0ab28af-5644-4c5a-81b1-0db2d57ac34f",
"id": "dd4f087a76f7d20040016d1db9e770f0",
"is_paused": false,
"is_playing": true,
"item_id": "12",
"item_name": "Harbor Lights",
"item_type": "Movie",
"last_activity_at": "2026-11-14T21:40:00Z",
"play_method": "DirectStream",
"position_minutes": 23.7,
"runtime_minutes": 104.0,
"sent": true,
"show_name": "",
"user_id": "b3f34c08a38848c5818c168153ff70c2",
"user_name": "sam"
}Create collection
Make a collection of films or shows. Emby needs at least one item to make it.
Inputs
- Name
nametextRequired - What to call it.
- Items
itemstextRequired - One or more films, episodes or songs: exact names, links from Emby or IDs from an earlier step, separated by commas.
Outputs
addedlist- The items added
countnumber- How many were added
created_attext- When it was made (UTC)
idtext- Its ID, for other Emby steps
nametext- Its name
overviewtext- Its description
runtime_minutesnumber- How long everything in it runs, in minutes
web_urltext- A link to it in Emby
Example output
{
"added": [
{
"id": "12",
"name": "Harbor Lights"
}
],
"count": 1,
"created_at": "2026-11-12T22:36:10Z",
"id": "48",
"name": "Harbor films",
"overview": "",
"runtime_minutes": 0.0,
"web_url": "http://192.168.1.20:8096/web/index.html#!/item?id=48&serverId=c82de17ac3364560b5f0d5371f9d82d6"
}Create playlist
Make a playlist, empty or with items already in it.
Inputs
- Name
nametextRequired - What to call it.
- Items
itemstext - What to put in it: exact names, links from Emby or IDs from an earlier step, separated by commas. Leave blank for an empty playlist.
- For
mediatext - Whether it holds video or audio. Only needed for an empty playlist.One of:
video,audio. Default:video. - User
usertext - Whose playlist it is, by name or ID. Leave blank for one that belongs to the server.
Outputs
addedlist- The items added
countnumber- How many were added
created_attext- When it was made (UTC)
idtext- Its ID, for other Emby steps
nametext- Its name
overviewtext- Its description
runtime_minutesnumber- How long everything in it runs, in minutes
web_urltext- A link to it in Emby
Example output
{
"added": [
{
"id": "12",
"name": "Harbor Lights"
}
],
"count": 1,
"created_at": "2026-11-12T22:36:10Z",
"id": "45",
"name": "Friday night",
"overview": "",
"runtime_minutes": 208.0,
"web_url": "http://192.168.1.20:8096/web/index.html#!/item?id=45&serverId=c82de17ac3364560b5f0d5371f9d82d6"
}Create user
Add a user who can sign in to Emby, such as a family member. They start with Emby's usual access: every library, no administration.
Inputs
- Name
nametextRequired - The name they sign in with.
- Password
passwordtext - Their first password; they can change it in Emby. Leave blank for none.
Outputs
all_librariestrue/false- Whether they can open every library
can_deletetrue/false- Whether they can delete media
can_playtrue/false- Whether they can play media
created_attext- When they were added (UTC)
has_passwordtrue/false- Whether they have a password
idtext- The user's ID
is_admintrue/false- Whether they are an administrator
is_disabledtrue/false- Whether they are disabled and can't sign in
is_hiddentrue/false- Whether they are hidden from the sign-in screen
last_activity_attext- When they were last active (UTC)
last_login_attext- When they last signed in (UTC)
nametext- The name they sign in with
remote_accesstrue/false- Whether they can connect from outside the home network
Example output
{
"all_libraries": true,
"can_delete": false,
"can_play": true,
"created_at": "2026-11-12T22:36:09Z",
"has_password": true,
"id": "b3f34c08a38848c5818c168153ff70c2",
"is_admin": false,
"is_disabled": false,
"is_hidden": false,
"last_activity_at": "2026-11-14T21:40:00Z",
"last_login_at": "2026-11-14T19:02:11Z",
"name": "sam",
"remote_access": true
}Delete an item
Delete an item from Emby and its files from the server's disk, as Emby's own Delete does. This can't be undone. To delete a playlist or collection and keep the media, use Delete playlist or Delete collection.
Inputs
- Item
itemtextRequired - The film, show, episode, song or album: its exact name, its link from Emby, or the ID an earlier step found, such as Search media.
Outputs
deletedtrue/false- True once it is deleted
idtext- Its ID
nametext- Its name
typetext- What it was, such as Movie, Playlist or BoxSet
Example output
{
"deleted": true,
"id": "12",
"name": "Harbor Lights",
"type": "Movie"
}Delete collection
Delete a collection. What was in it stays in Emby.
Inputs
- Collection
collectiontextRequired - The collection, by name or ID, or one an earlier step made.
Outputs
deletedtrue/false- True once it is deleted
idtext- Its ID
nametext- Its name
typetext- What it was, such as Movie, Playlist or BoxSet
Example output
{
"deleted": true,
"id": "48",
"name": "Harbor films",
"type": "BoxSet"
}Delete playlist
Delete a playlist. What was in it stays in Emby.
Inputs
- Playlist
playlisttextRequired - The playlist, by name or ID, or one an earlier step made.
Outputs
deletedtrue/false- True once it is deleted
idtext- Its ID
nametext- Its name
typetext- What it was, such as Movie, Playlist or BoxSet
Example output
{
"deleted": true,
"id": "45",
"name": "Friday night",
"type": "Playlist"
}Delete user
Delete a user, with what they have played and their favourites. This can't be undone.
Inputs
- User
usertextRequired - The user, by name or ID.
Outputs
deletedtrue/false- True once they are deleted
idtext- Their ID
nametext- Their name
Example output
{
"deleted": true,
"id": "b3f34c08a38848c5818c168153ff70c2",
"name": "sam"
}Disable user
Stop a user signing in, and sign them out of their devices, without deleting them or what they have watched. The only administrator can't be disabled.
Inputs
- User
usertextRequired - The user, by name or ID.
Outputs
all_librariestrue/false- Whether they can open every library
can_deletetrue/false- Whether they can delete media
can_playtrue/false- Whether they can play media
created_attext- When they were added (UTC)
has_passwordtrue/false- Whether they have a password
idtext- The user's ID
is_admintrue/false- Whether they are an administrator
is_disabledtrue/false- Whether they are disabled and can't sign in
is_hiddentrue/false- Whether they are hidden from the sign-in screen
last_activity_attext- When they were last active (UTC)
last_login_attext- When they last signed in (UTC)
nametext- The name they sign in with
remote_accesstrue/false- Whether they can connect from outside the home network
Example output
{
"all_libraries": true,
"can_delete": false,
"can_play": true,
"created_at": "2026-11-12T22:36:09Z",
"has_password": true,
"id": "b3f34c08a38848c5818c168153ff70c2",
"is_admin": false,
"is_disabled": true,
"is_hidden": false,
"last_activity_at": "2026-11-14T21:40:00Z",
"last_login_at": "2026-11-14T19:02:11Z",
"name": "sam",
"remote_access": true
}Enable user
Let a disabled user sign in again.
Inputs
- User
usertextRequired - The user, by name or ID.
Outputs
all_librariestrue/false- Whether they can open every library
can_deletetrue/false- Whether they can delete media
can_playtrue/false- Whether they can play media
created_attext- When they were added (UTC)
has_passwordtrue/false- Whether they have a password
idtext- The user's ID
is_admintrue/false- Whether they are an administrator
is_disabledtrue/false- Whether they are disabled and can't sign in
is_hiddentrue/false- Whether they are hidden from the sign-in screen
last_activity_attext- When they were last active (UTC)
last_login_attext- When they last signed in (UTC)
nametext- The name they sign in with
remote_accesstrue/false- Whether they can connect from outside the home network
Example output
{
"all_libraries": true,
"can_delete": false,
"can_play": true,
"created_at": "2026-11-12T22:36:09Z",
"has_password": true,
"id": "b3f34c08a38848c5818c168153ff70c2",
"is_admin": false,
"is_disabled": false,
"is_hidden": false,
"last_activity_at": "2026-11-14T21:40:00Z",
"last_login_at": "2026-11-14T19:02:11Z",
"name": "sam",
"remote_access": true
}Get a user
Get one user: whether they are an administrator, disabled or hidden, what they may do, and when they last signed in.
Inputs
- User
usertextRequired - The user, by name or ID.
Outputs
all_librariestrue/false- Whether they can open every library
can_deletetrue/false- Whether they can delete media
can_playtrue/false- Whether they can play media
created_attext- When they were added (UTC)
has_passwordtrue/false- Whether they have a password
idtext- The user's ID
is_admintrue/false- Whether they are an administrator
is_disabledtrue/false- Whether they are disabled and can't sign in
is_hiddentrue/false- Whether they are hidden from the sign-in screen
last_activity_attext- When they were last active (UTC)
last_login_attext- When they last signed in (UTC)
nametext- The name they sign in with
remote_accesstrue/false- Whether they can connect from outside the home network
Example output
{
"all_libraries": true,
"can_delete": false,
"can_play": true,
"created_at": "2026-11-12T22:36:09Z",
"has_password": true,
"id": "b3f34c08a38848c5818c168153ff70c2",
"is_admin": false,
"is_disabled": false,
"is_hidden": false,
"last_activity_at": "2026-11-14T21:40:00Z",
"last_login_at": "2026-11-14T19:02:11Z",
"name": "sam",
"remote_access": true
}Get an item
Get everything Emby knows about one film, show, episode, song or album: its summary, genres, tags, cast, file and, for a user, whether they have played it.
Inputs
- Item
itemtextRequired - The film, show, episode, song or album: its exact name, its link from Emby, or the ID an earlier step found, such as Search media.
- User
usertext - Whose played and favourite marks to include, by name or ID. Leave blank for none.
Outputs
age_ratingtext- Its age rating, such as PG-13
albumtext- For a song, its album
album_artisttext- For a song or album, the album's artist
artistslist- For a song or album, its artists
child_countnumber- For a show, album or folder, how many things are in it
community_ratingnumber- Its rating out of 10; 0 for none
containertext- Its file's format, such as mkv
date_addedtext- When it was added to Emby (UTC)
episode_numbernumber- For an episode, its number; 0 otherwise
favouritetrue/false- Whether it is one of the user's favourites; false when no user was given
genreslist- Its genres
idtext- The item's ID, for other Emby steps
imdb_idtext- Its IMDb ID, when Emby has one
last_played_attext- When the user last played it (UTC)
nametext- Its title
overviewtext- Its summary
pathtext- Where its file or folder is on the server
peoplelist- Its cast and crew
play_countnumber- How many times the user has played it
playedtrue/false- Whether the user has played it; false when no user was given
progress_percentnumber- How far through it the user is, 0 to 100
release_datetext- When it was first released (UTC)
runtime_minutesnumber- How long it runs, in minutes
season_numbernumber- For an episode, its season; 0 otherwise
show_idtext- For an episode, its show's ID
show_nametext- For an episode, its show
sizenumber- Its file's size in bytes
studioslist- Its studios
taglinetext- Its tagline
tagslist- Its tags
tmdb_idtext- Its TMDb ID, when Emby has one
typetext- What it is, as Emby names it: Movie, Series, Episode, MusicAlbum, Audio (a song), MusicArtist, BoxSet (a collection), Playlist and so on
web_urltext- A link to it in Emby
yearnumber- The year it came out; 0 when Emby doesn't know
Example output
{
"age_rating": "PG",
"album": "",
"album_artist": "",
"artists": [],
"child_count": 0,
"community_rating": 7.4,
"container": "mp4",
"date_added": "2026-11-12T22:36:10Z",
"episode_number": 0,
"favourite": true,
"genres": [
"Drama",
"Mystery"
],
"id": "12",
"imdb_id": "tt0111161",
"last_played_at": "",
"name": "Harbor Lights",
"overview": "A lighthouse keeper's last winter.",
"path": "/media/movies/Harbor Lights (2019)/Harbor Lights (2019).mp4",
"people": [
{
"name": "Ada Lovell",
"role": "The keeper",
"type": "Actor"
},
{
"name": "June Okafor",
"role": "",
"type": "Director"
}
],
"play_count": 0,
"played": false,
"progress_percent": 0.0,
"release_date": "2019-03-08T00:00:00Z",
"runtime_minutes": 104.0,
"season_number": 0,
"show_id": "",
"show_name": "",
"size": 1482031104,
"studios": [
"Northlight Pictures"
],
"tagline": "Keep the light on.",
"tags": [
"family-night"
],
"tmdb_id": "278",
"type": "Movie",
"web_url": "http://192.168.1.20:8096/web/index.html#!/item?id=12&serverId=c82de17ac3364560b5f0d5371f9d82d6",
"year": 2019
}Get server info
Get the server's name, version, whether an update or restart is waiting, and how many films, shows, episodes, albums and songs it has.
Inputs
None.
Outputs
album_countnumber- How many albums
episode_countnumber- How many episodes
idtext- The server's ID
local_addresstext- Its address on the home network, when Emby knows it
movie_countnumber- How many movies it has
nametext- Its name
operating_systemtext- What it runs on
remote_addresstext- Its address from outside, when remote access is set up
restart_neededtrue/false- Whether it needs a restart, such as after a plugin update
show_countnumber- How many shows
song_countnumber- How many songs
update_availabletrue/false- Whether a newer Emby Server is waiting
versiontext- Its Emby Server version
Example output
{
"album_count": 96,
"episode_count": 1840,
"id": "c82de17ac3364560b5f0d5371f9d82d6",
"local_address": "http://192.168.1.20:8096",
"movie_count": 412,
"name": "Living room",
"operating_system": "Linux",
"remote_address": "https://emby.example.com",
"restart_needed": false,
"show_count": 37,
"song_count": 1103,
"update_available": false,
"version": "4.10.2.0"
}List activity
Read Emby's activity log, newest first: who signed in or failed to, what was played, users added and removed, plugin and server updates.
Inputs
- Type
activity_typetext - Only entries of this type.One of:
any(Anything),playback.start(Playback started),playback.stop(Playback stopped),user.authenticated(Signed in),user.authenticationfailed(Sign-in failed),user.lockedout(User locked out),user.created(User created),user.deleted(User deleted),user.passwordchanged(Password changed),user.policyupdated(User's access changed), and 7 more. Default:any. - Since
sincedate and time - Only entries from this date and time on.
- Results
limitnumber - How many to return, up to 200. Defaults to 25.From 1 to 200.
Outputs
countnumber- How many
entrieslist- The entries, newest first
Example output
{
"count": 1,
"entries": [
{
"date": "2026-11-14T21:16:00Z",
"id": "11",
"item_id": "12",
"name": "sam is playing Harbor Lights on Chrome Windows",
"overview": "",
"severity": "Info",
"type": "playback.start"
}
]
}List collection items
List what is in a collection.
Inputs
- Collection
collectiontextRequired - The collection, by name or ID, or one an earlier step made.
- Results
limitnumber - How many to return, up to 200. Defaults to 25.From 1 to 200.
Outputs
collection_idtext- The collection's ID
collection_nametext- Its name
countnumber- How many
itemslist- What is in it
Example output
{
"collection_id": "48",
"collection_name": "Harbor films",
"count": 1,
"items": [
{
"age_rating": "PG",
"album": "",
"album_artist": "",
"artists": [],
"community_rating": 7.4,
"date_added": "2026-11-12T22:36:10Z",
"episode_number": 0,
"favourite": true,
"genres": [
"Drama",
"Mystery"
],
"id": "12",
"imdb_id": "tt0111161",
"last_played_at": "",
"name": "Harbor Lights",
"overview": "A lighthouse keeper's last winter.",
"path": "/media/movies/Harbor Lights (2019)/Harbor Lights (2019).mp4",
"play_count": 0,
"played": false,
"progress_percent": 0.0,
"release_date": "2019-03-08T00:00:00Z",
"runtime_minutes": 104.0,
"season_number": 0,
"show_id": "",
"show_name": "",
"tags": [
"family-night"
],
"tmdb_id": "278",
"type": "Movie",
"web_url": "http://192.168.1.20:8096/web/index.html#!/item?id=12&serverId=c82de17ac3364560b5f0d5371f9d82d6",
"year": 2019
}
]
}List collections
List the server's collections, such as a film series kept together.
Inputs
None.
Outputs
collectionslist- The collections, by name
countnumber- How many
Example output
{
"collections": [
{
"created_at": "2026-11-12T22:36:10Z",
"id": "48",
"name": "Harbor films",
"overview": "",
"runtime_minutes": 0.0,
"web_url": "http://192.168.1.20:8096/web/index.html#!/item?id=48&serverId=c82de17ac3364560b5f0d5371f9d82d6"
}
],
"count": 1
}List continue watching
List what a user is partway through, as Emby's Continue Watching row shows it, with how far they got.
Inputs
- User
usertext - Whose viewing this is about, by name or ID. Leave blank when the server has one user.
- What
mediatext - Video, audio (such as audiobooks) or both.One of:
video,audio,all(Both). Default:video. - Results
limitnumber - How many to return, up to 200. Defaults to 25.From 1 to 200.
Outputs
countnumber- How many
itemslist- The items, in Emby's order
user_nametext- Whose they are
Example output
{
"count": 1,
"items": [
{
"age_rating": "PG",
"album": "",
"album_artist": "",
"artists": [],
"community_rating": 7.4,
"date_added": "2026-11-12T22:36:10Z",
"episode_number": 1,
"favourite": false,
"genres": [
"Drama"
],
"id": "27",
"imdb_id": "",
"last_played_at": "",
"name": "The Lamplighter",
"overview": "A stranger moves in at number nine.",
"path": "/media/tv/Lantern Street/Season 01/Lantern Street - S01E01.mp4",
"play_count": 0,
"played": false,
"progress_percent": 41.5,
"release_date": "2024-09-02T00:00:00Z",
"runtime_minutes": 42.0,
"season_number": 1,
"show_id": "23",
"show_name": "Lantern Street",
"tags": [],
"tmdb_id": "",
"type": "Episode",
"web_url": "http://192.168.1.20:8096/web/index.html#!/item?id=27&serverId=c82de17ac3364560b5f0d5371f9d82d6",
"year": 2024
}
],
"user_name": "sam"
}List devices
List the devices and apps that have signed in to Emby, with who last used each and when.
Inputs
None.
Outputs
countnumber- How many
deviceslist- The devices that have signed in
Example output
{
"count": 1,
"devices": [
{
"app": "Emby Web",
"app_version": "4.10.2.0",
"id": "4",
"last_activity_at": "2026-11-14T21:40:00Z",
"last_user_id": "b3f34c08a38848c5818c168153ff70c2",
"last_user_name": "sam",
"name": "Chrome Windows"
}
]
}List libraries
List the server's libraries, with what each holds and the folders it reads.
Inputs
None.
Outputs
countnumber- How many
librarieslist- The server's libraries
Example output
{
"count": 2,
"libraries": [
{
"folders": [
"/media/movies"
],
"id": "3",
"name": "Movies",
"type": "Movies",
"web_url": "http://192.168.1.20:8096/web/index.html#!/item?id=3&serverId=c82de17ac3364560b5f0d5371f9d82d6"
},
{
"folders": [
"/media/tv"
],
"id": "5",
"name": "TV Shows",
"type": "Shows",
"web_url": "http://192.168.1.20:8096/web/index.html#!/item?id=5&serverId=c82de17ac3364560b5f0d5371f9d82d6"
}
]
}List next up
List the next episode of each show a user is watching, as Emby's Next Up row shows it.
Inputs
- User
usertext - Whose viewing this is about, by name or ID. Leave blank when the server has one user.
- Show
showtext - Only this show: its exact name, its link from Emby or its ID. Leave blank for every show.
- Results
limitnumber - How many to return, up to 200. Defaults to 25.From 1 to 200.
Outputs
countnumber- How many
itemslist- The items, in Emby's order
user_nametext- Whose they are
Example output
{
"count": 1,
"items": [
{
"age_rating": "PG",
"album": "",
"album_artist": "",
"artists": [],
"community_rating": 7.4,
"date_added": "2026-11-12T22:36:10Z",
"episode_number": 1,
"favourite": false,
"genres": [
"Drama"
],
"id": "27",
"imdb_id": "",
"last_played_at": "",
"name": "The Lamplighter",
"overview": "A stranger moves in at number nine.",
"path": "/media/tv/Lantern Street/Season 01/Lantern Street - S01E01.mp4",
"play_count": 0,
"played": false,
"progress_percent": 41.5,
"release_date": "2024-09-02T00:00:00Z",
"runtime_minutes": 42.0,
"season_number": 1,
"show_id": "23",
"show_name": "Lantern Street",
"tags": [],
"tmdb_id": "",
"type": "Episode",
"web_url": "http://192.168.1.20:8096/web/index.html#!/item?id=27&serverId=c82de17ac3364560b5f0d5371f9d82d6",
"year": 2024
}
],
"user_name": "sam"
}List playlist items
List what is in a playlist, in its order.
Inputs
- Playlist
playlisttextRequired - The playlist, by name or ID, or one an earlier step made.
- Results
limitnumber - How many to return, up to 200. Defaults to 25.From 1 to 200.
Outputs
countnumber- How many
itemslist- What is in it, in order
playlist_idtext- The playlist's ID
playlist_nametext- Its name
Example output
{
"count": 1,
"items": [
{
"age_rating": "PG",
"album": "",
"album_artist": "",
"artists": [],
"community_rating": 7.4,
"date_added": "2026-11-12T22:36:10Z",
"episode_number": 0,
"favourite": true,
"genres": [
"Drama",
"Mystery"
],
"id": "12",
"imdb_id": "tt0111161",
"last_played_at": "",
"name": "Harbor Lights",
"overview": "A lighthouse keeper's last winter.",
"path": "/media/movies/Harbor Lights (2019)/Harbor Lights (2019).mp4",
"play_count": 0,
"played": false,
"progress_percent": 0.0,
"release_date": "2019-03-08T00:00:00Z",
"runtime_minutes": 104.0,
"season_number": 0,
"show_id": "",
"show_name": "",
"tags": [
"family-night"
],
"tmdb_id": "278",
"type": "Movie",
"web_url": "http://192.168.1.20:8096/web/index.html#!/item?id=12&serverId=c82de17ac3364560b5f0d5371f9d82d6",
"year": 2019
}
],
"playlist_id": "45",
"playlist_name": "Friday night"
}List playlists
List the server's playlists.
Inputs
None.
Outputs
countnumber- How many
playlistslist- The playlists, by name
Example output
{
"count": 1,
"playlists": [
{
"created_at": "2026-11-12T22:36:10Z",
"id": "45",
"name": "Friday night",
"overview": "",
"runtime_minutes": 208.0,
"web_url": "http://192.168.1.20:8096/web/index.html#!/item?id=45&serverId=c82de17ac3364560b5f0d5371f9d82d6"
}
]
}List recently added
List what was added to Emby lately, newest first: films, episodes and albums, or one kind, in every library or one.
Inputs
- Kind
item_typetext - Only this kind of item. Any lists films, episodes and albums.One of:
any,movies,shows,episodes,albums,artists,songs,music_videos(Music videos),other_videos(Home videos),collections, and 4 more. Default:any. - Library
librarytext - Only this library, by name or ID. Leave blank for all of them.
- Added after
added_afterdate and time - Only items added to Emby after this date and time.
- User
usertext - Whose played and favourite marks to include, by name or ID. Leave blank for none.
- Results
limitnumber - How many to return, up to 200. Defaults to 25.From 1 to 200.
Outputs
countnumber- How many
itemslist- The items, newest added first
Example output
{
"count": 2,
"items": [
{
"age_rating": "PG",
"album": "",
"album_artist": "",
"artists": [],
"community_rating": 7.4,
"date_added": "2026-11-12T22:36:10Z",
"episode_number": 1,
"favourite": false,
"genres": [
"Drama"
],
"id": "27",
"imdb_id": "",
"last_played_at": "",
"name": "The Lamplighter",
"overview": "A stranger moves in at number nine.",
"path": "/media/tv/Lantern Street/Season 01/Lantern Street - S01E01.mp4",
"play_count": 0,
"played": false,
"progress_percent": 0.0,
"release_date": "2024-09-02T00:00:00Z",
"runtime_minutes": 42.0,
"season_number": 1,
"show_id": "23",
"show_name": "Lantern Street",
"tags": [],
"tmdb_id": "",
"type": "Episode",
"web_url": "http://192.168.1.20:8096/web/index.html#!/item?id=27&serverId=c82de17ac3364560b5f0d5371f9d82d6",
"year": 2024
},
{
"age_rating": "PG",
"album": "",
"album_artist": "",
"artists": [],
"community_rating": 7.4,
"date_added": "2026-11-12T22:36:10Z",
"episode_number": 0,
"favourite": true,
"genres": [
"Drama",
"Mystery"
],
"id": "12",
"imdb_id": "tt0111161",
"last_played_at": "",
"name": "Harbor Lights",
"overview": "A lighthouse keeper's last winter.",
"path": "/media/movies/Harbor Lights (2019)/Harbor Lights (2019).mp4",
"play_count": 0,
"played": false,
"progress_percent": 0.0,
"release_date": "2019-03-08T00:00:00Z",
"runtime_minutes": 104.0,
"season_number": 0,
"show_id": "",
"show_name": "",
"tags": [
"family-night"
],
"tmdb_id": "278",
"type": "Movie",
"web_url": "http://192.168.1.20:8096/web/index.html#!/item?id=12&serverId=c82de17ac3364560b5f0d5371f9d82d6",
"year": 2019
}
]
}List scheduled tasks
List Emby's scheduled tasks, such as Scan media library, with whether each is running and how its last run ended.
Inputs
- Include hidden
include_hiddentrue/false - Also list the housekeeping tasks Emby hides from its Scheduled Tasks page.Default:
false.
Outputs
countnumber- How many
taskslist- The scheduled tasks
Example output
{
"count": 1,
"tasks": [
{
"category": "Library",
"description": "Scans your media library for new files and refreshes metadata.",
"id": "6330ee8fb4a957f33981f89aa78b030f",
"is_hidden": false,
"key": "RefreshLibrary",
"last_error": "",
"last_finished_at": "2026-11-14T03:02:41Z",
"last_started_at": "2026-11-14T03:00:00Z",
"last_status": "Completed",
"name": "Scan media library",
"progress_percent": 0.0,
"state": "Idle"
}
]
}List sessions
List the apps and devices signed in to Emby and what each is playing now: who is watching what, how far in, and whether it is paused.
Inputs
- Playing only
playing_onlytrue/false - Only sessions that are playing something.Default:
false. - User
usertext - Only this user's sessions, by name or ID. Leave blank for everyone's.
Outputs
countnumber- How many
playing_countnumber- How many of them are playing something
sessionslist- The sessions: those that can be controlled first, then the most recently active
Example output
{
"count": 1,
"playing_count": 1,
"sessions": [
{
"app": "Emby Web",
"app_version": "4.10.2.0",
"can_be_controlled": true,
"device": "Chrome Windows",
"device_id": "a0ab28af-5644-4c5a-81b1-0db2d57ac34f",
"id": "dd4f087a76f7d20040016d1db9e770f0",
"is_paused": false,
"is_playing": true,
"item_id": "12",
"item_name": "Harbor Lights",
"item_type": "Movie",
"last_activity_at": "2026-11-14T21:40:00Z",
"play_method": "DirectStream",
"position_minutes": 23.7,
"runtime_minutes": 104.0,
"show_name": "",
"user_id": "b3f34c08a38848c5818c168153ff70c2",
"user_name": "sam"
}
]
}List users
List the server's users, with whether each is an administrator or disabled and when they were last active.
Inputs
None.
Outputs
countnumber- How many
userslist- The server's users
Example output
{
"count": 2,
"users": [
{
"all_libraries": true,
"can_delete": false,
"can_play": true,
"created_at": "2026-11-12T22:36:09Z",
"has_password": true,
"id": "b3f34c08a38848c5818c168153ff70c2",
"is_admin": true,
"is_disabled": false,
"is_hidden": false,
"last_activity_at": "2026-11-14T21:40:00Z",
"last_login_at": "2026-11-14T19:02:11Z",
"name": "admin",
"remote_access": true
},
{
"all_libraries": true,
"can_delete": false,
"can_play": true,
"created_at": "2026-11-12T22:36:09Z",
"has_password": true,
"id": "b3f34c08a38848c5818c168153ff70c2",
"is_admin": false,
"is_disabled": false,
"is_hidden": false,
"last_activity_at": "2026-11-14T21:40:00Z",
"last_login_at": "2026-11-14T19:02:11Z",
"name": "sam",
"remote_access": true
}
]
}Mark as played
Mark a film, episode or song as played for a user; a show or album marks everything in it.
Inputs
- Item
itemtextRequired - The film, show, episode, song or album: its exact name, its link from Emby, or the ID an earlier step found, such as Search media.
- User
usertext - Whose viewing this is about, by name or ID. Leave blank when the server has one user.
- Played at
played_atdate and time - When they played it. Leave blank for now.
Outputs
favouritetrue/false- Whether it is now one of their favourites
idtext- The item's ID
last_played_attext- When they last played it (UTC)
nametext- Its title
play_countnumber- How many times they have played it
playedtrue/false- Whether the user has now played it
typetext- What it is, such as Movie
user_idtext- The user's ID
user_nametext- The user's name
web_urltext- A link to it in Emby
Example output
{
"favourite": false,
"id": "12",
"last_played_at": "2026-11-12T22:36:10Z",
"name": "Harbor Lights",
"play_count": 1,
"played": true,
"type": "Movie",
"user_id": "b3f34c08a38848c5818c168153ff70c2",
"user_name": "sam",
"web_url": "http://192.168.1.20:8096/web/index.html#!/item?id=12&serverId=c82de17ac3364560b5f0d5371f9d82d6"
}Mark as unplayed
Mark a film, episode or song as not played for a user, so it shows as new to them again.
Inputs
- Item
itemtextRequired - The film, show, episode, song or album: its exact name, its link from Emby, or the ID an earlier step found, such as Search media.
- User
usertext - Whose viewing this is about, by name or ID. Leave blank when the server has one user.
Outputs
favouritetrue/false- Whether it is now one of their favourites
idtext- The item's ID
last_played_attext- When they last played it (UTC)
nametext- Its title
play_countnumber- How many times they have played it
playedtrue/false- Whether the user has now played it
typetext- What it is, such as Movie
user_idtext- The user's ID
user_nametext- The user's name
web_urltext- A link to it in Emby
Example output
{
"favourite": false,
"id": "12",
"last_played_at": "2026-11-12T22:36:10Z",
"name": "Harbor Lights",
"play_count": 1,
"played": true,
"type": "Movie",
"user_id": "b3f34c08a38848c5818c168153ff70c2",
"user_name": "sam",
"web_url": "http://192.168.1.20:8096/web/index.html#!/item?id=12&serverId=c82de17ac3364560b5f0d5371f9d82d6"
}Play on a session
Have a player start playing a film, episode, song or several, now or after what it is playing.
Inputs
- Session
sessiontextRequired - The player: a session from List sessions, or the name of a user or device that is signed in on one.
- Items
itemstextRequired - One or more films, episodes or songs: exact names, links from Emby or IDs from an earlier step, separated by commas.
- When
play_modetext - Play it now, next, or at the end of the player's queue.One of:
play_now(Play now),play_next(Play next),play_last(Add to the end of the queue). Default:play_now.
Outputs
countnumber- How many items
devicetext- The device's name
itemslist- What it was asked to play, in order
play_modetext- play_now, play_next or play_last
senttrue/false- True once Emby has passed it on
session_idtext- The session asked to play
user_nametext- Who is signed in there
Example output
{
"count": 1,
"device": "Chrome Windows",
"items": [
{
"id": "12",
"name": "Harbor Lights"
}
],
"play_mode": "play_now",
"sent": true,
"session_id": "dd4f087a76f7d20040016d1db9e770f0",
"user_name": "sam"
}Refresh metadata
Have Emby look up an item's details and pictures again, as Refresh Metadata does. For a show or album, everything in it too.
Inputs
- Item
itemtextRequired - The film, show, episode, song or album: its exact name, its link from Emby, or the ID an earlier step found, such as Search media.
- Replace existing details
replace_metadatatrue/false - Replace what Emby already has with what it finds. Off only fills in what is missing.Default:
false.
Outputs
idtext- The item's ID
nametext- Its title
refreshingtrue/false- True once Emby has started the refresh
typetext- What it is, such as Movie
web_urltext- A link to it in Emby
Example output
{
"id": "12",
"name": "Harbor Lights",
"refreshing": true,
"type": "Movie",
"web_url": "http://192.168.1.20:8096/web/index.html#!/item?id=12&serverId=c82de17ac3364560b5f0d5371f9d82d6"
}Remove from collection
Take films or shows out of a collection. The media itself stays in Emby.
Inputs
- Collection
collectiontextRequired - The collection, by name or ID, or one an earlier step made.
- Items
itemstextRequired - One or more films, episodes or songs: exact names, links from Emby or IDs from an earlier step, separated by commas.
Outputs
countnumber- How many were removed
created_attext- When it was made (UTC)
idtext- Its ID, for other Emby steps
nametext- Its name
overviewtext- Its description
removedlist- The items removed
runtime_minutesnumber- How long everything in it runs, in minutes
web_urltext- A link to it in Emby
Example output
{
"count": 1,
"created_at": "2026-11-12T22:36:10Z",
"id": "48",
"name": "Harbor films",
"overview": "",
"removed": [
{
"id": "12",
"name": "Harbor Lights"
}
],
"runtime_minutes": 0.0,
"web_url": "http://192.168.1.20:8096/web/index.html#!/item?id=48&serverId=c82de17ac3364560b5f0d5371f9d82d6"
}Remove from favourites
Take an item out of a user's favourites.
Inputs
- Item
itemtextRequired - The film, show, episode, song or album: its exact name, its link from Emby, or the ID an earlier step found, such as Search media.
- User
usertext - Whose viewing this is about, by name or ID. Leave blank when the server has one user.
Outputs
favouritetrue/false- Whether it is now one of their favourites
idtext- The item's ID
last_played_attext- When they last played it (UTC)
nametext- Its title
play_countnumber- How many times they have played it
playedtrue/false- Whether the user has now played it
typetext- What it is, such as Movie
user_idtext- The user's ID
user_nametext- The user's name
web_urltext- A link to it in Emby
Example output
{
"favourite": false,
"id": "12",
"last_played_at": "2026-11-12T22:36:10Z",
"name": "Harbor Lights",
"play_count": 1,
"played": true,
"type": "Movie",
"user_id": "b3f34c08a38848c5818c168153ff70c2",
"user_name": "sam",
"web_url": "http://192.168.1.20:8096/web/index.html#!/item?id=12&serverId=c82de17ac3364560b5f0d5371f9d82d6"
}Remove from playlist
Take films, episodes or songs out of a playlist. The media itself stays in Emby.
Inputs
- Playlist
playlisttextRequired - The playlist, by name or ID, or one an earlier step made.
- Items
itemstextRequired - One or more films, episodes or songs: exact names, links from Emby or IDs from an earlier step, separated by commas.
Outputs
countnumber- How many were removed
created_attext- When it was made (UTC)
idtext- Its ID, for other Emby steps
nametext- Its name
overviewtext- Its description
removedlist- The items removed
runtime_minutesnumber- How long everything in it runs, in minutes
web_urltext- A link to it in Emby
Example output
{
"count": 1,
"created_at": "2026-11-12T22:36:10Z",
"id": "45",
"name": "Friday night",
"overview": "",
"removed": [
{
"id": "12",
"name": "Harbor Lights"
}
],
"runtime_minutes": 208.0,
"web_url": "http://192.168.1.20:8096/web/index.html#!/item?id=45&serverId=c82de17ac3364560b5f0d5371f9d82d6"
}Run a scheduled task
Start one of Emby's scheduled tasks now, as its play button does. One already running is left to finish.
Inputs
- Task
tasktextRequired - The task, by name or ID, such as Scan media library.
Outputs
categorytext- Where Emby files it, such as Library
descriptiontext- What it does
idtext- The task's ID
is_hiddentrue/false- Whether Emby hides it from its Scheduled Tasks page
keytext- Emby's short name for it, such as RefreshLibrary
last_errortext- What went wrong in its last run, if it failed
last_finished_attext- When its last run ended (UTC)
last_started_attext- When its last run started (UTC)
last_statustext- How its last run ended: Completed, Failed, Cancelled or Aborted
nametext- Its name, such as Scan media library
progress_percentnumber- How far through it is while running
startedtrue/false- True when this step started it; false if it was running
statetext- Idle, Running or Cancelling
Example output
{
"category": "Library",
"description": "Scans your media library for new files and refreshes metadata.",
"id": "6330ee8fb4a957f33981f89aa78b030f",
"is_hidden": false,
"key": "RefreshLibrary",
"last_error": "",
"last_finished_at": "2026-11-14T03:02:41Z",
"last_started_at": "2026-11-14T03:00:00Z",
"last_status": "Completed",
"name": "Scan media library",
"progress_percent": 0.0,
"started": true,
"state": "Running"
}Scan library
Have Emby look through its libraries' folders for new, changed and removed files, as Scan Library Files does, such as after a download lands.
Inputs
- Library
librarytext - Only this library, by name or ID. Leave blank to scan them all.
- Wait for it
waittrue/false - Wait up to a minute for a scan of every library to finish. Off, or for one library, the step only starts it.Default:
true.
Outputs
finishedtrue/false- Whether the scan finished while the step waited
library_idtext- The library scanned; empty for every library
library_nametext- Its name; empty for every library
statustext- finished, or started when it is still running
Example output
{
"finished": true,
"library_id": "",
"library_name": "",
"status": "finished"
}Search media
Find films, shows, episodes, albums and songs: by words in the title, kind, library, genre, tag, year, when they were added, and whether a user has played them or made them a favourite.
Inputs
- Title contains
search_texttext - Words to look for in the title. Leave blank to list everything that fits the rest.
- Kind
item_typetext - Only this kind of item.One of:
any,movies,shows,episodes,albums,artists,songs,music_videos(Music videos),other_videos(Home videos),collections, and 4 more. Default:any. - Library
librarytext - Only this library, by name or ID. Leave blank for all of them.
- Genres
genrestext - Only items of any of these genres, separated by commas.
- Tags
tagstext - Only items with any of these tags, separated by commas.
- From year
year_fromnumber - Only items from this year on.From 1800 to 2200.
- To year
year_tonumber - Only items up to this year.From 1800 to 2200.
- Played
playedtext - Only items the user has played, or hasn't. Needs a user.One of:
any,unplayed,played. Default:any. - Favourites only
favourites_onlytrue/false - Only the user's favourites. Needs a user.Default:
false. - Added after
added_afterdate and time - Only items added to Emby after this date and time.
- User
usertext - Whose played and favourite marks to use, by name or ID. Leave blank when the server has one user, or when neither matters.
- Sort by
sorttext - The order to list them in.One of:
name,recently_added(Newest added first),newest(Newest released first),oldest(Oldest released first),top_rated(Top rated),recently_played(Most recently played),most_played(Most played),shortest(Shortest first),random. Default:name. - Results
limitnumber - How many to return, up to 200. Defaults to 25.From 1 to 200.
- Page
pagenumber - Which page of results: 2 for the next lot after the first, and so on.From 1 to 10000.
Outputs
countnumber- How many are on this page
has_moretrue/false- Whether there are more pages
itemslist- The items found, in the order asked for
pagenumber- Which page this is
totalnumber- How many match in all
Example output
{
"count": 2,
"has_more": false,
"items": [
{
"age_rating": "PG",
"album": "",
"album_artist": "",
"artists": [],
"community_rating": 7.4,
"date_added": "2026-11-12T22:36:10Z",
"episode_number": 0,
"favourite": true,
"genres": [
"Drama",
"Mystery"
],
"id": "12",
"imdb_id": "tt0111161",
"last_played_at": "",
"name": "Harbor Lights",
"overview": "A lighthouse keeper's last winter.",
"path": "/media/movies/Harbor Lights (2019)/Harbor Lights (2019).mp4",
"play_count": 0,
"played": false,
"progress_percent": 0.0,
"release_date": "2019-03-08T00:00:00Z",
"runtime_minutes": 104.0,
"season_number": 0,
"show_id": "",
"show_name": "",
"tags": [
"family-night"
],
"tmdb_id": "278",
"type": "Movie",
"web_url": "http://192.168.1.20:8096/web/index.html#!/item?id=12&serverId=c82de17ac3364560b5f0d5371f9d82d6",
"year": 2019
},
{
"age_rating": "PG",
"album": "",
"album_artist": "",
"artists": [],
"community_rating": 7.4,
"date_added": "2026-11-12T22:36:10Z",
"episode_number": 1,
"favourite": false,
"genres": [
"Drama"
],
"id": "27",
"imdb_id": "",
"last_played_at": "",
"name": "The Lamplighter",
"overview": "A stranger moves in at number nine.",
"path": "/media/tv/Lantern Street/Season 01/Lantern Street - S01E01.mp4",
"play_count": 0,
"played": false,
"progress_percent": 0.0,
"release_date": "2024-09-02T00:00:00Z",
"runtime_minutes": 42.0,
"season_number": 1,
"show_id": "23",
"show_name": "Lantern Street",
"tags": [],
"tmdb_id": "",
"type": "Episode",
"web_url": "http://192.168.1.20:8096/web/index.html#!/item?id=27&serverId=c82de17ac3364560b5f0d5371f9d82d6",
"year": 2024
}
],
"page": 1,
"total": 2
}Send message to a session
Show a message on a player's screen, such as that dinner is ready or the server is going down for maintenance.
Inputs
- Session
sessiontextRequired - The player: a session from List sessions, or the name of a user or device that is signed in on one.
- Message
texttextRequired - What to say.
- Heading
headertext - A short heading above it. Defaults to Message.
- Show for (seconds)
timeout_secondsnumber - How long it stays up. Defaults to 10.From 1 to 300.
Outputs
apptext- The app, such as Emby Web or Emby for Android
app_versiontext- The app's version
can_be_controlledtrue/false- Whether it takes messages and playback commands
devicetext- The device's name
device_idtext- The device's own ID
idtext- The session's ID, for Send message, Control playback and Play
is_pausedtrue/false- Whether what it is playing is paused
is_playingtrue/false- Whether it is playing something (paused counts)
item_idtext- The ID of what is playing; empty when idle
item_nametext- The title of what is playing
item_typetext- What is playing, such as Movie or Episode
last_activity_attext- When it was last heard from (UTC)
play_methodtext- DirectPlay, DirectStream or Transcode
position_minutesnumber- How far in it is, in minutes
runtime_minutesnumber- How long what is playing runs, in minutes
senttrue/false- True once Emby has passed it on
show_nametext- For an episode, its show
user_idtext- The ID of the user signed in
user_nametext- Their name
Example output
{
"app": "Emby Web",
"app_version": "4.10.2.0",
"can_be_controlled": true,
"device": "Chrome Windows",
"device_id": "a0ab28af-5644-4c5a-81b1-0db2d57ac34f",
"id": "dd4f087a76f7d20040016d1db9e770f0",
"is_paused": false,
"is_playing": true,
"item_id": "12",
"item_name": "Harbor Lights",
"item_type": "Movie",
"last_activity_at": "2026-11-14T21:40:00Z",
"play_method": "DirectStream",
"position_minutes": 23.7,
"runtime_minutes": 104.0,
"sent": true,
"show_name": "",
"user_id": "b3f34c08a38848c5818c168153ff70c2",
"user_name": "sam"
}Update an item
Change an item's name, overview, genres, tags or year. Only the fields filled in change; genres and tags given replace the ones it had.
Inputs
- Item
itemtextRequired - The film, show, episode, song or album: its exact name, its link from Emby, or the ID an earlier step found, such as Search media.
- Name
nametext - Its new title.
- Overview
overviewtext - Its new summary.
- Genres
genrestext - Its genres, separated by commas. They replace the ones it has.
- Tags
tagstext - Its tags, separated by commas. They replace the ones it has.
- Year
yearnumber - The year it came out.From 1800 to 2200.
Outputs
age_ratingtext- Its age rating, such as PG-13
albumtext- For a song, its album
album_artisttext- For a song or album, the album's artist
artistslist- For a song or album, its artists
community_ratingnumber- Its rating out of 10; 0 for none
date_addedtext- When it was added to Emby (UTC)
episode_numbernumber- For an episode, its number; 0 otherwise
favouritetrue/false- Whether it is one of the user's favourites; false when no user was given
genreslist- Its genres
idtext- The item's ID, for other Emby steps
imdb_idtext- Its IMDb ID, when Emby has one
last_played_attext- When the user last played it (UTC)
nametext- Its title
overviewtext- Its summary
pathtext- Where its file or folder is on the server
play_countnumber- How many times the user has played it
playedtrue/false- Whether the user has played it; false when no user was given
progress_percentnumber- How far through it the user is, 0 to 100
release_datetext- When it was first released (UTC)
runtime_minutesnumber- How long it runs, in minutes
season_numbernumber- For an episode, its season; 0 otherwise
show_idtext- For an episode, its show's ID
show_nametext- For an episode, its show
tagslist- Its tags
tmdb_idtext- Its TMDb ID, when Emby has one
typetext- What it is, as Emby names it: Movie, Series, Episode, MusicAlbum, Audio (a song), MusicArtist, BoxSet (a collection), Playlist and so on
web_urltext- A link to it in Emby
yearnumber- The year it came out; 0 when Emby doesn't know
Example output
{
"age_rating": "PG",
"album": "",
"album_artist": "",
"artists": [],
"community_rating": 7.4,
"date_added": "2026-11-12T22:36:10Z",
"episode_number": 0,
"favourite": true,
"genres": [
"Drama",
"Mystery"
],
"id": "12",
"imdb_id": "tt0111161",
"last_played_at": "",
"name": "Harbor Lights",
"overview": "A lighthouse keeper's last winter.",
"path": "/media/movies/Harbor Lights (2019)/Harbor Lights (2019).mp4",
"play_count": 0,
"played": false,
"progress_percent": 0.0,
"release_date": "2019-03-08T00:00:00Z",
"runtime_minutes": 104.0,
"season_number": 0,
"show_id": "",
"show_name": "",
"tags": [
"family-night"
],
"tmdb_id": "278",
"type": "Movie",
"web_url": "http://192.168.1.20:8096/web/index.html#!/item?id=12&serverId=c82de17ac3364560b5f0d5371f9d82d6",
"year": 2019
}