Skip to content

Documentation / @agentick/shared / SystemEventBlock

Interface: SystemEventBlock ​

Defined in: blocks.ts:314

System event block - Records a system/application event

The text field provides a human-readable formatted representation, typically populated via JSX children.

Extends ​

Properties ​

createdAt? ​

readonly optional createdAt: string

Defined in: blocks.ts:58

ISO 8601 timestamp when this block was created

Inherited from ​

BaseContentBlock.createdAt


data? ​

readonly optional data: Record<string, any>

Defined in: blocks.ts:318


event ​

readonly event: string

Defined in: blocks.ts:316


id? ​

readonly optional id: string

Defined in: blocks.ts:54

Unique identifier for this block

Inherited from ​

BaseContentBlock.id


index? ​

readonly optional index: number

Defined in: blocks.ts:62

Position of this block within the message

Inherited from ​

BaseContentBlock.index


messageId? ​

readonly optional messageId: string

Defined in: blocks.ts:56

ID of the message containing this block

Inherited from ​

BaseContentBlock.messageId


metadata? ​

readonly optional metadata: Record<string, any>

Defined in: blocks.ts:64

Additional metadata

Inherited from ​

BaseContentBlock.metadata


mimeType? ​

readonly optional mimeType: string

Defined in: blocks.ts:60

MIME type of the content (for media blocks)

Inherited from ​

BaseContentBlock.mimeType


source? ​

readonly optional source: string

Defined in: blocks.ts:317


summary? ​

readonly optional summary: string

Defined in: blocks.ts:66

Human-readable summary of the content

Inherited from ​

BaseContentBlock.summary


text? ​

readonly optional text: string

Defined in: blocks.ts:320

Formatted text representation (from JSX children)


type ​

readonly type: "system_event" | SYSTEM_EVENT

Defined in: blocks.ts:315

Discriminator for type narrowing (e.g., 'text', 'image', 'tool_use')

Overrides ​

BaseContentBlock.type

Released under the ISC License.