Skip to main content

Display CMS release notes

Use the release-notes collection to show published product updates in an app. Documents can include a localized title, excerpt, and rich-text body, tags, and a publishedAt date.

Fetch recent release notes​

listReleaseNotes() returns the newest published entries first and supports the CMS collection paging options:

const page = await client.listReleaseNotes({
  tenantCode,
  environment: 'staging',
  locale: 'en',
  limit: 10,
});

renderReleaseNotes(page.docs);

The example's client, tenantCode, and renderReleaseNotes() are application-provided. release-notes is not open by default: read it with a signed-in client for that tenant or through a trusted server holding a CMS API key. Never ship a CMS API key in a browser or mobile app.

For more results, request later pages while hasNextPage is true. The collection route supports up to 50 items per page and 100 pages. See List CMS collection items for the full query and response fields.

Use fields and tags​

Each release note includes fields such as:

  • slug and title for a stable link and heading.
  • excerpt for a short summary in a list.
  • body for full release details. Rich text is returned as the editor's JSON structure, not HTML.
  • tags for categories such as announcement, new, improved, or fixed.
  • publishedAt for the date displayed in the app.

Only documents with status: 'published' are returned. publishedAt is a content date; it does not schedule publication or hide an item. Use CMS publishing status to control whether the item is delivered.

Locales and caching​

The CMS supports bare locale codes such as de, en, fr, and es, and defaults to English. The SDK maps regional app locales such as de-DE to the CMS locale; see Use Ovok CMS with i18next.

Published edits may take about a minute to appear, plus additional CDN time. See the platform's CMS caching guide.