Skip to content

Send a test notification​

POST
/api/notifications/test

Creates a real task (labelled test, due a minute ago) and, about 3
seconds later, sends a notification for it to every configured
channel (Web Push and APNs), so Done and Snooze can be tried end to
end. high sends a High (P3) notification; urgent and critical
both send an Urgent (P4) one as an Apple Critical Alert, the same as a
real overdue P4.

Authorizations​

bearerAuth

API token created via POST /api/tokens or the db:create-token CLI command

Type
HTTP (bearer)

Request Body​

application/json
JSON
{
"type": "string"
}

Responses​

Test scheduled

application/json
JSON
{
"data": {
"sent": true,
"type": "string",
"task_id": 0,
"delay_seconds": 3
}
}

Samples​

Powered by VitePress OpenAPI