Send test notification

POST/api/notify/test

Sends one real test message through every configured notification channel. Protection: token. A channel that fails is a result with sent set to false and an error, not an error response, so one broken channel does not hide the others.

Authorizations

Authorizationstringheaderrequired

The token you start the server with: homebutler serve --token <token>, or web.token in the config file. Send it as Authorization: Bearer <token>. When the server has a token, every /api/ route except the CORS preflight requires it, reads included.

Response

200 · application/json

One result per configured channel.

resultsobject[]required

One result per configured channel.

cURLcURLPythonJavaScript

curl --request POST \
  --url 'http://localhost:8080/api/notify/test' \
  --header 'Authorization: Bearer <token>'

{
  "results": [
    {
      "channel": "webhook",
      "sent": true
    },
    {
      "channel": "ntfy",
      "sent": true
    }
  ]
}