API Callbacks

Callbacks allow you to define custom cleanup logic when workspaces or entities are deleted.

Configuration

// convex/workspaces.ts
import { convexWorkspaces } from "convex-workspaces";
import { MutationCtx } from "./_generated/server";

export const {
  createWorkspace,
  removeWorkspace,
  createEntity,
  removeEntity,
  // ... other functions
} = convexWorkspaces({
  callbacks: {
    onWorkspaceRemoved: async (ctx: MutationCtx, { entityIds }) => {
      // Your cleanup logic here
    },
    onEntityRemoved: async (ctx: MutationCtx, { entityId }) => {
      // Your cleanup logic here
    },
  },
});

Available Callbacks

onWorkspaceRemoved

• Parameters: { entityIds: Id<entities>[] } - All entity IDs that were in the deleted workspace
• Triggered: When a workspace is deleted

onEntityRemoved

• Parameters: { entityId: Id<entities> } - The ID of the deleted entity
• Triggered: When an entity is deleted