Notifications API

Send a test message to one channel

Changed on

Waits up to a few seconds for the provider; a still running delivery is reported as QUEUED. A Telegram channel needs the recipient, other channels ignore it.

post/rest/api/v1/projects/{projectId}/notificationChannels/{featureId}/test

Request

Path parameters

projectIdstring uuid required
featureIdstring uuid required

Request body

recipientstring

Telegram username; omit for all other channel types

Example request

{
  "recipient": "@john"
}

Response

OK

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

Channel type

deliveryIdstring

Id in the delivery log

errorstring

Sanitized provider error

featureIdstring uuid

Channel feature

recipientstring

Recipient (Telegram)

status'QUEUED' | 'ACCEPTED' | 'FAILED' | 'UNKNOWN' | 'BUNDLED' | 'QUIET' | 'COOLDOWN' | 'DROPPED_OVERFLOW' | 'DROPPED_RATE_LIMIT' | 'EXPIRED' | 'SKIPPED_DISABLED' | 'SKIPPED_TARGET' | 'CANCELLED_CONFIG_CHANGED'

ACCEPTED, FAILED, UNKNOWN (timeout, may still arrive) or a SKIPPED_* status

Changes