Skip to content

The open alternative to Salesforce, designed for AI.

27.7 KB
Raw Blame
{
  "tabs": [
    {
      "key": "gettingStarted",
      "label": "Getting Started",
      "groups": [
        {
          "key": "welcome",
          "label": "Getting Started",
          "pages": [
            "getting-started/introduction",
            "getting-started/key-features",
            "getting-started/quickstart"
          ]
        },
        {
          "key": "coreConcepts",
          "label": "Core Concepts",
          "pages": [
            "getting-started/core-concepts/data-model",
            "getting-started/core-concepts/layout",
            "getting-started/core-concepts/workflows",
            "getting-started/core-concepts/calendar-and-email",
            "getting-started/core-concepts/ai",
            "getting-started/core-concepts/apps",
            "getting-started/core-concepts/dashboards",
            "getting-started/core-concepts/glossary"
          ]
        }
      ]
    },
    {
      "key": "userGuide",
      "label": "User Guide",
      "groups": [
        {
          "key": "userGuideOverview",
          "label": "User Guide",
          "pages": ["user-guide/introduction"]
        },
        {
          "key": "dataModel",
          "label": "Data Model",
          "pages": [
            "user-guide/data-model/overview",
            {
              "key": "dataModelReference",
              "label": "Reference",
              "pages": [
                "user-guide/data-model/capabilities/objects",
                "user-guide/data-model/capabilities/fields",
                "user-guide/data-model/capabilities/relation-fields"
              ]
            },
            {
              "key": "dataModelHowTos",
              "label": "How-Tos",
              "pages": [
                "user-guide/data-model/how-tos/create-custom-objects",
                "user-guide/data-model/how-tos/create-custom-fields",
                "user-guide/data-model/how-tos/create-relation-fields",
                "user-guide/data-model/how-tos/create-many-to-many-relations",
                "user-guide/data-model/how-tos/customize-your-data-model",
                "user-guide/data-model/how-tos/data-model-faq"
              ]
            }
          ]
        },
        {
          "key": "dataMigration",
          "label": "Data Migration",
          "pages": [
            "user-guide/data-migration/overview",
            {
              "key": "dataMigrationReference",
              "label": "Reference",
              "pages": [
                "user-guide/data-migration/capabilities/file-formats",
                "user-guide/data-migration/capabilities/field-mapping",
                "user-guide/data-migration/capabilities/uniqueness-constraints",
                "user-guide/data-migration/capabilities/import-relations",
                "user-guide/data-migration/capabilities/error-handling"
              ]
            },
            {
              "key": "dataMigrationHowTos",
              "label": "How-Tos",
              "pages": [
                "user-guide/data-migration/how-tos/prepare-your-csv-files",
                "user-guide/data-migration/how-tos/import-companies-via-csv",
                "user-guide/data-migration/how-tos/import-contacts-via-csv",
                "user-guide/data-migration/how-tos/import-relations-between-objects-via-csv",
                "user-guide/data-migration/how-tos/update-existing-records-via-import",
                "user-guide/data-migration/how-tos/fix-import-errors",
                "user-guide/data-migration/how-tos/export-your-data",
                "user-guide/data-migration/how-tos/import-data-via-api",
                "user-guide/data-migration/how-tos/migrating-from-other-crms",
                "user-guide/data-migration/how-tos/migrating-from-self-hosted-to-cloud"
              ]
            }
          ]
        },
        {
          "key": "calendarEmails",
          "label": "Calendar & Emails",
          "pages": [
            "user-guide/calendar-emails/overview",
            {
              "key": "calendarEmailsReference",
              "label": "Reference",
              "pages": [
                "user-guide/calendar-emails/capabilities/mailbox",
                "user-guide/calendar-emails/capabilities/email-channels",
                "user-guide/calendar-emails/capabilities/calendar"
              ]
            },
            {
              "key": "calendarEmailsHowTos",
              "label": "How-Tos",
              "pages": [
                "user-guide/calendar-emails/how-tos/connect-several-mailboxes-per-user",
                "user-guide/calendar-emails/how-tos/forward-a-shared-inbox-from-microsoft-365",
                "user-guide/calendar-emails/how-tos/forward-a-shared-inbox-from-google-workspace",
                "user-guide/calendar-emails/how-tos/forward-a-shared-inbox-from-any-mail-provider",
                "user-guide/calendar-emails/how-tos/limit-emails-imported",
                "user-guide/calendar-emails/how-tos/can-i-track-email-activity-on-all-objects",
                "user-guide/calendar-emails/how-tos/can-i-send-emails-from-twenty",
                "user-guide/calendar-emails/how-tos/can-i-book-meetings-from-twenty",
                "user-guide/calendar-emails/how-tos/i-dont-see-emails-on-records"
              ]
            }
          ]
        },
        {
          "key": "emailCampaigns",
          "label": "Email Campaigns",
          "pages": [
            "user-guide/email-campaigns/overview",
            {
              "key": "emailCampaignsHowTos",
              "label": "How-Tos",
              "pages": [
                "user-guide/email-campaigns/how-tos/set-up-a-sending-domain",
                "user-guide/email-campaigns/how-tos/email-campaign-best-practices",
                "user-guide/email-campaigns/how-tos/send-your-first-campaign",
                "user-guide/email-campaigns/how-tos/create-a-campaign-with-ai",
                "user-guide/email-campaigns/how-tos/manage-unsubscribes-and-topics"
              ]
            }
          ]
        },
        {
          "key": "workflows",
          "label": "Workflows",
          "pages": [
            "user-guide/workflows/overview",
            {
              "key": "workflowsReference",
              "label": "Reference",
              "pages": [
                "user-guide/workflows/capabilities/workflow-triggers",
                "user-guide/workflows/capabilities/workflow-actions",
                "user-guide/workflows/capabilities/workflow-branches",
                "user-guide/workflows/capabilities/workflow-runs",
                "user-guide/workflows/capabilities/workflow-versions",
                "user-guide/workflows/capabilities/workflow-credits",
                "user-guide/workflows/capabilities/use-branches-in-workflows",
                "user-guide/workflows/capabilities/use-iterator",
                "user-guide/workflows/capabilities/send-emails-from-workflows"
              ]
            },
            {
              "key": "workflowsHowTos",
              "label": "How-Tos",
              "pages": [
                {
                  "key": "crmAutomations",
                  "label": "CRM Automations",
                  "pages": [
                    "user-guide/workflows/how-tos/crm-automations/send-email-alerts-with-tasks-due",
                    "user-guide/workflows/how-tos/crm-automations/notify-teammates-of-note-to-review",
                    "user-guide/workflows/how-tos/crm-automations/display-number-of-emails-received",
                    "user-guide/workflows/how-tos/crm-automations/formula-fields",
                    "user-guide/workflows/how-tos/crm-automations/display-related-record-data",
                    "user-guide/workflows/how-tos/crm-automations/closed-won-automations",
                    "user-guide/workflows/how-tos/crm-automations/detect-stale-opportunities",
                    "user-guide/workflows/how-tos/crm-automations/auto-reply-to-inbound-emails"
                  ]
                },
                {
                  "key": "connectToOtherTools",
                  "label": "Connect to Other Tools",
                  "pages": [
                    "user-guide/workflows/how-tos/connect-to-other-tools/set-up-a-webhook-trigger",
                    "user-guide/workflows/how-tos/connect-to-other-tools/bring-typeform-submissions-in-twenty",
                    "user-guide/workflows/how-tos/connect-to-other-tools/bring-product-data-in-twenty",
                    "user-guide/workflows/how-tos/connect-to-other-tools/generate-quote-or-invoice-from-twenty",
                    "user-guide/workflows/how-tos/connect-to-other-tools/generate-pdf-from-twenty"
                  ]
                },
                {
                  "key": "advancedConfigurations",
                  "label": "Advanced Configurations",
                  "pages": [
                    "user-guide/workflows/how-tos/advanced-configurations/handle-arrays-in-code-actions"
                  ]
                },
                {
                  "key": "needMoreHelp",
                  "label": "Need More Help",
                  "pages": [
                    "user-guide/workflows/how-tos/need-more-help/workflow-troubleshooting",
                    "user-guide/workflows/how-tos/need-more-help/workflows-faq",
                    "user-guide/workflows/how-tos/need-more-help/professional-services"
                  ]
                }
              ]
            }
          ]
        },
        {
          "key": "ai",
          "label": "AI",
          "pages": [
            "user-guide/ai/overview",
            {
              "key": "aiReference",
              "label": "Reference",
              "pages": [
                "user-guide/ai/capabilities/ai-chatbot",
                "user-guide/ai/capabilities/ai-agents",
                "user-guide/ai/capabilities/permissions-access-control"
              ]
            },
            {
              "key": "aiHowTos",
              "label": "How-Tos",
              "pages": ["user-guide/ai/how-tos/ai-faq"]
            }
          ]
        },
        {
          "key": "layout",
          "label": "Layout",
          "pages": [
            "user-guide/layout/overview",
            {
              "key": "layoutReference",
              "label": "Reference",
              "pages": [
                "user-guide/layout/capabilities/navigation",
                {
                  "key": "layoutViews",
                  "label": "Views",
                  "pages": [
                    "user-guide/views-pipelines/capabilities/table-views",
                    "user-guide/views-pipelines/capabilities/kanban-views",
                    "user-guide/views-pipelines/capabilities/calendar-view",
                    "user-guide/views-pipelines/capabilities/filters-and-sorting",
                    "user-guide/views-pipelines/capabilities/fields-and-columns",
                    "user-guide/views-pipelines/capabilities/view-settings"
                  ]
                },
                "user-guide/layout/capabilities/record-pages"
              ]
            },
            {
              "key": "layoutHowTos",
              "label": "How-Tos",
              "pages": [
                "user-guide/views-pipelines/how-tos/create-a-table-view-with-grouping",
                "user-guide/views-pipelines/how-tos/create-a-kanban-view-for-projects",
                "user-guide/views-pipelines/how-tos/create-a-calendar-view-for-tasks-due",
                "user-guide/views-pipelines/how-tos/restrict-access-to-your-view",
                "user-guide/views-pipelines/how-tos/set-up-a-sales-pipeline",
                "user-guide/views-pipelines/how-tos/show-expected-amount-in-pipeline",
                "user-guide/views-pipelines/how-tos/track-time-in-stage"
              ]
            }
          ]
        },
        {
          "key": "dashboards",
          "label": "Dashboards",
          "pages": [
            "user-guide/dashboards/overview",
            {
              "key": "dashboardsReference",
              "label": "Reference",
              "pages": [
                "user-guide/dashboards/capabilities/dashboards",
                "user-guide/dashboards/capabilities/widgets",
                "user-guide/dashboards/capabilities/chart-settings"
              ]
            },
            {
              "key": "dashboardsHowTos",
              "label": "How-Tos",
              "pages": [
                "user-guide/dashboards/how-tos/dashboards-faq",
                "user-guide/dashboards/how-tos/widget-faq"
              ]
            }
          ]
        },
        {
          "key": "permissionsAccess",
          "label": "Permissions & Access",
          "pages": [
            "user-guide/permissions-access/overview",
            {
              "key": "permissionsAccessReference",
              "label": "Reference",
              "pages": [
                "user-guide/permissions-access/capabilities/permissions",
                "user-guide/permissions-access/capabilities/sso-configuration"
              ]
            },
            {
              "key": "permissionsAccessHowTos",
              "label": "How-Tos",
              "pages": ["user-guide/permissions-access/how-tos/permissions-faq"]
            }
          ]
        },
        {
          "key": "billing",
          "label": "Billing",
          "pages": [
            "user-guide/billing/overview",
            {
              "key": "billingReference",
              "label": "Reference",
              "pages": [
                "user-guide/billing/capabilities/pricing-plans",
                "user-guide/billing/capabilities/credits",
                "user-guide/billing/capabilities/usage-limits"
              ]
            },
            {
              "key": "billingHowTos",
              "label": "How-Tos",
              "pages": ["user-guide/billing/how-tos/billing-faq"]
            }
          ]
        },
        {
          "key": "settings",
          "label": "Settings",
          "pages": [
            "user-guide/settings/overview",
            {
              "key": "settingsReference",
              "label": "Reference",
              "pages": [
                "user-guide/settings/capabilities/workspace-settings",
                "user-guide/settings/capabilities/member-management",
                "user-guide/settings/capabilities/profile-settings",
                "user-guide/settings/capabilities/experience-settings",
                "user-guide/settings/capabilities/domains-settings",
                "user-guide/settings/capabilities/community-settings"
              ]
            },
            {
              "key": "settingsHowTos",
              "label": "How-Tos",
              "pages": ["user-guide/settings/how-tos/settings-faq"]
            }
          ]
        },
        {
          "key": "legal",
          "label": "Legal",
          "pages": [
            "user-guide/legal/overview",
            {
              "key": "legalHowTos",
              "label": "How-Tos",
              "pages": ["user-guide/legal/how-tos/legal-faq"]
            }
          ]
        }
      ]
    },
    {
      "key": "developers",
      "label": "Developers",
      "groups": [
        {
          "key": "developersOverview",
          "label": "Developers",
          "pages": ["developers/introduction"]
        },
        {
          "key": "apps",
          "label": "Apps",
          "pages": [
            {
              "key": "appsGettingStarted",
              "label": "Getting Started",
              "pages": [
                "developers/extend/apps/getting-started/quick-start",
                "developers/extend/apps/getting-started/concepts",
                "developers/extend/apps/getting-started/project-structure",
                "developers/extend/apps/getting-started/local-server",
                "developers/extend/apps/getting-started/scaffolding",
                "developers/extend/apps/getting-started/good-practices",
                "developers/extend/apps/getting-started/troubleshooting"
              ]
            },
            {
              "key": "appsTutorial",
              "label": "Tutorial",
              "root": "developers/extend/apps/tutorials/document-generator/overview",
              "pages": [
                "developers/extend/apps/tutorials/document-generator/data-model",
                "developers/extend/apps/tutorials/document-generator/generating-documents",
                "developers/extend/apps/tutorials/document-generator/http-routes",
                "developers/extend/apps/tutorials/document-generator/building-the-ui",
                "developers/extend/apps/tutorials/document-generator/ai-agent",
                "developers/extend/apps/tutorials/document-generator/publishing"
              ]
            },
            {
              "key": "appsConfig",
              "label": "Config",
              "root": "developers/extend/apps/config/overview",
              "pages": [
                "developers/extend/apps/config/application",
                "developers/extend/apps/config/roles",
                "developers/extend/apps/config/install-hooks",
                "developers/extend/apps/config/public-assets"
              ]
            },
            {
              "key": "appsData",
              "label": "Data",
              "root": "developers/extend/apps/data/overview",
              "pages": [
                "developers/extend/apps/data/objects",
                "developers/extend/apps/data/extending-objects",
                "developers/extend/apps/data/system-fields",
                "developers/extend/apps/data/relations",
                "developers/extend/apps/data/timeline-activity-types",
                "developers/extend/apps/data/validation-rules"
              ]
            },
            {
              "key": "appsLogic",
              "label": "Logic",
              "root": "developers/extend/apps/logic/overview",
              "pages": [
                "developers/extend/apps/logic/logic-functions",
                "developers/extend/apps/logic/key-value-store",
                "developers/extend/apps/logic/background-jobs",
                "developers/extend/apps/logic/skills-and-agents",
                "developers/extend/apps/logic/workflows",
                "developers/extend/apps/logic/connections",
                "developers/extend/apps/logic/messaging-channels",
                "developers/extend/apps/logic/inbox",
                "developers/extend/apps/logic/credits"
              ]
            },
            {
              "key": "appsLayout",
              "label": "Layout",
              "root": "developers/extend/apps/layout/overview",
              "pages": [
                "developers/extend/apps/layout/views",
                "developers/extend/apps/layout/navigation-menu-items",
                "developers/extend/apps/layout/page-layouts",
                "developers/extend/apps/layout/front-components",
                "developers/extend/apps/layout/command-menu-items"
              ]
            },
            {
              "key": "appsOperations",
              "label": "Operations",
              "root": "developers/extend/apps/operations/overview",
              "pages": [
                "developers/extend/apps/operations/cli",
                "developers/extend/apps/operations/sync-and-recovery",
                "developers/extend/apps/operations/testing",
                "developers/extend/apps/operations/translations",
                "developers/extend/apps/operations/publishing",
                "developers/extend/apps/operations/marketplace-review",
                "developers/extend/apps/operations/monitoring"
              ]
            }
          ]
        },
        {
          "key": "api",
          "label": "API",
          "pages": [
            "developers/extend/api",
            "developers/extend/webhooks",
            "developers/extend/oauth"
          ]
        },
        {
          "key": "selfHost",
          "label": "Self-Host",
          "pages": [
            "developers/self-host/capabilities/docker-compose",
            "developers/self-host/capabilities/setup",
            "developers/self-host/capabilities/security",
            "developers/self-host/capabilities/upgrade-guide",
            "developers/self-host/capabilities/troubleshooting"
          ]
        },
        {
          "key": "contribute",
          "label": "Contribute",
          "pages": [
            "developers/contribute/capabilities/local-setup",
            "developers/contribute/commands",
            "developers/contribute/style-guide"
          ]
        },
        {
          "key": "uiLibrary",
          "label": "UI Library",
          "pages": [
            {
              "key": "uiGuides",
              "label": "Guides",
              "pages": [
                "ui/getting-started",
                "ui/theming",
                "ui/tokens",
                "ui/dark-mode",
                "ui/ssr",
                "ui/accessibility",
                "ui/icons",
                "ui/testing"
              ]
            },
            {
              "key": "uiPrimitives",
              "label": "Primitives",
              "root": "ui/primitives/overview",
              "pages": [
                {
                  "key": "uiAccessibility",
                  "label": "Accessibility",
                  "pages": ["ui/primitives/accessibility/visually-hidden"]
                },
                {
                  "key": "uiDataDisplay",
                  "label": "Data display",
                  "pages": [
                    "ui/primitives/data-display/avatar",
                    "ui/primitives/data-display/chip",
                    "ui/primitives/data-display/tag",
                    "ui/primitives/data-display/status",
                    "ui/primitives/data-display/color-sample",
                    "ui/primitives/data-display/badge"
                  ]
                },
                {
                  "key": "uiFeedback",
                  "label": "Feedback",
                  "pages": [
                    "ui/primitives/feedback/banner",
                    "ui/primitives/feedback/loader",
                    "ui/primitives/feedback/progress",
                    "ui/primitives/feedback/progress-bar",
                    "ui/primitives/feedback/progress-ring",
                    "ui/primitives/feedback/skeleton"
                  ]
                },
                {
                  "key": "uiForms",
                  "label": "Forms",
                  "pages": [
                    "ui/primitives/input/button",
                    "ui/primitives/input/button-group",
                    "ui/primitives/input/field",
                    "ui/primitives/input/input",
                    "ui/primitives/input/input-group",
                    "ui/primitives/input/number-field",
                    "ui/primitives/input/textarea",
                    "ui/primitives/input/checkbox",
                    "ui/primitives/input/radio",
                    "ui/primitives/input/radio-group",
                    "ui/primitives/input/select",
                    "ui/primitives/input/slider",
                    "ui/primitives/input/switch"
                  ]
                },
                {
                  "key": "uiLayout",
                  "label": "Layout",
                  "pages": [
                    "ui/primitives/layout/collapsible",
                    "ui/primitives/layout/separator",
                    "ui/primitives/layout/resize-handle",
                    "ui/primitives/layout/direction-provider"
                  ]
                },
                {
                  "key": "uiNavigation",
                  "label": "Navigation",
                  "pages": [
                    "ui/primitives/navigation/breadcrumb",
                    "ui/primitives/navigation/list-item",
                    "ui/primitives/navigation/tabs"
                  ]
                },
                {
                  "key": "uiSurfaces",
                  "label": "Surfaces",
                  "pages": [
                    "ui/primitives/surfaces/alert-dialog",
                    "ui/primitives/surfaces/card",
                    "ui/primitives/surfaces/dialog",
                    "ui/primitives/surfaces/popover",
                    "ui/primitives/surfaces/tooltip"
                  ]
                },
                {
                  "key": "uiTypography",
                  "label": "Typography",
                  "pages": [
                    "ui/primitives/typography/heading",
                    "ui/primitives/typography/text",
                    "ui/primitives/typography/shortcut",
                    "ui/primitives/typography/overflowing-text-with-tooltip"
                  ]
                }
              ]
            },
            {
              "key": "uiComponents",
              "label": "Components",
              "root": "ui/components/overview",
              "pages": [
                {
                  "key": "uiComponentsDataDisplay",
                  "label": "Data display",
                  "pages": [
                    "ui/components/data-display/avatar-group",
                    "ui/components/data-display/command-block",
                    "ui/components/data-display/details-row",
                    "ui/components/data-display/json-tree",
                    "ui/components/data-display/metric-row",
                    "ui/components/data-display/stack-icon",
                    "ui/components/data-display/tinted-icon-tile"
                  ]
                },
                {
                  "key": "uiComponentsFeedback",
                  "label": "Feedback",
                  "pages": [
                    "ui/components/feedback/callout",
                    "ui/components/feedback/inline-banner",
                    "ui/components/feedback/toast"
                  ]
                },
                {
                  "key": "uiComponentsInput",
                  "label": "Input",
                  "pages": [
                    "ui/components/input/main-button",
                    "ui/components/input/light-button",
                    "ui/components/input/icon-button",
                    "ui/components/input/light-icon-button",
                    "ui/components/input/reaction-button",
                    "ui/components/input/country-select",
                    "ui/components/input/currency-picker",
                    "ui/components/input/phone-country-picker",
                    "ui/components/input/form-field-row",
                    "ui/components/input/image-input",
                    "ui/components/input/search-input",
                    "ui/components/input/number-stepper",
                    "ui/components/input/segmented-control"
                  ]
                },
                {
                  "key": "uiComponentsLayout",
                  "label": "Layout",
                  "pages": [
                    "ui/components/layout/section",
                    "ui/components/layout/overflowing-list",
                    "ui/components/layout/animated-icon-crossfade"
                  ]
                },
                {
                  "key": "uiComponentsNavigation",
                  "label": "Navigation",
                  "pages": [
                    "ui/components/navigation/list-item-button",
                    "ui/components/navigation/dropdown",
                    "ui/components/navigation/tab-button"
                  ]
                },
                {
                  "key": "uiComponentsSettings",
                  "label": "Settings",
                  "pages": ["ui/components/settings/settings-row"]
                },
                {
                  "key": "uiComponentsCodeEditor",
                  "label": "Code editor",
                  "pages": ["ui/components/code-editor/code-editor"]
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}