Skip to main content

Send a test notification through a channel

POST 

/notifications/channels/:channelId/test

Required role: admin. Only an account or token with the admin role can call this operation.

Example request
curl --request POST \
--header "Authorization: Bearer $HOSERVA_TOKEN" \
"https://$HOSERVA_HOST:8008/api/v1/notifications/channels/{channelId}/test"

Sent immediately, outside the delivery queue and its retry policy — this is a synchronous probe of the channel's own configuration, not a routed event, so it reports success or the delivery error directly rather than being retried and logged like a routed notification. A test that succeeds is also recorded for the migration checklist (getMigrationChecklist), which counts a channel only while it is enabled and its latest successful test ran in a later second than the one the channel last changed in; a test that fails is not recorded.

Request​

Responses​

Whether the test notification was delivered.