Skip to content

Send a test message to a notification channel

POST
/v1/projects/{id}/notification-channels/{channelId}/test
curl --request POST \
--url https://beta-api.plune.ai/v1/projects/example/notification-channels/example/test \
--cookie plune_session=<plune_session>

The owner’s: one message now, in the channel’s language, to its webhook. A gone webhook (Slack: no_service and the other codes GET …/notification-channels names, or a 404; a generic webhook: 410) makes the channel rejected (result: rejected); a 429 is busy with the receiver’s wait; any other answer failed, and a webhook address the guard refuses now failed with its reason. A generic webhook gets event: test, signed as every delivery. 409 channel_unreadable when this server cannot open the saved address. Ten a minute a project.

id
required
string

An id from GET /v1/projects

channelId
required
string

A channel’s id from GET …/notification-channels

What the receiver answered

Media type application/json
object
ok
required
boolean
result
required

sent; rejected - the webhook is gone, the channel is now rejected; busy - Slack’s 429, with retryAfterSec; failed - any other answer, the network, 10 s

string
Allowed values: sent rejected busy failed
retryAfterSec
integer
>= 1
reason

With result: failed for a webhook: what the address guard said of its address now - not_https, internal_address (a private, loopback or link-local network), unresolvable (no answer within 10 s). Never the address

string
Allowed values: not_https internal_address unresolvable
testedAt
required
string format: date-time
Example
{
"ok": true,
"result": "sent",
"testedAt": "2026-11-14T10:00:00.000Z"
}

No / invalid session — a CLI token is refused here

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}

Not the project’s owner; or (with TIER_LIMITS_ENFORCE=true) a tier without the notification_channels permission, with feature and tier

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}

Not your project, or (code: channel_not_found) no such channel in it

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}

code: channel_unreadable - the saved address cannot be opened on this server; set it again

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}

Rate-limited: the per-route throttle, or the per-minute request limit of the plan an API token counts by (#1442; the body names the plan, #2092). Retry-After carries the seconds until the window rolls over.

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}
Retry-After
integer

Seconds until the window rolls over

The server has no INTEGRATIONS_ENCRYPTION_KEY; nothing was saved or sent

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}