Skip to main content
POST
/
api
/
v1
/
notifications
/
send
Send notification
curl --request POST \
  --url http://localhost:3000/api/v1/notifications/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "channel": "<string>",
  "title": "<string>",
  "body": "<string>",
  "severity": "info",
  "delayMs": 1
}
'
{
  "ok": true,
  "data": null
}

Authorizations

Authorization
string
header
required

API key passed as a Bearer token. Configure via the apiKeys field in polpo.json or the POLPO_API_KEY environment variable.

Body

application/json
channel
string
required
Minimum string length: 1
title
string
required
Minimum string length: 1
body
string
required
Minimum string length: 1
severity
enum<string>
Available options:
info,
warning,
critical
delayMs
integer
Required range: x >= 0

Response

Notification sent

ok
boolean
required
data
unknown