# social.colibri.notification.defs

> 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.defs)
- [Documentation](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.notification.defs/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.notification.defs/examples)

## Definitions

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

**Type**: `object`

A notification in the authenticated user's feed.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `id` | `integer` | Yes |  |
| `kind` | `string` | Yes |  |
| `seenAt` | `string` (datetime) | No |  |
| `message` | `ref` → `lex:social.colibri.notification.defs#notificationMessage` | Yes |  |
| `authorDid` | `string` (did) | Yes |  |
| `indexedAt` | `string` (datetime) | Yes |  |
| `channelUri` | `string` (at-uri) | Yes |  |
| `messageUri` | `string` (at-uri) | Yes |  |
| `recipientDid` | `string` (did) | Yes |  |
| `mentionRoleName` | `string` | No | Display name of the role that triggered this notification, when it was a role mention rather than a direct mention. |

### `social.colibri.notification.defs#unseenNotification`

**Type**: `object`

A minimal unseen-notification pointer.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `id` | `integer` | Yes |  |
| `indexedAt` | `string` (datetime) | Yes |  |
| `messageUri` | `string` (at-uri) | Yes |  |

### `social.colibri.notification.defs#notificationMessage`

**Type**: `object`

The message a notification refers to.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `text` | `string` | Yes |  |
| `edited` | `boolean` | No |  |
| `facets` | `array` | Yes |  |
| `parent` | `string` (at-uri) | No |  |
| `createdAt` | `string` (datetime) | Yes |  |
| `attachments` | `array` | Yes |  |

## Raw Schema

```json
{
  "id": "social.colibri.notification.defs",
  "defs": {
    "notificationView": {
      "type": "object",
      "required": [
        "id",
        "recipientDid",
        "kind",
        "messageUri",
        "authorDid",
        "channelUri",
        "indexedAt",
        "message"
      ],
      "properties": {
        "id": {
          "type": "integer"
        },
        "kind": {
          "type": "string"
        },
        "seenAt": {
          "type": "string",
          "format": "datetime"
        },
        "message": {
          "ref": "lex:social.colibri.notification.defs#notificationMessage",
          "type": "ref"
        },
        "authorDid": {
          "type": "string",
          "format": "did"
        },
        "indexedAt": {
          "type": "string",
          "format": "datetime"
        },
        "channelUri": {
          "type": "string",
          "format": "at-uri"
        },
        "messageUri": {
          "type": "string",
          "format": "at-uri"
        },
        "recipientDid": {
          "type": "string",
          "format": "did"
        },
        "mentionRoleName": {
          "type": "string",
          "description": "Display name of the role that triggered this notification, when it was a role mention rather than a direct mention."
        }
      },
      "description": "A notification in the authenticated user's feed."
    },
    "unseenNotification": {
      "type": "object",
      "required": [
        "id",
        "messageUri",
        "indexedAt"
      ],
      "properties": {
        "id": {
          "type": "integer"
        },
        "indexedAt": {
          "type": "string",
          "format": "datetime"
        },
        "messageUri": {
          "type": "string",
          "format": "at-uri"
        }
      },
      "description": "A minimal unseen-notification pointer."
    },
    "notificationMessage": {
      "type": "object",
      "required": [
        "text",
        "facets",
        "createdAt",
        "attachments"
      ],
      "properties": {
        "text": {
          "type": "string"
        },
        "edited": {
          "type": "boolean"
        },
        "facets": {
          "type": "array",
          "items": {
            "ref": "lex:social.colibri.richtext.facet",
            "type": "ref"
          }
        },
        "parent": {
          "type": "string",
          "format": "at-uri"
        },
        "createdAt": {
          "type": "string",
          "format": "datetime"
        },
        "attachments": {
          "type": "array",
          "items": {
            "ref": "lex:social.colibri.channel.defs#attachment",
            "type": "ref"
          }
        }
      },
      "description": "The message a notification refers to."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```