# com.getorbyt.notification.registerPush

> Published by [getorbyt.com](https://lexicon.garden/identity/did:plc:2xrqztnmzlckb3xfuuukupso)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:2xrqztnmzlckb3xfuuukupso/com.getorbyt.notification.registerPush)
- [Documentation](https://lexicon.garden/lexicon/did:plc:2xrqztnmzlckb3xfuuukupso/com.getorbyt.notification.registerPush/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:2xrqztnmzlckb3xfuuukupso/com.getorbyt.notification.registerPush/examples)

## Definitions

### `com.getorbyt.notification.registerPush`

**Type**: `procedure`

Opt this account and installation into native Orbyt notifications. A separate read-only notification grant may require consent.

#### Input

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `appState` | `string` | Yes |  |
| `deviceId` | `string` | Yes |  |
| `environment` | `string` | Yes |  |
| `token` | `string` | Yes |  |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `authorizationUrl` | `string` (uri) | No |  |
| `expiresAt` | `string` (datetime) | No |  |
| `revocationToken` | `string` | Yes |  |
| `status` | `string` | Yes |  |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Opt this account and installation into native Orbyt notifications. A separate read-only notification grant may require consent.",
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "appState": {
              "maxLength": 128,
              "minLength": 32,
              "type": "string"
            },
            "deviceId": {
              "maxLength": 128,
              "minLength": 1,
              "type": "string"
            },
            "environment": {
              "knownValues": [
                "development",
                "production"
              ],
              "type": "string"
            },
            "token": {
              "maxLength": 512,
              "minLength": 32,
              "type": "string"
            }
          },
          "required": [
            "deviceId",
            "token",
            "environment",
            "appState"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "authorizationUrl": {
              "format": "uri",
              "type": "string"
            },
            "expiresAt": {
              "format": "datetime",
              "type": "string"
            },
            "revocationToken": {
              "maxLength": 128,
              "minLength": 32,
              "type": "string"
            },
            "status": {
              "knownValues": [
                "active",
                "authorizationRequired",
                "disabled"
              ],
              "type": "string"
            }
          },
          "required": [
            "status",
            "revocationToken"
          ],
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "id": "com.getorbyt.notification.registerPush",
  "lexicon": 1
}
```