Members

Send a test push to the signed in person's devices (console server)

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.

post/notifications:test

Request

  • Base URL: https://api.customdomain.ai/v1
  • URL: https://api.customdomain.ai/v1/notifications:test
  • Auth: API key in header X-Provision-Secret

Request body

user_idstring required

The signed in person's id in the console.

Response

What the test did

devicesinteger required

Browsers the person has turned push on in.

sentinteger required

Push services that accepted the message.

removedinteger required

Devices found gone and removed.

failedinteger required

Pushes that did not go through.

Changes

No recorded changes to this operation across all 1 revision of this API.