Skip to main content
The Project module renders a customer’s onboarding project — its milestones, tasks, progress, and editable fields — and lets the customer update them. Use the pre-assembled component, drop to the headless hook, or compose your own layout from primitives. Everything here reads connection + auth from <StatisfyProvider> (except the standalone createProjectClient).
The project endpoints require a portal-session token — one carrying a customer_id claim, which only the POST /sdk/auth exchange produces. If your backend mints the bearer itself (the vendored path), these calls return 401 not_a_portal_session; the Digital Worker chat still works. See Authentication.

ProjectModule

The pre-assembled, ready-to-render project view.
It renders a header, a progress meter, a milestone journey, and the task list — and writes edits back through the gateway, scoped to the session’s customer.

Headless: useProject

For full control of the layout, use the hook. It resolves the project (by id, or via config when you omit the id), exposes the data, and provides optimistic mutations.

UseProjectResult

updateTask / updateProject apply your change optimistically (the UI updates immediately), then reconcile with the server’s full response — and roll the row back if the request fails. They reject on failure so you can show an inline error.
Send only the fields you’re changing (a diff), and only editable fields. A non-editable or unknown key is rejected with 400 not_editable; a bad value with 400 invalid_option / 400 invalid_type.

Composable primitives

Build a bespoke layout from the same building blocks ProjectModule uses. Each is schema-driven and styled with the SDK’s theme. Two non-component helpers round it out:
  • formatFieldValue(schema, properties, display) — the display string for one field, usable outside React.
  • useComments(projectId, taskId?) — the headless hook behind Comments, returning { comments, loading, error, posting, addComment, reload }.
These props are positional in meaning, not interchangeable: TaskList takes milestones + tasksByParent (not a flat tasks array) and onSelectTask (not an update callback) — it selects a task, it doesn’t write. Writes go through useProject’s updateTask.

Comments

Drop a comment thread onto a project or a single task. TaskDetail already includes one; use Comments directly when you’re composing your own layout.
Comments come back in server order (oldest first). addComment appends the server row on success and rejects on failure, so you can surface an inline error.

Standalone client: createProjectClient

When you want project data outside React (or your own state layer), use the client directly. It doesn’t need the provider — pass config explicitly.
Comments posted through the SDK are always customer-visible (external). Editing a comment is REST-only — PATCH /sdk/v1/projects/{id}/comments/{commentId}, author-only — and has no client method in v0.

Data shapes

See the API Reference for endpoints, headers, and error codes.