Skip to main content

Playlist Webhooks

playlist.created​

  • Event for when a playlist is created.
  • Event payload:
{
  "eventTime": "2024-07-18T07:55:45.7306037Z",
  "eventType": "playlist.created",
  "data": {
    "PublicId": "{PublicId}",
    "Title": "{Title}",
    "PlayListTypeId": 1,
    "IncludeTags": [],
    "ExcludeTags": [],
    "IncludeTagsState": false,
    "ExcludeTagsState": false,
    "Folders": [],
    "ExcludeFlags": [],
    "IncludeFlags": [],
    "IncludeAllProjects": false,
    "IncludeProjects": [],
    "ExcludeFlagsState": false,
    "IncludeFlagsState": false,
    "CanEmbed": true
  },
  "projectId": "{projectId}"
}

playlist.updated​

  • Event for when a playlist was updated.
  • Event payload:
{
  "eventTime": "2024-07-18T07:55:52.253982Z",
  "eventType": "playlist.updated",
  "data": {
    "PublicId": "{PublicId}",
    "Title": "{Title}",
    "Description": "",
    "PlayListTypeId": 1,
    "PlaylistDisplayTypeId": 1,
    "PlaylistSortOptionId": 1,
    "IncludeTags": [],
    "ExcludeTags": [],
    "IncludeTagsState": false,
    "ExcludeTagsState": false,
    "Folders": [],
    "ExcludeFlags": [],
    "IncludeFlags": [],
    "IncludeAllProjects": false,
    "IncludeProjects": [],
    "ExcludeFlagsState": false,
    "IncludeFlagsState": false,
    "IncludeTagModeId": 1,
    "ExcludeTagModeId": 1,
    "IncludeFlagModeId": 1,
    "ExcludeFlagModeId": 1,
    "MaxVideos": 10,
    "AspectRatioTypeId": 0,
    "CanEmbed": true,
    "AspectRatios": [],
    "PlaylistType": {
      "Id": 1,
      "Name": "Manual",
      "Value": "MANUAL",
      "Description": "Select videos manually from your library"
    },
    "playlistFolders": [
      {
        "FolderId": 0,
        "IncludeFutureSubfolders": false
      }
    ]
  },
  "projectId": "{projectId}"
}

The payload carries the folder selection in both contract versions. Folders is the flat list of folder IDs used by API V1, while playlistFolders is the structured selection used by API V2, where IncludeFutureSubfolders marks a folder whose current and future subfolders are included in the playlist automatically. Both fields are sent regardless of which API version performed the update, and playlistFolders contains only the folders that were saved, not the subfolders resolved from them.

Deprecated fields

AspectRatioTypeId is deprecated and will be removed from the playlist payloads in the future. Use the AspectRatios list instead.

Folders belongs to the API V1 contract and will go out of support together with it. New integrations should read the folder selection from playlistFolders instead.

playlist.deleted​

  • Event for when a playlist has been deleted.
  • Event payload:
{
  "eventTime": "2024-07-18T07:59:11.883551Z",
  "eventType": "playlist.deleted",
  "data": {
  "Id": "{Id}"
  },
  "projectId": "{projectId}"
}