Skip to content
Documentation
Contact
← Back to documentation
Technical Reference

Spotify

Music for everyone

CategoryOther
AuthenticationOAuth 2.0
Version0.6.0
Published scopes13 published scopes
Last updatedSeptember 24, 2026

Overview

Connect Spotify with Flows360

Music for everyone

Use the Spotify connector to include its declared actions and events in Flows360 workflows without duplicating the integration logic inside each consuming system. This pinned connector version currently exposes 15 actions and 1 trigger.

Available actions

  • Search
  • Get Playback State
  • Play / Resume
  • Pause
  • Set Volume
  • Get Playlists
  • Get Playlist Info
  • Get Playlist Items
  • Plus 7 additional declared actions.

Available triggers

  • Playlist Items Changed

The capability list above is generated from the exact reviewed connector package so the public description stays aligned with the version Flows360 operates.

Technical guide

Technical reference

Package identity

  • Connector: Spotify
  • Package: @activepieces/piece-spotify@0.6.0
  • Exact artifact digest: sha256:94eac6a601abcc32340e06e5778f5a4c3c1f01e861d457c2a0876a0118f71684
  • Runtime: Activepieces-compatible deterministic worker
  • Source: the exact reviewed Activepieces source

Authentication

OAUTH2. Connection values are tenant-specific and remain in the consuming Studio instance; CDK stores definitions and field metadata, not customer credential values.

Action contracts

  • Search (search), Searches for tracks, artists, albums, etc. Classification: read.
  • Get Playback State (get_playback_state), Retrieves the current playback state of the player Classification: read.
  • Play / Resume (play), Resumes or starts playback Classification: read.
  • Pause (pause), Pauses the playback Classification: read.
  • Set Volume (set_volume), Sets the volume of the player Classification: read.
  • Get Playlists (get_playlists), Retrieves the list of playlists that you created or followed Classification: read.
  • Get Playlist Info (get_playlist_info), Retrieves details of a playlist Classification: read.
  • Get Playlist Items (get_playlist_items), Retrieves the list of items in the playlist Classification: read.
  • Get Saved Tracks (get_saved_tracks), Retrieves the list of saved tracks for the current user Classification: read.
  • Create Playlist (create_playlist), Creates a new playlist for the current user Classification: read.
  • Update Playlist (update_playlist), Updates details of the playlist Classification: read.
  • Add items to playlist (add_playlist_items), Adds tracks or episodes to the playlist Classification: read.
  • Remove items from playlist (remove_playlist_items), Removes tracks or episodes from the playlist Classification: read.
  • Reorder playlist (reorder_playlist), Reorders items in the playlist Classification: read.
  • Custom API Call (custom_api_call), Make a custom API call to a specific endpoint Classification: read.

Trigger contracts

  • Playlist Items Changed, polling.

Verification

Deterministic execution evidence is recorded for the pinned artifact, including 1 exercised action entrypoint and 0 exercised trigger entrypoints.

Capability summary

AuthenticationOAuth 2.0
Supported objects16
Supported actions15
Triggers1

Authentication

Authentication method: OAuth 2.0

Required scopes

user-read-playback-stateuser-modify-playback-stateuser-read-currently-playinguser-read-playback-positionuser-read-recently-playedplaylist-read-privateplaylist-read-collaborativeplaylist-modify-privateplaylist-modify-publicuser-library-readuser-library-modifyuser-follow-readuser-follow-modify

Authentication profiles

connection · oauth2

OAuth scopes: user-read-playback-state, user-modify-playback-state, user-read-currently-playing, user-read-playback-position, user-read-recently-played, playlist-read-private, playlist-read-collaborative, playlist-modify-private, playlist-modify-public, user-library-read, user-library-modify, user-follow-read, user-follow-modify

Supported objects

ObjectReadWriteNotes
Search Yes No Searches for tracks, artists, albums, etc.
Get Playback State Yes No Retrieves the current playback state of the player
Play / Resume Yes No Resumes or starts playback
Pause Yes No Pauses the playback
Set Volume Yes No Sets the volume of the player
Get Playlists Yes No Retrieves the list of playlists that you created or followed
Get Playlist Info Yes No Retrieves details of a playlist
Get Playlist Items Yes No Retrieves the list of items in the playlist
Get Saved Tracks Yes No Retrieves the list of saved tracks for the current user
Create Playlist Yes No Creates a new playlist for the current user
Update Playlist Yes No Updates details of the playlist
Add items to playlist Yes No Adds tracks or episodes to the playlist
Remove items from playlist Yes No Removes tracks or episodes from the playlist
Reorder playlist Yes No Reorders items in the playlist
Custom API Call Yes No Make a custom API call to a specific endpoint
Playlist Items Changed Yes No polling trigger declared by the pinned package.

Supported actions

Search · Read

Searches for tracks, artists, albums, etc.

search · Risk: low · Retry: safe

Inputs

  • search_text · string · Required, The word or phrase you are searching for
  • types · array · Required
  • limit · number · Optional
  • offset · number · Optional
Get Playback State · Read

Retrieves the current playback state of the player

get_playback_state · Risk: low · Retry: safe

Play / Resume · Read

Resumes or starts playback

play · Risk: low · Retry: safe

Inputs

  • device_id · string · Optional
  • context_uri · string · Optional, Spotify URI of the context to play (album, artist, playlist)
  • tracks · array · Optional, List of spotify track uris to play
  • position_ms · number · Optional, Position in milliseconds
Pause · Read

Pauses the playback

pause · Risk: low · Retry: safe

Inputs

  • device_id · string · Optional
Set Volume · Read

Sets the volume of the player

set_volume · Risk: low · Retry: safe

Inputs

  • volume · number · Required, Volume from 0 to 100
  • device_id · string · Optional
Get Playlists · Read

Retrieves the list of playlists that you created or followed

get_playlists · Risk: low · Retry: safe

Inputs

  • offset · number · Optional
  • limit · number · Optional
  • all · boolean · Optional, Fetches all playlists in a single request
Get Playlist Info · Read

Retrieves details of a playlist

get_playlist_info · Risk: low · Retry: safe

Inputs

  • playlist_id · string · Required
Get Playlist Items · Read

Retrieves the list of items in the playlist

get_playlist_items · Risk: low · Retry: safe

Inputs

  • playlist_id · string · Required
  • offset · number · Optional
  • limit · number · Optional
  • all · boolean · Optional, Fetches all items in a single request
Get Saved Tracks · Read

Retrieves the list of saved tracks for the current user

get_saved_tracks · Risk: low · Retry: safe

Inputs

  • offset · number · Optional
  • limit · number · Optional
  • all · boolean · Optional, Fetches all items in a single request
Create Playlist · Read

Creates a new playlist for the current user

create_playlist · Risk: low · Retry: safe

Inputs

  • name · string · Required
  • description · string · Optional
  • public · boolean · Optional
  • collaborative · boolean · Optional
Update Playlist · Read

Updates details of the playlist

update_playlist · Risk: low · Retry: safe

Inputs

  • playlist_id · string · Required
  • name · string · Optional
  • description · string · Optional
  • public · boolean · Optional
  • collaborative · boolean · Optional
Add items to playlist · Read

Adds tracks or episodes to the playlist

add_playlist_items · Risk: low · Retry: safe

Inputs

  • playlist_id · string · Required
  • items · array · Required, URI's of the items to add
  • position · number · Optional
Remove items from playlist · Read

Removes tracks or episodes from the playlist

remove_playlist_items · Risk: low · Retry: safe

Inputs

  • playlist_id · string · Required
  • items · array · Required, URI's of the items to remove
Reorder playlist · Read

Reorders items in the playlist

reorder_playlist · Risk: low · Retry: safe

Inputs

  • playlist_id · string · Required
  • from_position · number · Required
  • to_position · number · Required
  • amount · number · Optional
Custom API Call · Read

Make a custom API call to a specific endpoint

custom_api_call · Risk: low · Retry: safe

Inputs

  • url · object · Required
  • method · string · Required
  • headers · object · Optional, Authorization headers are injected automatically from your connection.
  • queryParams · object · Optional, Appended to the URL as ?key=value.
  • body_type · string · Optional
  • body · object · Optional
  • response_is_binary · boolean · Optional, Enable for files like PDFs, images, etc.
  • failsafe · boolean · Optional, On a failed request, output the error instead of failing the step.
  • timeout · number · Optional, Seconds to wait for a response. Empty: up to the flow limit (10 min).
  • followRedirects · boolean · Optional, Follow 3xx redirects instead of returning them as the response.

Triggers

Playlist Items Changed · Poll

Triggers when the items of a playlist change

Inputs

  • playlist_id · string

Setup

Setup

  1. Add the Spotify connector to the workflow in the target Flows360 Studio instance.
  2. Create or select the tenant-specific connection required by the connector. Connection secrets remain in the Studio connection boundary and are not copied into CDK documentation.
  3. Provide the connection fields declared by the pinned package:
  • No provider credential fields are declared by the pinned package.

OAuth scopes

  • user-read-playback-state
  • user-modify-playback-state
  • user-read-currently-playing
  • user-read-playback-position
  • user-read-recently-played
  • playlist-read-private
  • playlist-read-collaborative
  • playlist-modify-private
  • playlist-modify-public
  • user-library-read
  • user-library-modify
  • user-follow-read
  • user-follow-modify
  1. Select the required action or trigger and complete its declared input fields. Required and optional inputs are defined by the exact package schema.
  2. Test the workflow in the appropriate environment before enabling production scheduling or event delivery.

Limitations

Limitations and operational notes

  • This content describes @activepieces/piece-spotify@0.6.0; provider behaviour can change independently and should be revalidated when the provider or connector version changes.
  • Only the 15 actions and 1 trigger declared by this pinned package are represented here.
  • Tenant credentials and connection values are not stored in the public connector record.
  • Provider-side permissions, account entitlements, quotas and rate limits remain subject to the connected provider account and are not inferred when the package does not declare them.
  • Deterministic execution evidence is recorded for the pinned artifact, including 1 exercised action entrypoint and 0 exercised trigger entrypoints.

Troubleshooting

Why canu2019t the connector authenticate?

Check the tenant connection in Studio and confirm every required Spotify connection field is present. Re-authorise OAuth-based connections if the provider token or consent has expired. Do not place credential values in CDK content or logs.

Why is an action or trigger unavailable?

Confirm that the workflow is using @activepieces/piece-spotify@0.6.0 and compare the requested capability with the declared action and trigger list for this version. A capability that is not declared by the pinned package should not be presented as supported.

What should I check after a provider-side change?

Revalidate authentication, required fields, action/trigger behaviour and provider documentation before publishing refreshed connector content or moving a new package version into production.

github.com