Skip to content

storage:sessionEvent

FieldValue
Prefixstorage:sessionEvent
Namespace constantSessionEventStorageNamespace
Subjects constantSessionEventStorageSubjects
Kindstorage
Schema record<inline>
Tierframework
Package@makaio/contracts
Defined inpackages/contracts/src/session/session-event-storage-namespace.ts
KeyWireTypeSchema
appendstorage:sessionEvent.appendrpc
deleteBySessionstorage:sessionEvent.deleteBySessionrpc
getByIdsstorage:sessionEvent.getByIdsrpc
getEventsstorage:sessionEvent.getEventsrpc
getEventsBySessionsstorage:sessionEvent.getEventsBySessionsrpc

Append an event to storage.

Subject: storage:sessionEvent.append Type: Request (RPC)

Events are immutable — no update method exists.

Request:

FieldTypeRequired
event{ sessionId: string; eventId: string; timestamp: number; type: "agent.added"; payload: { sessionId: string; adapterSessionId: string; agentId: string; adapterId: string; adapterName: string; role?: "lead" | "member" | undefined; model?: string | undefined; cwd?: string | undefined; }; } | { sessionId: string; eventId: string; timestamp: number; type: "user_message.sent"; payload: { sessionId: string; turnId: string; turnNumber: number; messageId: string; content: string | { blocks: { type: "text"; content: string; } | { type: "image"; source: { type: "base64"; data: string; mimeType: string; } | { type: "url"; url: string; mimeType?: string | undefined; }; } | { type: "document"; source: { type: "base64"; data: string; mimeType: string; } | { type: "url"; url: string; mimeType?: string | undefined; }; } | { type: "attachment"; fileName: string; filePath: string; source: { type: "base64"; data: string; mimeType: string; } | { type: "url"; url: string; mimeType?: string | undefined; }; attachmentType: "file" | "directory"; displayName?: string | undefined; } | { type: "reasoning"; content: string; metadata?: Record<string, unknown> | undefined; } | { type: "tool_call"; toolCallId: string; name: string; args: Record<string, unknown>; } | { type: "tool_output"; toolCallId: string; output: string; isError?: boolean | undefined; } | ({ type: "text"; content: string; } | { type: "image"; source: { type: "base64"; data: string; mimeType: string; } | { type: "url"; url: string; mimeType?: string | undefined; }; } | { type: "document"; source: { type: "base64"; data: string; mimeType: string; } | { type: "url"; url: string; mimeType?: string | undefined; }; } | { type: "attachment"; fileName: string; filePath: string; source: { type: "base64"; data: string; mimeType: string; } | { type: "url"; url: string; mimeType?: string | undefined; }; attachmentType: "file" | "directory"; displayName?: string | undefined; } | { type: "reasoning"; content: string; metadata?: Record<string, unknown> | undefined; } | { type: "tool_call"; toolCallId: string; name: string; args: Record<string, unknown>; } | { type: "tool_output"; toolCallId: string; output: string; isError?: boolean | undefined; })[]; role?: "user" | "assistant" | "system" | undefined; }; agentIds: string[]; source?: "user" | "system" | "extension" | undefined; origin?: "text" | "voice" | "compact" | undefined; }; } | { sessionId: string; eventId: string; timestamp: number; type: "user_message.acknowledged"; payload: { sessionId: string; turnId: string; turnNumber: number; messageId: string; agentId: string; }; } | { sessionId: string; eventId: string; timestamp: number; type: "user_message.completed"; payload: { sessionId: string; turnId: string; turnNumber: number; messageId: string; agentId: string; outcome: "error" | "completed" | "superseded" | "merged" | "cancelled" | "rejected"; supersededBy?: string | undefined; mergedInto?: string | undefined; error?: string | undefined; }; } | { sessionId: string; eventId: string; timestamp: number; type: "turn.started"; payload: { sessionId: string; turnId: string; turnNumber: number; messageId: string; agentIds: string[]; initiator?: { source: "user" | "system" | "extension"; sourceId?: string | undefined; } | undefined; }; } | { sessionId: string; eventId: string; timestamp: number; type: "turn.completed"; payload: { sessionId: string; turnId: string; turnNumber: number; success: boolean; error?: string | undefined; initiator?: { source: "user" | "system" | "extension"; sourceId?: string | undefined; } | undefined; }; } | { sessionId: string; eventId: string; timestamp: number; type: "message"; payload: { messageId: string; turnId: string | null; role: "user" | "assistant"; }; } | { sessionId: string; eventId: string; timestamp: number; type: "branch.created"; payload: { childSessionId: string; parentSessionId: string; kind: "fork" | "subagent" | "compress" | "branch" | "rewrite" | "coordinator" | "aside"; forkPointMessageId?: string | undefined; }; } | { sessionId: string; eventId: string; timestamp: number; type: "branch.merged"; payload: { childSessionId: string; parentSessionId: string; resultJson?: string | undefined; resultMessageId?: string | undefined; }; } | { sessionId: string; eventId: string; timestamp: number; type: "squash"; payload: { summaryJson: string; tokensBefore?: number | undefined; tokensAfter?: number | undefined; compressedMessageIds?: string[] | undefined; }; } | { sessionId: string; eventId: string; timestamp: number; type: string; payload: Record<string, unknown>; }yes

Response:

FieldTypeRequired
successbooleanyes

storage:sessionEvent.deleteBySession (rpc)

Section titled “storage:sessionEvent.deleteBySession (rpc)”

Delete all events for a session.

Subject: storage:sessionEvent.deleteBySession Type: Request (RPC)

Request:

FieldTypeRequired
sessionIdstringyes

Response:

FieldTypeRequired
deletedCountnumber | undefinedno
successbooleanyes

Get events by ID for a session.

Subject: storage:sessionEvent.getByIds Type: Request (RPC)

Request:

FieldTypeRequired
eventIdsstring[]yes
sessionIdstringyes

Response:

FieldTypeRequired
events({ sessionId: string; eventId: string; timestamp: number; type: "agent.added"; payload: { sessionId: string; adapterSessionId: string; agentId: string; adapterId: string; adapterName: string; role?: "lead" | "member" | undefined; model?: string | undefined; cwd?: string | undefined; }; } | { sessionId: string; eventId: string; timestamp: number; type: "user_message.sent"; payload: { sessionId: string; turnId: string; turnNumber: number; messageId: string; content: string | { blocks: { type: "text"; content: string; } | { type: "image"; source: { type: "base64"; data: string; mimeType: string; } | { type: "url"; url: string; mimeType?: string | undefined; }; } | { type: "document"; source: { type: "base64"; data: string; mimeType: string; } | { type: "url"; url: string; mimeType?: string | undefined; }; } | { type: "attachment"; fileName: string; filePath: string; source: { type: "base64"; data: string; mimeType: string; } | { type: "url"; url: string; mimeType?: string | undefined; }; attachmentType: "file" | "directory"; displayName?: string | undefined; } | { type: "reasoning"; content: string; metadata?: Record<string, unknown> | undefined; } | { type: "tool_call"; toolCallId: string; name: string; args: Record<string, unknown>; } | { type: "tool_output"; toolCallId: string; output: string; isError?: boolean | undefined; } | ({ type: "text"; content: string; } | { type: "image"; source: { type: "base64"; data: string; mimeType: string; } | { type: "url"; url: string; mimeType?: string | undefined; }; } | { type: "document"; source: { type: "base64"; data: string; mimeType: string; } | { type: "url"; url: string; mimeType?: string | undefined; }; } | { type: "attachment"; fileName: string; filePath: string; source: { type: "base64"; data: string; mimeType: string; } | { type: "url"; url: string; mimeType?: string | undefined; }; attachmentType: "file" | "directory"; displayName?: string | undefined; } | { type: "reasoning"; content: string; metadata?: Record<string, unknown> | undefined; } | { type: "tool_call"; toolCallId: string; name: string; args: Record<string, unknown>; } | { type: "tool_output"; toolCallId: string; output: string; isError?: boolean | undefined; })[]; role?: "user" | "assistant" | "system" | undefined; }; agentIds: string[]; source?: "user" | "system" | "extension" | undefined; origin?: "text" | "voice" | "compact" | undefined; }; } | { sessionId: string; eventId: string; timestamp: number; type: "user_message.acknowledged"; payload: { sessionId: string; turnId: string; turnNumber: number; messageId: string; agentId: string; }; } | { sessionId: string; eventId: string; timestamp: number; type: "user_message.completed"; payload: { sessionId: string; turnId: string; turnNumber: number; messageId: string; agentId: string; outcome: "error" | "completed" | "superseded" | "merged" | "cancelled" | "rejected"; supersededBy?: string | undefined; mergedInto?: string | undefined; error?: string | undefined; }; } | { sessionId: string; eventId: string; timestamp: number; type: "turn.started"; payload: { sessionId: string; turnId: string; turnNumber: number; messageId: string; agentIds: string[]; initiator?: { source: "user" | "system" | "extension"; sourceId?: string | undefined; } | undefined; }; } | { sessionId: string; eventId: string; timestamp: number; type: "turn.completed"; payload: { sessionId: string; turnId: string; turnNumber: number; success: boolean; error?: string | undefined; initiator?: { source: "user" | "system" | "extension"; sourceId?: string | undefined; } | undefined; }; } | { sessionId: string; eventId: string; timestamp: number; type: "message"; payload: { messageId: string; turnId: string | null; role: "user" | "assistant"; }; } | { sessionId: string; eventId: string; timestamp: number; type: "branch.created"; payload: { childSessionId: string; parentSessionId: string; kind: "fork" | "subagent" | "compress" | "branch" | "rewrite" | "coordinator" | "aside"; forkPointMessageId?: string | undefined; }; } | { sessionId: string; eventId: string; timestamp: number; type: "branch.merged"; payload: { childSessionId: string; parentSessionId: string; resultJson?: string | undefined; resultMessageId?: string | undefined; }; } | { sessionId: string; eventId: string; timestamp: number; type: "squash"; payload: { summaryJson: string; tokensBefore?: number | undefined; tokensAfter?: number | undefined; compressedMessageIds?: string[] | undefined; }; } | { sessionId: string; eventId: string; timestamp: number; type: string; payload: Record<string, unknown>; })[]yes

Get events for a session with cursor-based pagination.

Subject: storage:sessionEvent.getEvents Type: Request (RPC)

Request:

FieldTypeRequired
options{ after?: string | undefined; limit?: number | undefined; types?: string[] | undefined; includeReasoning?: boolean | undefined; order?: "asc" | "desc" | undefined; } | undefinedno
sessionIdstringyes

Response:

FieldTypeRequired
events({ sessionId: string; eventId: string; timestamp: number; type: "agent.added"; payload: { sessionId: string; adapterSessionId: string; agentId: string; adapterId: string; adapterName: string; role?: "lead" | "member" | undefined; model?: string | undefined; cwd?: string | undefined; }; } | { sessionId: string; eventId: string; timestamp: number; type: "user_message.sent"; payload: { sessionId: string; turnId: string; turnNumber: number; messageId: string; content: string | { blocks: { type: "text"; content: string; } | { type: "image"; source: { type: "base64"; data: string; mimeType: string; } | { type: "url"; url: string; mimeType?: string | undefined; }; } | { type: "document"; source: { type: "base64"; data: string; mimeType: string; } | { type: "url"; url: string; mimeType?: string | undefined; }; } | { type: "attachment"; fileName: string; filePath: string; source: { type: "base64"; data: string; mimeType: string; } | { type: "url"; url: string; mimeType?: string | undefined; }; attachmentType: "file" | "directory"; displayName?: string | undefined; } | { type: "reasoning"; content: string; metadata?: Record<string, unknown> | undefined; } | { type: "tool_call"; toolCallId: string; name: string; args: Record<string, unknown>; } | { type: "tool_output"; toolCallId: string; output: string; isError?: boolean | undefined; } | ({ type: "text"; content: string; } | { type: "image"; source: { type: "base64"; data: string; mimeType: string; } | { type: "url"; url: string; mimeType?: string | undefined; }; } | { type: "document"; source: { type: "base64"; data: string; mimeType: string; } | { type: "url"; url: string; mimeType?: string | undefined; }; } | { type: "attachment"; fileName: string; filePath: string; source: { type: "base64"; data: string; mimeType: string; } | { type: "url"; url: string; mimeType?: string | undefined; }; attachmentType: "file" | "directory"; displayName?: string | undefined; } | { type: "reasoning"; content: string; metadata?: Record<string, unknown> | undefined; } | { type: "tool_call"; toolCallId: string; name: string; args: Record<string, unknown>; } | { type: "tool_output"; toolCallId: string; output: string; isError?: boolean | undefined; })[]; role?: "user" | "assistant" | "system" | undefined; }; agentIds: string[]; source?: "user" | "system" | "extension" | undefined; origin?: "text" | "voice" | "compact" | undefined; }; } | { sessionId: string; eventId: string; timestamp: number; type: "user_message.acknowledged"; payload: { sessionId: string; turnId: string; turnNumber: number; messageId: string; agentId: string; }; } | { sessionId: string; eventId: string; timestamp: number; type: "user_message.completed"; payload: { sessionId: string; turnId: string; turnNumber: number; messageId: string; agentId: string; outcome: "error" | "completed" | "superseded" | "merged" | "cancelled" | "rejected"; supersededBy?: string | undefined; mergedInto?: string | undefined; error?: string | undefined; }; } | { sessionId: string; eventId: string; timestamp: number; type: "turn.started"; payload: { sessionId: string; turnId: string; turnNumber: number; messageId: string; agentIds: string[]; initiator?: { source: "user" | "system" | "extension"; sourceId?: string | undefined; } | undefined; }; } | { sessionId: string; eventId: string; timestamp: number; type: "turn.completed"; payload: { sessionId: string; turnId: string; turnNumber: number; success: boolean; error?: string | undefined; initiator?: { source: "user" | "system" | "extension"; sourceId?: string | undefined; } | undefined; }; } | { sessionId: string; eventId: string; timestamp: number; type: "message"; payload: { messageId: string; turnId: string | null; role: "user" | "assistant"; }; } | { sessionId: string; eventId: string; timestamp: number; type: "branch.created"; payload: { childSessionId: string; parentSessionId: string; kind: "fork" | "subagent" | "compress" | "branch" | "rewrite" | "coordinator" | "aside"; forkPointMessageId?: string | undefined; }; } | { sessionId: string; eventId: string; timestamp: number; type: "branch.merged"; payload: { childSessionId: string; parentSessionId: string; resultJson?: string | undefined; resultMessageId?: string | undefined; }; } | { sessionId: string; eventId: string; timestamp: number; type: "squash"; payload: { summaryJson: string; tokensBefore?: number | undefined; tokensAfter?: number | undefined; compressedMessageIds?: string[] | undefined; }; } | { sessionId: string; eventId: string; timestamp: number; type: string; payload: Record<string, unknown>; })[]yes
nextCursorstring | nullyes
totalCountnumber | undefinedno

storage:sessionEvent.getEventsBySessions (rpc)

Section titled “storage:sessionEvent.getEventsBySessions (rpc)”

Get events for multiple sessions, grouped by session ID.

Subject: storage:sessionEvent.getEventsBySessions Type: Request (RPC)

Request:

FieldTypeRequired
limitPerSessionnumber | undefinedno
sessionIdsstring[]yes
typesstring[]yes

Response:

FieldTypeRequired
eventsBySessionRecord<string, ({ sessionId: string; eventId: string; timestamp: number; type: "agent.added"; payload: { sessionId: string; adapterSessionId: string; agentId: string; adapterId: string; adapterName: string; role?: "lead" | "member" | undefined; model?: string | undefined; cwd?: string | undefined; }; } | { sessionId: string; eventId: string; timestamp: number; type: "user_message.sent"; payload: { sessionId: string; turnId: string; turnNumber: number; messageId: string; content: string | { blocks: { type: "text"; content: string; } | { type: "image"; source: { type: "base64"; data: string; mimeType: string; } | { type: "url"; url: string; mimeType?: string | undefined; }; } | { type: "document"; source: { type: "base64"; data: string; mimeType: string; } | { type: "url"; url: string; mimeType?: string | undefined; }; } | { type: "attachment"; fileName: string; filePath: string; source: { type: "base64"; data: string; mimeType: string; } | { type: "url"; url: string; mimeType?: string | undefined; }; attachmentType: "file" | "directory"; displayName?: string | undefined; } | { type: "reasoning"; content: string; metadata?: Record<string, unknown> | undefined; } | { type: "tool_call"; toolCallId: string; name: string; args: Record<string, unknown>; } | { type: "tool_output"; toolCallId: string; output: string; isError?: boolean | undefined; } | ({ type: "text"; content: string; } | { type: "image"; source: { type: "base64"; data: string; mimeType: string; } | { type: "url"; url: string; mimeType?: string | undefined; }; } | { type: "document"; source: { type: "base64"; data: string; mimeType: string; } | { type: "url"; url: string; mimeType?: string | undefined; }; } | { type: "attachment"; fileName: string; filePath: string; source: { type: "base64"; data: string; mimeType: string; } | { type: "url"; url: string; mimeType?: string | undefined; }; attachmentType: "file" | "directory"; displayName?: string | undefined; } | { type: "reasoning"; content: string; metadata?: Record<string, unknown> | undefined; } | { type: "tool_call"; toolCallId: string; name: string; args: Record<string, unknown>; } | { type: "tool_output"; toolCallId: string; output: string; isError?: boolean | undefined; })[]; role?: "user" | "assistant" | "system" | undefined; }; agentIds: string[]; source?: "user" | "system" | "extension" | undefined; origin?: "text" | "voice" | "compact" | undefined; }; } | { sessionId: string; eventId: string; timestamp: number; type: "user_message.acknowledged"; payload: { sessionId: string; turnId: string; turnNumber: number; messageId: string; agentId: string; }; } | { sessionId: string; eventId: string; timestamp: number; type: "user_message.completed"; payload: { sessionId: string; turnId: string; turnNumber: number; messageId: string; agentId: string; outcome: "error" | "completed" | "superseded" | "merged" | "cancelled" | "rejected"; supersededBy?: string | undefined; mergedInto?: string | undefined; error?: string | undefined; }; } | { sessionId: string; eventId: string; timestamp: number; type: "turn.started"; payload: { sessionId: string; turnId: string; turnNumber: number; messageId: string; agentIds: string[]; initiator?: { source: "user" | "system" | "extension"; sourceId?: string | undefined; } | undefined; }; } | { sessionId: string; eventId: string; timestamp: number; type: "turn.completed"; payload: { sessionId: string; turnId: string; turnNumber: number; success: boolean; error?: string | undefined; initiator?: { source: "user" | "system" | "extension"; sourceId?: string | undefined; } | undefined; }; } | { sessionId: string; eventId: string; timestamp: number; type: "message"; payload: { messageId: string; turnId: string | null; role: "user" | "assistant"; }; } | { sessionId: string; eventId: string; timestamp: number; type: "branch.created"; payload: { childSessionId: string; parentSessionId: string; kind: "fork" | "subagent" | "compress" | "branch" | "rewrite" | "coordinator" | "aside"; forkPointMessageId?: string | undefined; }; } | { sessionId: string; eventId: string; timestamp: number; type: "branch.merged"; payload: { childSessionId: string; parentSessionId: string; resultJson?: string | undefined; resultMessageId?: string | undefined; }; } | { sessionId: string; eventId: string; timestamp: number; type: "squash"; payload: { summaryJson: string; tokensBefore?: number | undefined; tokensAfter?: number | undefined; compressedMessageIds?: string[] | undefined; }; } | { sessionId: string; eventId: string; timestamp: number; type: string; payload: Record<string, unknown>; })[]>yes

Auto-generated by yarn docs:bus. Do not edit manually.