Home
GuidesAPI ReferenceRelease Notes
HomeLog InHome
Guides
Home
  1. Content APIs
  2. Updates
  3. Webhooks V2 overview

Stories webhook - V2

Story webhooks are triggered when multi-page content collections are created, updated, or deleted. Stories typically consist of multiple related pieces of content organized into pages.

In the sections that follow, you'll find a list of properties and an example JSON.

Properties in dot notation

PropertyDescriptionExample
ActionThe action that triggered the webhookUpdate
ActionTimeISO 8601 timestamp of the action2025-01-20T13:45:00.87Z
ContentIdUnique identifier of the contentxyz_content_id
ContentTypeType of contentStory
Content.IdUnique ID of the content objectxyz_content_id
Content.TypeType of contentStory
Content.TitleTitle of the contentBoston Celtics Top 10 Plays...
Content.DescriptionDescription of the contentBoston Celtics Top 10 Plays...
Content.VersionVersion number of the content1
Content.AspectRatios[0]Aspect ratio optionHorizontal
Content.AspectRatios[1]Aspect ratio optionVertical
Content.StatusCurrent status of the contentDraft
Content.IsLiveIndicates if the content is livefalse
Content.CreateTimeISO 8601 timestamp when content was created2025-01-20T13:37:36.487Z
Content.UpdateTimeISO 8601 timestamp when content was last updated2025-01-20T13:43:26.159Z
Content.Thumbnails[0].UrlURL of thumbnail imagehttps://cdn.example.com/xyz1.jpg
Content.Thumbnails[0].AspectRatioAspect ratio of thumbnailSquare
Content.Thumbnails[1].UrlURL of thumbnail imagehttps://cdn.example.com/xyz2.jpg
Content.Thumbnails[1].AspectRatioAspect ratio of thumbnailTwoToThree
Content.Thumbnails[2].UrlURL of thumbnail imagehttps://cdn.example.com/xyz3.jpg
Content.Thumbnails[2].AspectRatioAspect ratio of thumbnailHorizontal
Content.GeoTargeting.IncludedGeos[0]Allowed geography codeil
Content.GeoTargeting.IncludedGeos[1]Allowed geography codeus
Content.GeoTargeting.ExcludedGeosExcluded geography codes (null = none)null
Content.Metadata.Competition.ProviderExternal provider namenull
Content.Metadata.Competition.ProviderIdExternal provider identifiernull
Content.Metadata.Competition.WscIdInternal WSC competition ID2
Content.Metadata.Game.ProviderExternal provider namenull
Content.Metadata.Game.ProviderIdExternal game identifierxyz_game_id
Content.Metadata.Game.WscIdInternal WSC game ID103361656
Content.Metadata.Team.ProviderExternal provider namenull
Content.Metadata.Team.ProviderIdExternal team identifierxyz_team_id
Content.Metadata.Team.WscIdInternal WSC team ID1003
Content.Metadata.PlayerPlayer informationnull
Content.Metadata.RoundRound informationnull
Content.Metadata.SeasonSeason informationnull
Content.ExecutionTimeTypeWorkflow context of content creationNone
Content.htmlUrlPublic HTML URLhttps://xyz.fan/games/page_id.html
Content.Pages[0].IdUnique page identifierxyz_page_id_0
Content.Pages[0].IndexPage index (zero-based)0
Content.Pages[0].DurationPage duration in seconds10.477133
Content.Pages[0].Thumbnails[0].UrlURL of page thumbnail imagehttps://cdn.example.com/xyz4.jpg
Content.Pages[0].Thumbnails[0].AspectRatioAspect ratio of page thumbnailVertical
Content.Pages[0].Thumbnails[1].UrlURL of page thumbnail imagehttps://cdn.example.com/xyz5.jpg
Content.Pages[0].Thumbnails[1].AspectRatioAspect ratio of page thumbnailHorizontal
Content.Pages[0].CreateTimeISO 8601 timestamp when page was created2025-01-20T13:37:35.87Z
Content.Pages[0].UpdateTimeISO 8601 timestamp when page was last updated2025-01-20T13:37:35.87Z
Content.Pages[0].MetadataPage metadatanull
Content.Labels[0].TitleLabel display nameTeam Stories
Content.Labels[0].IdentifierLabel unique identifierteam-stories
extraInfo.actionExtra info: actionBest Actions
extraInfo.roundExtra info: roundRound Information
extraInfo.homeTeamExtra info: home teamHome Team
extraInfo.awayTeamExtra info: away teamAway Team
extraInfo.propertyIdExtra info: property identifierxyz_property_id
extraInfo.propertyNameExtra info: property nameCompetition Name
extraInfo.gameIdExtra info: game identifierxyz_game_id
extraInfo.teamIdExtra info: team identifierxyz_team_id
extraInfo.playerIdExtra info: player identifierxyz_player_id
extraInfo.roundIdExtra info: round identifierxyz_round_id

Example JSON

{
  "Action": "Update",
  "ActionTime": "2025-01-20T13:45:00.87Z",
  "ContentId": "xyz_content_id",
  "ContentType": "Story",
  "Content": {
    "Id": "xyz_content_id",
    "Type": "Story",
    "Title": "Boston Celtics Top 10 Plays from Boston Celtics vs. Detroit Pistons",
    "Description": "Boston Celtics Top 10 Plays from Boston Celtics vs. Detroit Pistons, 12-12-24, Week 8, Regular Season, 2024-25",
    "Version": 1,
    "AspectRatios": ["Horizontal", "Vertical"],
    "Status": "Draft",
    "IsLive": false,
    "CreateTime": "2025-01-20T13:37:36.487Z",
    "UpdateTime": "2025-01-20T13:43:26.159Z",
    "Thumbnails": [
      {
        "Url": "https://cdn.example.com/xyz1.jpg",
        "AspectRatio": "Square"
      },
      {
        "Url": "https://cdn.example.com/xyz2.jpg",
        "AspectRatio": "TwoToThree"
      },
      {
        "Url": "https://cdn.example.com/xyz3.jpg",
        "AspectRatio": "Horizontal"
      }
    ],
    "GeoTargeting": {
      "IncludedGeos": ["il", "us"],
      "ExcludedGeos": null
    },
    "Metadata": {
      "Competition": {
        "Provider": null,
        "ProviderId": null,
        "WscId": 2
      },
      "Game": {
        "Provider": null,
        "ProviderId": "xyz_game_id",
        "WscId": 103361656
      },
      "Team": {
        "Provider": null,
        "ProviderId": "xyz_team_id",
        "WscId": 1003
      },
      "Player": null,
      "Round": null,
      "Season": null
    },
    "ExecutionTimeType": "None",
    "htmlUrl": "https://xyz.fan/games/page_id.html",
    "Pages": [
      {
        "Id": "xyz_page_id_0",
        "Index": 0,
        "Duration": 10.477133,
        "Thumbnails": [
          {
            "Url": "https://cdn.example.com/xyz4.jpg",
            "AspectRatio": "Vertical"
          },
          {
            "Url": "https://cdn.example.com/xyz5.jpg",
            "AspectRatio": "Horizontal"
          }
        ],
        "CreateTime": "2025-01-20T13:37:35.87Z",
        "UpdateTime": "2025-01-20T13:37:35.87Z",
        "Metadata": null
      },
      {
        "Id": "xyz_page_id_1",
        "Index": 1,
        "Duration": 22.689333,
        "Thumbnails": [
          {
            "Url": "https://cdn.example.com/xyz6.jpg",
            "AspectRatio": "Vertical"
          },
          {
            "Url": "https://cdn.example.com/xyz7.jpg",
            "AspectRatio": "Horizontal"
          }
        ],
        "CreateTime": "2025-01-20T13:37:35.87Z",
        "UpdateTime": "2025-01-20T13:37:35.87Z",
        "Metadata": null
      },
      {
        "Id": "xyz_page_id_2",
        "Index": 2,
        "Duration": 10.01,
        "Thumbnails": [
          {
            "Url": "https://cdn.example.com/xyz8.jpg",
            "AspectRatio": "Vertical"
          },
          {
            "Url": "https://cdn.example.com/xyz9.jpg",
            "AspectRatio": "Horizontal"
          }
        ],
        "CreateTime": "2025-01-20T13:37:35.87Z",
        "UpdateTime": "2025-01-20T13:37:35.87Z",
        "Metadata": null
      }
    ],
    "Labels": [
      {
        "Title": "Team Stories",
        "Identifier": "team-stories"
      }
    ]
  },
  "extraInfo": {
    "action": "Best Actions",
    "round": "Round Information",
    "homeTeam": "Home Team",
    "awayTeam": "Away Team",
    "propertyId": "xyz_property_id",
    "propertyName": "Competition Name",
    "gameId": "xyz_game_id",
    "teamId": "xyz_team_id",
    "playerId": "xyz_player_id",
    "roundId": "xyz_round_id"
  }
}

Updated 1 day ago

Did this page help you?