/
v3.0.11Get access

getNotifications

Retrieve a list of notification contents for a specific notification type (e.g. header info or whats new), filtered by platform and with optional WebP image support

Request parameters:

Name
DescriptionTypeValuesDefault
notificationType
The notification type to retrieve: "header_info" or "whats_new"string"header_info" / "whats_new"-
country
Country code used for global filteringstring--
useWebp
Whether to return WebP versions of imagesbooleantrue / false-
platform
Platform namestring"desktop" / "mobile"-

Call example:

getNotifications({
  notificationType: 'header_info',
  country: 'AM',
  useWebp: false,
  platform: 'desktop'
})

Response parameters:

NameDescriptionTypeValues
id
Auto-increment unique identifier of the notification entrynumber-
show_to
Visibility scope: 0 = all, 1 = authorized users only, 2 = guests onlynumber-
target
Link target attribute: "_blank", "_self", "_parent", or "_top"string-
href_type
Type of the href value (e.g. "link")string-
title
Title text of the notificationstring-
content
Body content text of the notificationstring-
src_type
Type of the media source (e.g. "image")string-
src
Path to the notification image assetstring-
src_alt
Alternative image path, or null if not setstring | null-
href
URL the notification links to when clickedstring-