Notifications

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

Download OpenAPI spec

List all supported notifications

Facts

Rate limit Tier 1 (1000 requests per minute)

Query Parameters

  • locale string

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

    default = "en"

  • manageableInHub string

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

    Can be one of: true

    default = "if missing, no filtering is done"

  • subscribable string

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

    Can be one of: true

    default = "if missing, no filtering is done"

Responses

200

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

  • application/json object

    Object containing array representing list of supported notifications

    Show application/json properties
    • notifications array of objects
      Required

      list of notifications

      Show notifications properties
      • transports array of strings
        Required

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

      • isSubscribable boolean
        Required

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

      • presentationInfo object

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

        Show presentationInfo properties
        • scopes array of strings

          Information about the scopes to which this notification applies. Helps determine the placement of the notification in the UI

        • friendlyName string

          Localized, human-readable string representing the name of the notification suitable to use in a UI

        • scopeFriendlyNames object

          Friendly name to be displayed for each scope.

          Show additional optional properties
          • string string

            Localized, human-readable string representing the name of the notification suitable to use in a UI.
      • subscriptionInfo object

        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.

        Show subscriptionInfo properties
        • action string
          Required
        • target string
        • resourceId string
        • resourceType string
          Required
        • resourceSubType string
      • isManageableInHub boolean

        Indicates if the notification can be managed in the hub. If true, the object will also contain 'subscriptionInfo' object and a 'presentationInfo' object with a non-empty scopes array.

      • notificationNamePattern string
        Required

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

default

Request error. See Errors.

  • application/json object

    An error object.

    Show application/json properties
    • code string
      Required

      The error code.

    • title string
      Required

      Summary of the problem.

    • detail string

      A human-readable explanation specific to this occurrence of the problem.
GET /api/v1/notifications 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.notifications.getNotifications({})
qlik notification ls
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/notifications" \
-H "Authorization: Bearer <access_token>"

Example Response

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