Settings.defineWorkspaceSchema()

Settings.defineWorkspaceSchema() declares the workspace-scoped settings of your app: the setting names and their types. The schema is the source of type safety for every other settings API: Settings.useForm, Settings.useSettings, Settings.getSettings, and Settings.setSettings all take the schema and infer their types from it.

File location

The schema must be the default export of a file in src/app/settings/, conventionally src/app/settings/schema.ts, so the CLI can discover it.

src/app/settings/schema.ts

import {Settings} from "attio"

export default Settings.defineWorkspaceSchema({
  team_name: Settings.Schema.string(),
  auto_sync_enabled: Settings.Schema.boolean(),
  sync_interval_minutes: Settings.Schema.number(),
})

Note the import from "attio" (not attio/client or attio/server): the schema file is imported by both client and server code, so it must not depend on either runtime.

Setting types

The Settings.Schema namespace provides the following node builders:

SettingsStringNode

A setting holding a string value. Use this for text values like names, URLs, or identifiers.

SettingsNumberNode

A setting holding a number value. Use this for numeric values like intervals, limits, or thresholds.

SettingsBooleanNode

A setting holding a boolean value. Use this for toggles, checkboxes, or on/off configurations.

Values are `null` until set

Every setting value is null until a user (or your code) has set it. When you read settings, handle the null case:

import {Settings} from "attio/server"

import schema from "../app/settings/schema"

export default async function syncRecords() {
  const interval = await Settings.getSettings(schema, "sync_interval_minutes")
  // interval: number | null
  if (interval === null) {
    return {success: false, message: "Sync interval is not configured"}
  }
  return {success: true, interval}
}

Workspace settings Settings.defineWorkspacePage()

⌘I

Introduction

Guides

Extensions

Workflow blocks

Notifications

Dialogs

Components

Forms

Icons

Settings

GraphQL

Data fetching

Server

System

Legacy

Settings.defineWorkspaceSchema()

File location

Setting types

Values are `null` until set

​File location

​Setting types

​Values are null until set

File location

Setting types

Values are `null` until set