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,
    "PlaylistType": {
      "Id": 1,
      "Name": "Manual",
      "Value": "MANUAL",
      "Description": "Select videos manually from your library"
    }
  },
  "projectId": "{projectId}"
}

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}"
}