social.colibri.notification.registerPush

colibri.social

Documentation

Registers a push subscription (Web Push or FCM) for the authenticated user.

main procedure

Registers a push subscription (Web Push or FCM) for the authenticated user.

Input

Encodingapplication/json
platform string Required

No description available.

subscription union Required

No description available.

Output

Encodingapplication/json
registered boolean Required

No description available.

Errors

AuthRequired Missing, malformed, or unverifiable service auth.
InvalidRequest A parameter or body field was missing or malformed.
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 
{
  "description": "Registers a push subscription (Web Push or FCM) for the authenticated user.",
  "errors": [
    {
      "description": "Missing, malformed, or unverifiable service auth.",
      "name": "AuthRequired"
    },
    {
      "description": "A parameter or body field was missing or malformed.",
      "name": "InvalidRequest"
    }
  ],
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "platform": {
          "knownValues": [
            "web",
            "tauri",
            "android"
          ],
          "type": "string"
        },
        "subscription": {
          "refs": [
            "lex:social.colibri.notification.registerPush#webPushSubscription",
            "lex:social.colibri.notification.registerPush#fcmSubscription"
          ],
          "type": "union"
        }
      },
      "required": [
        "platform",
        "subscription"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "registered": {
          "type": "boolean"
        }
      },
      "required": [
        "registered"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}
fcmSubscription object

A Firebase Cloud Messaging registration token.

Properties

token string Required

FCM registration token from FirebaseMessaging.getInstance().token.

View raw schema 
{
  "description": "A Firebase Cloud Messaging registration token.",
  "properties": {
    "token": {
      "description": "FCM registration token from FirebaseMessaging.getInstance().token.",
      "type": "string"
    }
  },
  "required": [
    "token"
  ],
  "type": "object"
}
pushKeys object

Web Push subscription keys.

Properties

auth string Required

No description available.

p256dh string Required

No description available.

View raw schema 
{
  "description": "Web Push subscription keys.",
  "properties": {
    "auth": {
      "type": "string"
    },
    "p256dh": {
      "type": "string"
    }
  },
  "required": [
    "p256dh",
    "auth"
  ],
  "type": "object"
}
webPushSubscription object

A browser Web Push subscription.

Properties

endpoint string uri Required

A valid URI.

View raw schema 
{
  "description": "A browser Web Push subscription.",
  "properties": {
    "endpoint": {
      "format": "uri",
      "type": "string"
    },
    "keys": {
      "ref": "lex:social.colibri.notification.registerPush#pushKeys",
      "type": "ref"
    }
  },
  "required": [
    "endpoint",
    "keys"
  ],
  "type": "object"
}

Lexicon Garden

@