---
title: Notification
description: Notification protocol schemas
---

{/* ⚠️  AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs go in content/docs/guides/. */}

<Callout type="info">
**Source:** `packages/spec/src/api/notification.zod.ts`
</Callout>

## TypeScript Usage

```typescript
import { Notification } from '@objectstack/spec/api';
import type { Notification } from '@objectstack/spec/api';

// Validate data
const result = Notification.parse(data);
```

---

## Notification

### Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **id** | `string` | ✅ | Notification ID |
| **type** | `string` | ✅ | Notification type |
| **title** | `string` | ✅ | Notification title |
| **body** | `string` | ✅ | Notification body text |
| **read** | `boolean` | ✅ | Whether notification has been read |
| **data** | `Record<string, any>` | optional | Additional notification data |
| **actionUrl** | `string` | optional | URL to navigate to when clicked |
| **createdAt** | `string` | ✅ | When notification was created |


---

