|
| 1 | +--- |
| 2 | +title: Events |
| 3 | +description: Events protocol schemas |
| 4 | +--- |
| 5 | + |
| 6 | +{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs go in content/docs/guides/. */} |
| 7 | + |
| 8 | +Metadata Event Types |
| 9 | + |
| 10 | +Triggered when metadata items are created, updated, or deleted. |
| 11 | + |
| 12 | +Follows the pattern: `metadata.\{type\}.\{action\}` |
| 13 | + |
| 14 | +Examples: |
| 15 | + |
| 16 | +- `metadata.object.created` - A new object was created |
| 17 | + |
| 18 | +- `metadata.view.updated` - A view was updated |
| 19 | + |
| 20 | +- `metadata.agent.deleted` - An agent was deleted |
| 21 | + |
| 22 | +<Callout type="info"> |
| 23 | +**Source:** `packages/spec/src/api/events.zod.ts` |
| 24 | +</Callout> |
| 25 | + |
| 26 | +## TypeScript Usage |
| 27 | + |
| 28 | +```typescript |
| 29 | +import { DataEvent, DataEventType, MetadataEventType } from '@objectstack/spec/api'; |
| 30 | +import type { DataEvent, DataEventType, MetadataEventType } from '@objectstack/spec/api'; |
| 31 | + |
| 32 | +// Validate data |
| 33 | +const result = DataEvent.parse(data); |
| 34 | +``` |
| 35 | + |
| 36 | +--- |
| 37 | + |
| 38 | +## DataEvent |
| 39 | + |
| 40 | +### Properties |
| 41 | + |
| 42 | +| Property | Type | Required | Description | |
| 43 | +| :--- | :--- | :--- | :--- | |
| 44 | +| **id** | `string` | ✅ | Unique event identifier | |
| 45 | +| **type** | `Enum<'data.record.created' \| 'data.record.updated' \| 'data.record.deleted' \| 'data.field.changed'>` | ✅ | Event type | |
| 46 | +| **object** | `string` | ✅ | Object name | |
| 47 | +| **recordId** | `string` | ✅ | Record ID | |
| 48 | +| **changes** | `Record<string, any>` | optional | Changed fields | |
| 49 | +| **before** | `Record<string, any>` | optional | Before state | |
| 50 | +| **after** | `Record<string, any>` | optional | After state | |
| 51 | +| **userId** | `string` | optional | User who triggered the event | |
| 52 | +| **timestamp** | `string` | ✅ | Event timestamp | |
| 53 | + |
| 54 | + |
| 55 | +--- |
| 56 | + |
| 57 | +## DataEventType |
| 58 | + |
| 59 | +### Allowed Values |
| 60 | + |
| 61 | +* `data.record.created` |
| 62 | +* `data.record.updated` |
| 63 | +* `data.record.deleted` |
| 64 | +* `data.field.changed` |
| 65 | + |
| 66 | + |
| 67 | +--- |
| 68 | + |
| 69 | +## MetadataEventType |
| 70 | + |
| 71 | +### Allowed Values |
| 72 | + |
| 73 | +* `metadata.object.created` |
| 74 | +* `metadata.object.updated` |
| 75 | +* `metadata.object.deleted` |
| 76 | +* `metadata.field.created` |
| 77 | +* `metadata.field.updated` |
| 78 | +* `metadata.field.deleted` |
| 79 | +* `metadata.view.created` |
| 80 | +* `metadata.view.updated` |
| 81 | +* `metadata.view.deleted` |
| 82 | +* `metadata.app.created` |
| 83 | +* `metadata.app.updated` |
| 84 | +* `metadata.app.deleted` |
| 85 | +* `metadata.agent.created` |
| 86 | +* `metadata.agent.updated` |
| 87 | +* `metadata.agent.deleted` |
| 88 | +* `metadata.tool.created` |
| 89 | +* `metadata.tool.updated` |
| 90 | +* `metadata.tool.deleted` |
| 91 | +* `metadata.flow.created` |
| 92 | +* `metadata.flow.updated` |
| 93 | +* `metadata.flow.deleted` |
| 94 | +* `metadata.action.created` |
| 95 | +* `metadata.action.updated` |
| 96 | +* `metadata.action.deleted` |
| 97 | +* `metadata.workflow.created` |
| 98 | +* `metadata.workflow.updated` |
| 99 | +* `metadata.workflow.deleted` |
| 100 | +* `metadata.dashboard.created` |
| 101 | +* `metadata.dashboard.updated` |
| 102 | +* `metadata.dashboard.deleted` |
| 103 | +* `metadata.report.created` |
| 104 | +* `metadata.report.updated` |
| 105 | +* `metadata.report.deleted` |
| 106 | +* `metadata.role.created` |
| 107 | +* `metadata.role.updated` |
| 108 | +* `metadata.role.deleted` |
| 109 | +* `metadata.permission.created` |
| 110 | +* `metadata.permission.updated` |
| 111 | +* `metadata.permission.deleted` |
| 112 | + |
| 113 | + |
| 114 | +--- |
| 115 | + |
0 commit comments