app.bivri.notif.registerPush

lexicons.bivri.app

Documentation

main procedure

No description available.

Input

Encodingapplication/json
endpoint stringuri Required

HTTPS endpoint on a supported browser push service.

maxLength: 2048 bytes
userAgent string Optional

No description available.

maxLength: 512 bytes

Output

Encodingapplication/json
registered boolean Required

No description available.

Errors

PushUnavailable Web Push is not configured.
SubscriptionConflict The endpoint belongs to another member.
ConsentRequired The authenticated member must accept Terms and Privacy Policy and confirm age.
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://bsky.social)
Enter valid JSON for the request body
View raw schema
{
  "errors": [
    {
      "description": "Web Push is not configured.",
      "name": "PushUnavailable"
    },
    {
      "description": "The endpoint belongs to another member.",
      "name": "SubscriptionConflict"
    },
    {
      "description": "The authenticated member must accept Terms and Privacy Policy and confirm age.",
      "name": "ConsentRequired"
    }
  ],
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "endpoint": {
          "description": "HTTPS endpoint on a supported browser push service.",
          "format": "uri",
          "maxLength": 2048,
          "type": "string"
        },
        "keys": {
          "ref": "#subscriptionKeys",
          "type": "ref"
        },
        "userAgent": {
          "maxLength": 512,
          "type": "string"
        }
      },
      "required": [
        "endpoint",
        "keys"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "registered": {
          "const": true,
          "type": "boolean"
        }
      },
      "required": [
        "registered"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}
subscriptionKeys object

No description available.

Properties

auth string Required

Base64url authentication secret (16 bytes).

maxLength: 22 bytesminLength: 22 bytes
p256dh string Required

Base64url uncompressed P-256 public key (65 bytes).

maxLength: 87 bytesminLength: 87 bytes
View raw schema
{
  "properties": {
    "auth": {
      "description": "Base64url authentication secret (16 bytes).",
      "maxLength": 22,
      "minLength": 22,
      "type": "string"
    },
    "p256dh": {
      "description": "Base64url uncompressed P-256 public key (65 bytes).",
      "maxLength": 87,
      "minLength": 87,
      "type": "string"
    }
  },
  "required": [
    "p256dh",
    "auth"
  ],
  "type": "object"
}

Lexicon Garden

@