Send a test push to the signed in person's devices (console server)
send test notification: reference page for this CustomDomain™ API operation in the members group. Covers parameters, request body, responses and error codes.
Pushes one test notification to every browser in which user_id turned push notifications on. The console's server calls this behind its "Send a test notification" button, guarded by the provision secret exactly like POST /members:email-changed: the console has already checked the session and passes the signed in person's id, and the route takes no account, so a secret for one workspace cannot name another. The control plane holds the VAPID keys; without them it answers 503 push_not_configured. More than five tests a minute for one person answer 429 rate_limited with Retry-After: 60.
Authorization
provisionSecret Narrow secret for the one-call signup provisioning endpoint (also accepted as a Bearer token).
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/notifications:test" \ -H "Content-Type: application/json" \ -d '{ "user_id": "string" }'{ "devices": 0, "sent": 0, "removed": 0, "failed": 0}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}