Notifications

notifications is the resource representing the various notifications that notification-prep can render

Endpoints

Skip to section
GET/v1/notifications

List all supported notifications

manage

Facts GET /v1/notifications

Rate limit
Tier 1 (1000 requests per minute)

Query Parameters GET /v1/notifications

locale
optional, default='en'
string

If present, idenfies the language of the returned 'friendlyName' property.

subscribable
optional, default='if missing, all notifications are returned'
string

If present, represents the 'subscribable' value to filter by.

Enum:

true

false

Responses GET /v1/notifications

200
optional, application/json

Request completed successfully. See Results for ResultDetail on each notification.

default
optional, application/json

Request error. See Errors.

GET/v1/notifications

curl "https://your-tenant.us.qlikcloud.com/api/v1/notifications" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/notifications

{
  "notifications": [
    {
      "transports": [],
      "isSubscribable": true,
      "presentationInfo": {
        "scopes": [],
        "friendlyName": "string",
        "scopeFriendlyNames": {}
      },
      "subscriptionInfo": {
        "action": "string",
        "target": "string",
        "resourceId": "string",
        "resourceType": "string",
        "resourceSubType": "string"
      },
      "notificationNamePattern": "string"
    }
  ]
}

Error

object

An error object.

Properties

code
string

The error code.

title
string

Summary of the problem.

detail
optional
string

A human-readable explanation specific to this occurrence of the problem.

NotificationItem

object

Notification result item

Properties

transports
Array<string>

Type of Transport e.g. Email, Notification, Slack message etc...

isSubscribable
boolean

Indicates if the notifcation can be subscribed to by users. If true, the object will also contain s 'subscriptionInfo' object

presentationInfo
optional

Object containing information pertaining to the presentaion of a notification in the UI

subscriptionInfo
optional

Object indicating what properties to use to subscribe to this notification via the 'Subscriptions' service. For info about its properties, refer to the Subscription sevice's API doc.

notificationNamePattern
string

Notification name pattern that will trigger this notification e.g resource.action

NotificationsObject

object

Object containing array representing list of supported notifications

Properties

notifications

list of notifications

v0.574.0
Was this page helpful?