blog.brookie.atprotify.registerPush

Register a device to receive push notifications for the authenticated account, or update its preferences. Requires service auth bound to this method. Calling it again for the same platform and token updates the registration.

Repository @brookie.blog did:plc:v46ojbiop5ebs5h7gaomixcc namespace authority
Details · procedure
Kindprocedure
Authorityatprotify.brookie.blog
Commit rev3n2s2imvl7k2b
Indexed
cid bafyreih7hgkzljf2gvpwxdjilvvh2upyogsamkj76lede5lamiq23iswmy

Checks

Valid
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Register a device to receive push notifications for the authenticated account, or update its preferences. Requires service auth bound to this method. Calling it again for the same platform and token updates the registration.",
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "appId": {
              "description": "The app's bundle ID for APNs. Must be one the relay allows.",
              "type": "string"
            },
            "disabledRules": {
              "description": "Rule IDs this device doesn't want. Omit to keep the current list.",
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "followsOnly": {
              "description": "Rule IDs this device wants only from accounts its owner follows. Needs a relay with a follows lookup (listRules says). Omit to keep the current list.",
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "mutedActors": {
              "description": "Accounts whose activity never notifies this device. Omit to keep the current list.",
              "items": {
                "format": "did",
                "type": "string"
              },
              "maxLength": 10000,
              "type": "array"
            },
            "platform": {
              "knownValues": [
                "apns",
                "fcm",
                "ntfy"
              ],
              "type": "string"
            },
            "revokeChat": {
              "description": "Let go of the account's direct-message grant (see the chat handoff at the service's authUrl), revoking it at its sign-in server.",
              "type": "boolean"
            },
            "sandbox": {
              "description": "Use the APNs development environment (debug builds).",
              "type": "boolean"
            },
            "subscriptions": {
              "description": "Accounts whose new records this device wants, for rules with subscribers. Omit to keep the current list.",
              "items": {
                "ref": "blog.brookie.atprotify.getPreferences#subscription",
                "type": "ref"
              },
              "maxLength": 10000,
              "type": "array"
            },
            "token": {
              "description": "APNs device token (hex), FCM registration token, or ntfy topic.",
              "maxLength": 4096,
              "type": "string"
            }
          },
          "required": [
            "platform",
            "token"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "ref": "blog.brookie.atprotify.getPreferences#preferences",
          "type": "ref"
        }
      },
      "type": "procedure"
    }
  },
  "id": "blog.brookie.atprotify.registerPush",
  "lexicon": 1
}