WORKX Docs

Visit /login. Sign in with Google OAuth.

Click Continue with Google. After approval you are redirected to your org, or prompted to create one.

WORKX issues a short-lived JWT access token and a rotatable refresh token, stored as HttpOnly cookies (hq_access / hq_refresh).

Click + New org in the sidebar. A multi-step wizard walks you through: name → database type → storage → AI provider → member invite.

Three options: Platform Shared (quickest), BYODB (connect your own Postgres), or Dedicated Managed (plan-gated).

The wizard lets you send email invites immediately, or skip and do it later from Settings → Members.

Inside your org, go to Projects and click + New project. Give it a name, key (e.g. SHIP), icon, and description.

Each project has two task views: Kanban (drag-and-drop columns) and List (flat sortable list).

Projects have tabs: Overview · Tasks · Requirements · Knowledge · Members · Settings. Each tab is permission-gated via RBAC.

In your org sidebar, click Settings, then the Members & Invites tab.

Click Invite User. Enter their email and assign an org-level role. They'll receive an email invite link.

Inside a project, go to the Members tab to add members and assign a project-specific role that overrides their org role.

In the List or Kanban tab, click + New Task. Set a title, status (TODO / IN_PROGRESS / DONE), and assignee.

Open a task and click the document tab. A full Tiptap editor lets you add rich content — the same editor used for requirements.

Thread comments directly on a task. Filter the task list by status, assignee, project, or date from the filter bar.

In the Requirements tab, click + Create Requirement. It opens as a full collaborative document.

Add: Acceptance Criteria, Comments, Attachments (files/images via org storage), a Decision Log, and linked Research docs.

Click Release to create an immutable snapshot. Compare any two versions side-by-side in the full-screen diff modal.

When multiple users open the same document, their cursors and text selections appear in real-time with unique colours shown in the presence bar.

Type /// anywhere in the editor to open the AI inline toolbar. Presets: Improve prose, Summarise, Generate acceptance criteria, Translate.

Insert a Mermaid diagram block from the editor toolbar. Diagrams are syntax-validated and rendered live inside the document.

Find the AI Provider Keys (BYOK) section. Click + Add Provider Key.

Select your provider (OpenAI, Anthropic, Google Gemini), paste your API key, and save.

Keys resolve in priority order — the most specific key wins:

Personal key (user override)
    ↓ Role-level key (via role AI policy)
        ↓ Org-level key (shared default)
            ↓ Platform stub (fallback)

Go to Workflows in the org nav. Click + New Workflow.

Drag nodes from the palette and connect them. Node types: Trigger, AI, Condition, HTTP, Delay, Code.

Save as a draft, then Publish a version and set it as Active. Execution history is stored per workflow.

Go to Settings → Knowledge to add org-wide items (text, file upload, or URL fetch).

Inside a project, go to the Knowledge tab. Upload files, paste a URL, or add plain text.

In the AI Chat panel, click Attach Knowledge to inject specific items into the current AI conversation context.

In Settings → MCP Tokens, click Create Token. Give it a name (e.g., “Claude Desktop”).

Copy the generated token and configure it as the Bearer token in your MCP client. The agent can then read projects, requirements, and tasks within your RBAC scope.

Tokens respect RBAC — an agent using a Member token cannot access Owner-only resources. Revoke any token instantly from Settings.

A GitHub-style full-year heatmap shows activity density per day. Select a year on the right. Hover a cell to see a breakdown by category. Timezone is adjustable.

A paginated, cursor-based list of all actions. Filter by user, project, category, date range, and role.

Click a team member card (or go to People) to see a full per-user heatmap + timeline with event breakdowns.