us.off-the-clock.push.getPushSettings

off-the-clock.us

Documentation

Whether this AppView sends Web Push, its VAPID public key, and the viewer's devices and push preferences (D63).

main query

Whether this AppView sends Web Push, its VAPID public key, and the viewer's devices and push preferences (D63).

Output

Encodingapplication/json
devices array Required

No description available.

kinds array Required

No description available.

mutedSpaces array Required

No description available.

publicKey string Optional

The VAPID public key as base64url, the applicationServerKey browsers subscribe with; absent with push off.

pushEnabled boolean Required

No description available.

Errors

NotSpaceMember
Try It

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

Base URL for XRPC calls (e.g., https://api.bsky.social)
View raw schema 
{
  "description": "Whether this AppView sends Web Push, its VAPID public key, and the viewer's devices and push preferences (D63).",
  "errors": [
    {
      "name": "NotSpaceMember"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "devices": {
          "items": {
            "ref": "#device",
            "type": "ref"
          },
          "type": "array"
        },
        "kinds": {
          "items": {
            "ref": "#kindSetting",
            "type": "ref"
          },
          "type": "array"
        },
        "mutedSpaces": {
          "items": {
            "description": "A pair's TID.",
            "type": "string"
          },
          "type": "array"
        },
        "publicKey": {
          "description": "The VAPID public key as base64url, the applicationServerKey browsers subscribe with; absent with push off.",
          "type": "string"
        },
        "pushEnabled": {
          "type": "boolean"
        }
      },
      "required": [
        "pushEnabled",
        "devices",
        "kinds",
        "mutedSpaces"
      ],
      "type": "object"
    }
  },
  "type": "query"
}
device object

One of the viewer's subscriptions. The endpoint itself is never answered.

Properties

createdAt string datetime Required

An RFC 3339 formatted timestamp.

host string Required

The push service's host.

id string Required

An opaque name for the subscription, for unregisterPushSubscription.

label string Optional

What the browser called itself, such as iPhone or Mac · Firefox.

maxLength: 64 bytes
lastSuccessAt string datetime Optional

An RFC 3339 formatted timestamp.

View raw schema 
{
  "description": "One of the viewer's subscriptions. The endpoint itself is never answered.",
  "properties": {
    "createdAt": {
      "format": "datetime",
      "type": "string"
    },
    "host": {
      "description": "The push service's host.",
      "type": "string"
    },
    "id": {
      "description": "An opaque name for the subscription, for unregisterPushSubscription.",
      "type": "string"
    },
    "label": {
      "description": "What the browser called itself, such as iPhone or Mac · Firefox.",
      "maxLength": 64,
      "type": "string"
    },
    "lastSuccessAt": {
      "format": "datetime",
      "type": "string"
    }
  },
  "required": [
    "id",
    "host",
    "createdAt"
  ],
  "type": "object"
}
kindSetting object

No description available.

Properties

enabled boolean Required

No description available.

kind string Required

No description available.

Known values: reply, mention, quote, rsvp, event-status, like, repost, vote
View raw schema 
{
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "kind": {
      "knownValues": [
        "reply",
        "mention",
        "quote",
        "rsvp",
        "event-status",
        "like",
        "repost",
        "vote"
      ],
      "type": "string"
    }
  },
  "required": [
    "kind",
    "enabled"
  ],
  "type": "object"
}

Lexicon Garden

@