MEmetacopier
Notifications API

List the notification channels of a project

Changed on

Derived from the channel features (Telegram, Webhook, Slack, Microsoft Teams, Discord), nothing here is stored. A Telegram feature is one entry with one recipient per username. Use featureId and an optional recipient key to fill the targets of a rule or notificationTargets of a news feature.

get/rest/api/v1/projects/{projectId}/notificationChannels

Request

Path parameters

projectIdstring uuid required

Query parameters

accountIdstring uuid

Also list the channels attached to this account

Response

OK

accountIdstring uuid

Set when level is ACCOUNT

channelType'TELEGRAM' | 'WEBHOOK' | 'SLACK' | 'MS_TEAMS' | 'DISCORD'

Which channel this is

connectMode'OAUTH' | 'GUIDED_URL' | 'RECIPIENT' | 'MANUAL_URL'

How the channel is connected

displayNamestring

Label for the picker

enabledboolean

False when the user disabled the channel or the backend auto-disabled it

featureIdstring uuid

Id of the channel feature, the value for NotificationTargetDTO.featureId

levelstring

Where the channel is attached: PROJECT or ACCOUNT

Example response

[
  {
    "displayName": "Slack #alerts",
    "level": "PROJECT",
    "recipients": [
      {
        "displayName": "@john",
        "key": "@john"
      }
    ]
  }
]

Changes

  • 2ac6d7461345Revision changes
    • warning

      added the new DISCORD enum value to the / response property for the response status

    • warning

      added the new MS_TEAMS enum value to the / response property for the response status

    • warning

      added the new SLACK enum value to the / response property for the response status

    • info

      api tag Notifications API added

    • info

      api tag News API removed

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property / to the response with the status

  • 69d2d39c695eRevision changes
    • info

      endpoint added