GOgooddata
Notification Channels

Test existing notification channel.

Tests the existing notification channel by sending a test notification.

post/api/v1/actions/notificationChannels/{notificationChannelId}/test

Request

  • Base URL
    https://www.gooddata.ai
  • Auth
    none declared

Path parameters

notificationChannelIdstring required

Request body

Example request

{
  "destination": {
    "secretKey": "secret_key",
    "token": "secret",
    "url": "https://webhook.site/something"
  }
}

Response

The result of the test of a notification channel connection.

errorstring

Field containing more details in case of a failure. Details are available to a privileged user only.

successfulboolean required

A flag indicating whether test passed or not.

Example response

{
  "error": "Authentication failed",
  "queryDurationMillis": {
    "createCacheTable": 235,
    "simpleSelect": 562
  },
  "successful": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.