Notifications

The Content Item Notification consists of a NotificationFeed object which describes the feed, a collection of Notifications, where each Notification represents an item of content that has been modified or deleted and links containing the url to use in retrieving the next set of results.

The notifications generated correspond to “story” and “slideshow” items where the source is “FT”.

Methods

MethodREST URI Description
item-notifications GET /content/notifications/v1/items List all content items that have been modified.

Relative to the base URI: https://api.ft.com

NotificationFeed Resource Representation

A NotificationFeed is represented in the FT API as a JSON data structure, as shown below, that is received in the body of a response. This example shows all possible fields a notification feed can contain.

“notificationFeed”:{
    “id”: string,
    “apiUrl”: string
}

NotificationFeed Properties

Property NameValueDescription
id string This uniquely identifies the notification feed. For the content item notification the value is content/notifications/items
apiUrl string The apiUrl for this notificationFeed

Notification Resource Representation

A notification is represented in the FT API as a JSON data structure, as shown below, that is received in the body of a response. This example shows all possible fields a notification can contain.

{
  “type”: string,
  “updated”: datetime,
  “data”: {
    “content-item”: {
      “id”: string,
      “apiUrl”: string
    }
  }
}

Notification Properties

Property NameValueDescription
type string The type of notification. Current values are content-item-update and content-item-deletion
updated date The date the content item was last updated
data string The data entity that has been updated
data.content-item string The content-item that has been updated
data.content-item.id string The id of the content item that has been updated
data.content-item.apiUrl string The apiUrl to request the content item that has been updated

Links Resource Representation

The detail of the next request to make to the Content Items Notification API is represented as a link shown below.

{
  “href”: string,
  “rel”: string
}

Links Properties

Property NameValueDescription
href string The target URI of the link.
rel string The relationship the target resource has with the notification feed. Currently supported relation types are :   next - A link to use for your next request, to ensure you see all notifications. There will only be 1 link of this type.