fyi.opensocial.describePush Documentation (EN)

main query

How this host sends alerts to people's devices (Web Push): the key a browser subscribes with, and, to someone signed in, how many of their devices it alerts.

Output

Encodingapplication/json

devices integer Optional

To the caller, signed in: how many of their devices get alerts.

publicKey string Required

The host's VAPID public key, base64url.

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

View raw schema

{
  "description": "How this host sends alerts to people's devices (Web Push): the key a browser subscribes with, and, to someone signed in, how many of their devices it alerts.",
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "devices": {
          "description": "To the caller, signed in: how many of their devices get alerts.",
          "minimum": 0,
          "type": "integer"
        },
        "publicKey": {
          "description": "The host's VAPID public key, base64url.",
          "type": "string"
        }
      },
      "required": [
        "publicKey"
      ],
      "type": "object"
    }
  },
  "type": "query"
}