# social.colibri.beta.notification.defs

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

✓ This is the authoritative definition for this NSID.

## Links

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

## Definitions

### `social.colibri.beta.notification.defs#notificationView`

**Type**: `object`

A notification for the requesting user.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `id` | `string` | Yes | Opaque identifier, used to mark this notification seen. |
| `kind` | `string` | Yes | Why it was raised. |
| `author` | `ref` → `social.colibri.beta.actor.defs#profileView` | Yes | Who caused it. |
| `seenAt` | `string` (datetime) | No | When the user marked it seen. |
| `channel` | `string` (space-ref) | Yes | The channel it happened in. |
| `message` | `ref` → `social.colibri.beta.channel.defs#messageView` | No | The message, when still readable. |
| `community` | `string` (did) | Yes | The community it happened in. |
| `indexedAt` | `string` (datetime) | Yes | When the AppView raised it. |
| `mentionRole` | `string` | No | Name of the role whose mention raised this, for role mentions. |

## Raw Schema

```json
{
  "id": "social.colibri.beta.notification.defs",
  "defs": {
    "notificationView": {
      "type": "object",
      "required": [
        "id",
        "kind",
        "author",
        "channel",
        "community",
        "indexedAt"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Opaque identifier, used to mark this notification seen."
        },
        "kind": {
          "type": "string",
          "description": "Why it was raised.",
          "knownValues": [
            "mention",
            "reply",
            "message"
          ]
        },
        "author": {
          "ref": "social.colibri.beta.actor.defs#profileView",
          "type": "ref",
          "description": "Who caused it."
        },
        "seenAt": {
          "type": "string",
          "format": "datetime",
          "description": "When the user marked it seen."
        },
        "channel": {
          "type": "string",
          "format": "space-ref",
          "description": "The channel it happened in."
        },
        "message": {
          "ref": "social.colibri.beta.channel.defs#messageView",
          "type": "ref",
          "description": "The message, when still readable."
        },
        "community": {
          "type": "string",
          "format": "did",
          "description": "The community it happened in."
        },
        "indexedAt": {
          "type": "string",
          "format": "datetime",
          "description": "When the AppView raised it."
        },
        "mentionRole": {
          "type": "string",
          "description": "Name of the role whose mention raised this, for role mentions."
        }
      },
      "description": "A notification for the requesting user."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```