ObjectStackObjectStack

Events Dlq

Events Dlq protocol schemas

Source: packages/spec/src/kernel/events/dlq.zod.ts

TypeScript Usage

import { DeadLetterQueueEntrySchema, EventLogEntrySchema } from '@objectstack/spec/kernel';
import type { DeadLetterQueueEntry, EventLogEntry } from '@objectstack/spec/kernel';

// Validate data
const result = DeadLetterQueueEntrySchema.parse(data);

DeadLetterQueueEntry

Properties

PropertyTypeRequiredDescription
idstringUnique entry identifier
event{ id?: string; name: string; payload: any; metadata: object }Original event
error{ message: string; stack?: string; code?: string }Failure details
retriesintegerNumber of retry attempts
firstFailedAtstringWhen event first failed
lastFailedAtstringWhen event last failed
failedHandlerstringoptionalHandler ID that failed

Nested Shape: DeadLetterQueueEntry.event

PropertyTypeRequiredDescription
idstringoptionalUnique event identifier
namestringEvent name (dot notation by convention, e.g. user.created, order.paid; the platform-checked event vocabulary is the closed DataEventType / BulkDataEventType enums)
payloadanyEvent payload schema
metadata{ source: string; timestamp: string; userId?: string; tenantId?: string; … }Event metadata

Nested Shape: DeadLetterQueueEntry.error

PropertyTypeRequiredDescription
messagestringError message
stackstringoptionalError stack trace
codestringoptionalError code

EventLogEntry

Properties

PropertyTypeRequiredDescription
idstringUnique log entry identifier
event{ id?: string; name: string; payload: any; metadata: object }The event
statusEnum<'pending' | 'processing' | 'completed' | 'failed'>Processing status
handlersExecuted{ handlerId: string; status: Enum<'success' | 'failed' | 'timeout'>; durationMs?: integer; error?: string }[]optionalHandlers that processed this event
receivedAtstringWhen event was received
processedAtstringoptionalWhen event was processed
totalDurationMsintegeroptionalTotal processing time

Nested Shape: EventLogEntry.event

PropertyTypeRequiredDescription
idstringoptionalUnique event identifier
namestringEvent name (dot notation by convention, e.g. user.created, order.paid; the platform-checked event vocabulary is the closed DataEventType / BulkDataEventType enums)
payloadanyEvent payload schema
metadata{ source: string; timestamp: string; userId?: string; tenantId?: string; … }Event metadata

Nested Shape: EventLogEntry.handlersExecuted[number]

PropertyTypeRequiredDescription
handlerIdstringHandler identifier
statusEnum<'success' | 'failed' | 'timeout'>Handler execution status
durationMsintegeroptionalExecution duration
errorstringoptionalError message if failed

On this page