# social.colibri.notification.registerPush

> Published by [colibri.social](https://lexicon.garden/identity/did:plc:mprdjqjluoswa7awzggaggj3)

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.notification.registerPush)
- [Documentation](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.notification.registerPush/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.notification.registerPush/examples)

## Definitions

### `social.colibri.notification.registerPush`

**Type**: `procedure`

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

#### Input

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `platform` | `string` | Yes |  |
| `subscription` | `union` | Yes |  |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `registered` | `boolean` | Yes |  |

#### Errors

- **AuthRequired**: Missing, malformed, or unverifiable service auth.
- **InvalidRequest**: A parameter or body field was missing or malformed.

### `social.colibri.notification.registerPush#pushKeys`

**Type**: `object`

Web Push subscription keys.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `auth` | `string` | Yes |  |
| `p256dh` | `string` | Yes |  |

### `social.colibri.notification.registerPush#fcmSubscription`

**Type**: `object`

A Firebase Cloud Messaging registration token.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `token` | `string` | Yes | FCM registration token from FirebaseMessaging.getInstance().token. |

### `social.colibri.notification.registerPush#webPushSubscription`

**Type**: `object`

A browser Web Push subscription.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `keys` | `ref` → `lex:social.colibri.notification.registerPush#pushKeys` | Yes |  |
| `endpoint` | `string` (uri) | Yes |  |

## Raw Schema

```json
{
  "id": "social.colibri.notification.registerPush",
  "defs": {
    "main": {
      "type": "procedure",
      "input": {
        "schema": {
          "type": "object",
          "required": [
            "platform",
            "subscription"
          ],
          "properties": {
            "platform": {
              "type": "string",
              "knownValues": [
                "web",
                "tauri",
                "android"
              ]
            },
            "subscription": {
              "refs": [
                "lex:social.colibri.notification.registerPush#webPushSubscription",
                "lex:social.colibri.notification.registerPush#fcmSubscription"
              ],
              "type": "union"
            }
          }
        },
        "encoding": "application/json"
      },
      "errors": [
        {
          "name": "AuthRequired",
          "description": "Missing, malformed, or unverifiable service auth."
        },
        {
          "name": "InvalidRequest",
          "description": "A parameter or body field was missing or malformed."
        }
      ],
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "registered"
          ],
          "properties": {
            "registered": {
              "type": "boolean"
            }
          }
        },
        "encoding": "application/json"
      },
      "description": "Registers a push subscription (Web Push or FCM) for the authenticated user."
    },
    "pushKeys": {
      "type": "object",
      "required": [
        "p256dh",
        "auth"
      ],
      "properties": {
        "auth": {
          "type": "string"
        },
        "p256dh": {
          "type": "string"
        }
      },
      "description": "Web Push subscription keys."
    },
    "fcmSubscription": {
      "type": "object",
      "required": [
        "token"
      ],
      "properties": {
        "token": {
          "type": "string",
          "description": "FCM registration token from FirebaseMessaging.getInstance().token."
        }
      },
      "description": "A Firebase Cloud Messaging registration token."
    },
    "webPushSubscription": {
      "type": "object",
      "required": [
        "endpoint",
        "keys"
      ],
      "properties": {
        "keys": {
          "ref": "lex:social.colibri.notification.registerPush#pushKeys",
          "type": "ref"
        },
        "endpoint": {
          "type": "string",
          "format": "uri"
        }
      },
      "description": "A browser Web Push subscription."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```