# fyi.opensocial.registerPush

> Published by [lexicons.opensocial.fyi](https://lexicon.garden/identity/did:plc:2gqnilpksz2e7faj3bwvo6qc)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.registerPush)
- [Documentation](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.registerPush/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.registerPush/examples)

## Definitions

### `fyi.opensocial.registerPush#keys`

**Type**: `object`

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

### `fyi.opensocial.registerPush`

**Type**: `procedure`

Alert one of the caller's devices when something in their Activity is for them and they're not on any of their groups' sites: a browser's Web Push subscription, made with the key describePush gives.

#### Input

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `endpoint` | `string` (uri) | Yes |  |
| `keys` | `ref` → `#keys` | Yes |  |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "keys": {
      "properties": {
        "auth": {
          "maxLength": 100,
          "type": "string"
        },
        "p256dh": {
          "maxLength": 200,
          "type": "string"
        }
      },
      "required": [
        "p256dh",
        "auth"
      ],
      "type": "object"
    },
    "main": {
      "description": "Alert one of the caller's devices when something in their Activity is for them and they're not on any of their groups' sites: a browser's Web Push subscription, made with the key describePush gives.",
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "endpoint": {
              "format": "uri",
              "maxLength": 2000,
              "type": "string"
            },
            "keys": {
              "ref": "#keys",
              "type": "ref"
            }
          },
          "required": [
            "endpoint",
            "keys"
          ],
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "id": "fyi.opensocial.registerPush",
  "lexicon": 1
}
```