# fyi.opensocial.describePush

> 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.describePush)
- [Documentation](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.describePush/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:2gqnilpksz2e7faj3bwvo6qc/fyi.opensocial.describePush/examples)

## Definitions

### `fyi.opensocial.describePush`

**Type**: `query`

How this host sends alerts to people's devices (Web Push): the key a browser subscribes with, and, to someone signed in, how many of their devices it alerts.

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `devices` | `integer` | No | To the caller, signed in: how many of their devices get alerts. |
| `publicKey` | `string` | Yes | The host's VAPID public key, base64url. |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "How this host sends alerts to people's devices (Web Push): the key a browser subscribes with, and, to someone signed in, how many of their devices it alerts.",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "devices": {
              "description": "To the caller, signed in: how many of their devices get alerts.",
              "minimum": 0,
              "type": "integer"
            },
            "publicKey": {
              "description": "The host's VAPID public key, base64url.",
              "type": "string"
            }
          },
          "required": [
            "publicKey"
          ],
          "type": "object"
        }
      },
      "type": "query"
    }
  },
  "id": "fyi.opensocial.describePush",
  "lexicon": 1
}
```