PersistentAI API Documentation / @persistentai/fireflow-vfs / / VFSEventPayload

Interface: VFSEventPayload

Defined in: packages/fireflow-vfs/src/types/vfs-subscription-messages.ts:16

VFS Event payload as received from Redis (serialized) Note: createdAt is ISO string in wire format

Properties

branchName?

optional branchName: string

Defined in: packages/fireflow-vfs/src/types/vfs-subscription-messages.ts:26

Branch name (if applicable)

---

commitId?

optional commitId: string

Defined in: packages/fireflow-vfs/src/types/vfs-subscription-messages.ts:30

Commit ID (for commit-related events)

---

createdAt

createdAt: string

Defined in: packages/fireflow-vfs/src/types/vfs-subscription-messages.ts:36

Event timestamp (ISO string in wire format)

---

eventName

eventName: string

Defined in: packages/fireflow-vfs/src/types/vfs-subscription-messages.ts:24

Event name for routing

---

eventType

eventType: VFSEventType

Defined in: packages/fireflow-vfs/src/types/vfs-subscription-messages.ts:22

Event type

---

id

id: string

Defined in: packages/fireflow-vfs/src/types/vfs-subscription-messages.ts:18

Event ID

---

metadata?

optional metadata: Record<string, unknown>

Defined in: packages/fireflow-vfs/src/types/vfs-subscription-messages.ts:34

Additional event-specific metadata

---

path?

optional path: string

Defined in: packages/fireflow-vfs/src/types/vfs-subscription-messages.ts:28

File path (if applicable)

---

treeOperations?

optional treeOperations: TreeOperation[]

Defined in: packages/fireflow-vfs/src/types/vfs-subscription-messages.ts:38

Tree operations for frontend state updates

---

userId

userId: string

Defined in: packages/fireflow-vfs/src/types/vfs-subscription-messages.ts:32

User ID who performed the action

---

workspaceId

workspaceId: string

Defined in: packages/fireflow-vfs/src/types/vfs-subscription-messages.ts:20

Workspace ID