snapshot of https://github.com/twentyhq/twenty.git (main, 2026-09-17; blobs > 131072B omitted)

packages/twenty-docs/getting-started/core-concepts/ai.mdx

@@ -0,0 +1,34 @@
+---
+title: AI
+description: How Twenty uses AI to enhance your CRM experience.
+icon: "robot"
+---
+
+import { VimeoEmbed } from '/snippets/vimeo-embed.mdx';
+
+Twenty integrates AI directly into your CRM — not as a gimmick, but as a tool that works within your data model and permission system.
+
+## AI Chatbot
+
+Ask questions about your data in natural language. The AI chatbot can query your CRM records, summarize information, and help you find what you're looking for without building complex filters.
+
+<VimeoEmbed videoId="1185511734" title="AI chatbot" />
+
+## AI Agents
+
+AI agents go beyond chat — they can execute multi-step tasks autonomously:
+
+- Enrich records with data from external sources
+- Draft and send follow-up emails
+- Analyze pipeline health and flag at-risk deals
+- Process incoming data and route it to the right team
+
+Agents work within your existing workflows, so you can combine AI with manual approvals, conditional logic, and external API calls.
+
+## Permissions & safety
+
+AI in Twenty respects your permission model. Agents can only access objects and fields that the user (or role) has permission to view. Sensitive data stays protected even when AI is involved.
+
+<Card title="Full AI guide" icon="arrow-right" href="/user-guide/ai/overview">
+  Detailed reference on the chatbot, agents, and permission controls.
+</Card>

packages/twenty-docs/getting-started/core-concepts/apps.mdx

@@ -0,0 +1,42 @@
+---
+title: Apps
+icon: "cube"
+description: Extend Twenty with code — custom objects, server-side logic, UI components, and AI agents, all as TypeScript packages.
+---
+
+
+Most CRMs give you a config panel. Twenty gives you a platform. Apps are how developers extend Twenty beyond what the UI offers — defining data models, server-side logic, UI components, and AI capabilities as code, then deploying them to one or more workspaces.
+
+## Why apps exist
+
+Workflows cover no-code automation. But some things need code: a custom pricing engine, a proprietary enrichment pipeline, a compliance check that runs on every record update, a custom UI panel that pulls data from an internal tool.
+
+Apps let you build these as first-class extensions — not brittle scripts talking to an API from outside, but code that runs on the platform with full access to the type system, permission model, and UI.
+
+## What an app can define
+
+An app is a TypeScript package that declares **entities** using the `twenty-sdk`:
+
+| Entity | What it does |
+|--------|-------------|
+| **Objects & Fields** | New data tables and fields on existing objects — same treatment as built-in ones |
+| **Logic Functions** | Server-side TypeScript triggered by HTTP routes, cron schedules, or database events |
+| **Front Components** | Sandboxed React components that render inside Twenty's UI (side panel, widgets, command menu) |
+| **Skills & Agents** | AI capabilities — reusable instructions and autonomous assistants |
+| **Views & Navigation** | Pre-configured list views and sidebar menu items |
+
+Everything is detected via AST analysis at build time — no config files, no registration boilerplate. Put a `export default defineObject(...)` in any `.ts` file and the SDK picks it up.
+
+## How they run
+
+- **Logic functions** execute in isolated Node.js processes, sandboxed from the host. They access data through a typed API client scoped to the app's role permissions.
+- **Front components** run in Web Workers using Remote DOM — sandboxed from the main page but rendering native DOM elements (not iframes).
+- **Permissions** are enforced at the API level. An app only sees what its role allows.
+
+## The developer experience
+
+You write your app as a TypeScript project on your machine. The CLI watches your source files and live-syncs them to a running Twenty server — edit a file, see the change in the UI within a second. The typed API client regenerates automatically when the schema changes. When you're ready, `yarn twenty app:publish --private` pushes to a production server, or `yarn twenty app:publish` lists your app on npm and the Twenty marketplace.
+
+<Card title="Build your first app" icon="arrow-right" href="/developers/extend/apps/getting-started/quick-start">
+  Three-phase walkthrough — scaffold, run a local server, sync your changes.
+</Card>

packages/twenty-docs/getting-started/core-concepts/calendar-and-email.mdx

@@ -0,0 +1,46 @@
+---
+title: Calendar & Email
+description: Sync your email and calendar with Twenty.
+icon: "envelope"
+---
+
+Twenty connects to your existing tools so your CRM stays up to date without manual data entry.
+
+## Email sync
+
+Connect your **Google Workspace** or **Microsoft 365** mailbox. Once connected:
+
+- Emails are automatically linked to the matching Company and People records
+- Full email threads are visible on each record's timeline
+- You can send emails directly from Twenty
+- Multiple mailboxes per user are supported
+
+You control what gets imported — filter by date range or sender to avoid pulling in irrelevant emails.
+
+## Calendar sync
+
+Calendar events sync automatically from your connected account. Events appear on the relevant CRM records, giving you a complete picture of your interactions with each contact or company.
+
+## Integrations
+
+Beyond email and calendar, Twenty connects to external tools through:
+
+| Method | Use case |
+|--------|----------|
+| **API** | Build custom integrations with the GraphQL or REST API |
+| **Webhooks** | Push real-time notifications to external systems when records change |
+| **Zapier** | Connect to 5,000+ apps without code |
+| **Workflow HTTP actions** | Call any external API as part of an automated workflow |
+
+## Custom apps
+
+Developers can build full-featured apps on top of Twenty — adding custom UI, server-side logic, and deep integrations. Apps can be published for the community or kept private.
+
+<CardGroup cols={2}>
+  <Card title="Calendar & Email guide" icon="envelope" href="/user-guide/calendar-emails/overview">
+    Set up email sync, calendar sync, and troubleshoot issues.
+  </Card>
+  <Card title="API & Extensions" icon="plug" href="/developers/extend/api">
+    Build custom integrations with the Twenty API.
+  </Card>
+</CardGroup>

packages/twenty-docs/getting-started/core-concepts/dashboards.mdx

@@ -0,0 +1,36 @@
+---
+title: Dashboards
+description: Track performance and visualize your CRM data with custom dashboards.
+icon: "chart-bar"
+---
+
+import { VimeoEmbed } from '/snippets/vimeo-embed.mdx';
+
+Dashboards give you real-time visibility into your business metrics — pipeline health, team performance, revenue trends, and anything else you want to track.
+<VimeoEmbed videoId="1185511768" title="Dashboard" />
+
+## Widgets
+
+Each dashboard is made up of widgets. A widget is a single chart or metric tied to your CRM data. You can configure:
+
+- **Chart type** — Bar, line, pie, number, and more
+- **Data source** — Any object in your data model (standard or custom)
+- **Filters** — Narrow down to specific records, date ranges, or segments
+- **Aggregation** — Count, sum, average, min, max on any numeric field
+- **Grouping** — Break down by select fields, dates, or relations
+
+## What you can track
+
+- Pipeline value by stage
+- Deals closed over time
+- Average deal size by source
+- Task completion rates
+- Custom metrics on any object
+
+## Sharing
+
+Dashboards are workspace-level — everyone on your team can see them. Arrange widgets in a grid layout and resize them to build the view that works for your team.
+
+<Card title="Full Dashboards guide" icon="arrow-right" href="/user-guide/dashboards/overview">
+  Detailed reference on creating dashboards, configuring widgets, and chart settings.
+</Card>

packages/twenty-docs/getting-started/core-concepts/data-model.mdx

@@ -0,0 +1,47 @@
+---
+title: Data Model
+description: Understand how Twenty structures your data with objects, fields, and relations.
+icon: "database"
+---
+
+import { VimeoEmbed } from '/snippets/vimeo-embed.mdx';
+
+Everything in Twenty is built around **objects** and **fields** — the building blocks of your data model.
+
+## Objects
+
+Objects are the tables that hold your data. Twenty comes with standard objects out of the box:
+
+- **Companies** — Organizations you do business with
+- **People** — Individual contacts
+- **Opportunities** — Deals in your pipeline
+- **Tasks** — Action items for your team
+- **Notes** — Free-form text linked to records
+
+You can also create **custom objects** for anything your business needs — projects, support tickets, products, contracts, or anything else.
+
+## Fields
+
+Fields are the properties on each object. Twenty supports a wide range of field types:
+
+| Category | Types |
+|----------|-------|
+| **Basic** | Text, Number, Boolean, Date, Currency, Rating, Select |
+| **Composite** | Address (street, city, state, zip), Full Name, Links, Phones, Emails |
+| **Special** | Relation, File Attachment, JSON, Actor (who created/modified) |
+
+Every object also gets automatic system fields: `id`, `createdAt`, `updatedAt`, `createdBy`, and `position`.
+
+## Relations
+
+Objects connect to each other through relations. A Company has many People, an Opportunity belongs to a Company, and so on. You can create custom relations between any objects, including many-to-many relationships.
+
+## What makes this powerful
+
+Unlike traditional CRMs where you're limited to pre-defined fields on pre-defined objects, Twenty lets you model your data exactly the way your business works. Custom objects get the same first-class treatment as built-in ones — including API endpoints, views, permissions, and workflow triggers.
+
+<Card title="Deep dive into the Data Model" icon="arrow-right" href="/user-guide/data-model/overview">
+  Full reference on objects, fields, relations, and how to configure them.
+</Card>
+
+<VimeoEmbed videoId="1185511827" title="Data model" />

packages/twenty-docs/getting-started/core-concepts/glossary.mdx

@@ -0,0 +1,81 @@
+---
+title: Glossary
+icon: "book"
+description: Key terms used throughout Twenty.
+---
+
+## API
+API (Application Programming Interface) allows you to connect Twenty with other software systems and build custom integrations.
+
+## Apps
+Apps are custom extensions built as code that can define data models and logic functions. They enable developers to create reusable customizations that can be deployed across multiple workspaces.
+
+## Code Actions
+Code Actions are workflow steps that let you write custom JavaScript to transform data, make calculations, or perform complex logic that isn't possible with built-in actions.
+
+## Command Menu
+The Command Menu is a quick-access interface (opened with `Cmd + K` on Mac and `Ctrl + K` on Windows) that lets you perform actions, create records, and navigate your workspace efficiently.
+
+## Company & People
+The CRM has two fundamental types of records:
+- A `Company` represents a business or organization.
+- `People` represent your company's current and prospective customers or clients.
+
+## Custom Fields
+Custom Fields are data fields you create to capture information specific to your business needs and processes.
+
+## Data Model
+A Data Model is the structure that defines how information is organized in your CRM, including what objects exist, their properties (fields), and how they relate to each other.
+
+## Favorites
+Favorites are records you've marked for quick access, appearing in your sidebar for instant navigation to important data.
+
+## Field
+A field refers to a specific area where particular data is stored for an entity.
+
+## Iterator
+An Iterator is a workflow action that loops through an array of items, executing subsequent actions for each item in the list.
+
+## Kanban
+A `Kanban` is a visual way to track your business processes using cards and columns. Each column represents a stage in your process (for example: new, ongoing, won, lost), and you move records through these stages as they progress.
+
+## Object
+An Object is a data structure that represents a specific type of entity in your CRM (like People, Companies, or Opportunities). Objects can be standard (built-in) or custom (created by you).
+
+## Opportunities
+Opportunities in Twenty CRM are potential deals or sales with accounts or contacts.
+
+## Record
+A Record indicates an instance of an object, like a specific account or contact.
+
+## Relation Fields
+Relation Fields create connections between different objects, allowing you to link records together (like connecting a Person to a Company).
+
+## Standard Fields
+Standard Fields are pre-built data fields that come with objects by default and provide common functionality across all workspaces.
+
+## Tasks
+Tasks in Twenty CRM are assigned activities relating to contacts, accounts, or opportunities.
+
+## Triggers
+Triggers are the starting point of a workflow — the event or condition that initiates the automation. Examples include record creation, record updates, webhooks, or scheduled times.
+
+## Views
+You can customize the display of your records using views, setting different filters, layouts and sorting options for each view.
+
+## Upsert
+Upsert is an operation that combines "update" and "insert" — it updates an existing record if a match is found, or creates a new record if no match exists.
+
+## Webhooks
+Webhooks are automated messages sent from Twenty to other applications when specific events occur, enabling real-time data synchronization.
+
+## Workflows
+Workflows are automated processes that trigger actions based on specific conditions, helping you automate repetitive tasks and business processes.
+
+## Workspace
+A `Workspace` typically represents a company using Twenty. It holds all the records and data that you and your team members add to Twenty.
+It has a single domain name, which is typically the domain name your company uses for employee email addresses.
+
+## Workspace Members
+Workspace Members are the Twenty users from your team who have access to your workspace. They can be assigned as owners or assignees for records.
+

packages/twenty-docs/getting-started/core-concepts/layout.mdx

@@ -0,0 +1,76 @@
+---
+title: Layout
+description: How to navigate, browse, and view records in Twenty.
+icon: "table-columns"
+---
+
+import { VimeoEmbed } from '/snippets/vimeo-embed.mdx';
+
+## The main layout
+
+The center of the screen is where your records live — people, companies, opportunities, tasks, notes, dashboards, workflows, and any custom objects. You view, edit, and delete records here, and create new views.
+
+<img src="/images/user-guide/home/main-layout.png" style={{width:'100%'}}/>
+
+<span id="navigation-bar" />
+
+## Sidebar
+
+The left sidebar gives you:
+- **Workspace switcher** — switch between workspaces or create a new one (top dropdown)
+- **Search** — press `/` to focus instantly, searches across all objects
+- **Settings** — access from the top left
+- **Favorites** — pinned views, unique per user
+- **Object shortcuts** — quick access to People, Companies, Opportunities, etc.
+- **Workflows** — create automations
+
+Drag items to reorder, create folders to group related objects, hide what you don't use.
+
+Use the collapse button at the top of the sidebar, or choose **Collapse sidebar** from the command menu (`Cmd+K` on Mac or `Ctrl+K` on Windows). When collapsed, use **Expand sidebar** to show it again.
+
+<img src="/images/user-guide/home/navigation-bar.png" style={{width:'100%'}}/>
+
+## Command menu
+
+Press `Cmd+K` (Mac) or `Ctrl+K` (Windows) — or click the three dots in the top right. From here you can:
+- Create new records
+- Import and export data via CSV
+- Create new views
+- Access deleted records (Twenty supports soft and hard deletes)
+- See keyboard shortcuts for navigating your workspace
+
+<img src="/images/user-guide/home/command-menu.png" style={{width:'100%'}}/>
+
+## Search
+
+Accessible via the Command Menu, the top of the sidebar, or by pressing `/`. Search works across all objects.
+
+<img src="/images/user-guide/home/search-bar.png" style={{width:'100%'}}/>
+
+## Side panel
+
+Click a record to open the side panel on the right — a quick overview of the record's key information without leaving the current page. Click **Open** to go to the full record page.
+
+<img src="/images/user-guide/home/side-panel.png" style={{width:'100%'}}/>
+
+## Views
+
+Every object supports multiple views — unlimited per object. Use the dropdown at the top left to switch between them.
+
+- **Table** — spreadsheet-style rows and columns, with grouping, inline editing, and column customization
+- **Kanban** — drag-and-drop cards organized by a select field, ideal for pipelines
+- **Calendar** — records plotted by a date field for time-based planning
+
+Each view saves its own filters, sorting, and field visibility. Share views with your workspace or keep them private. Favorite views for fast access from the sidebar.
+
+<img src="/images/user-guide/home/view-menu.png" style={{width:'100%'}}/>
+
+## Record pages
+
+When you open a record, the detail page is built from configurable **tabs** and **widgets**. Add, remove, reorder, and resize widgets on a grid — fields, related records, emails, timeline, tasks, notes, files, charts, iframes, and more. Each object type has its own layout.
+
+<Card title="Full Layout guide" icon="arrow-right" href="/user-guide/layout/overview">
+  Sidebar, views, record pages — detailed reference and how-tos.
+</Card>
+
+<VimeoEmbed videoId="1185511790" title="Layout" />

packages/twenty-docs/getting-started/core-concepts/workflows.mdx

@@ -0,0 +1,56 @@
+---
+title: Workflows
+description: Automate your business processes with Twenty's visual workflow builder.
+icon: "bolt"
+---
+
+import { VimeoEmbed } from '/snippets/vimeo-embed.mdx';
+
+Workflows let you automate repetitive tasks and connect Twenty to external tools — without writing code (though you can if you want to).
+
+<VimeoEmbed videoId="1185511711" title="Workflow" />
+
+
+## How workflows work
+
+Every workflow has three parts:
+
+1. **Trigger** — What starts the workflow
+2. **Steps** — What happens next (one or more actions in sequence)
+3. **Variables** — Data that flows between steps
+
+## Triggers
+
+| Trigger | When it fires |
+|---------|--------------|
+| **Record event** | A record is created, updated, deleted, or upserted |
+| **Manual** | A user clicks a button (on a single record, multiple records, or globally) |
+| **Schedule** | On a recurring interval (cron syntax) |
+| **Webhook** | An external system sends an HTTP POST |
+
+## Actions
+
+Workflows can chain any combination of:
+
+- **Record operations** — Create, update, find, delete, or upsert records
+- **Send email** — Send or draft emails from connected accounts
+- **HTTP request** — Call any external API
+- **Code** — Run custom JavaScript for complex logic
+- **Branches** — If/else conditions to split the workflow path
+- **Iterator** — Loop over arrays of data
+- **AI Agent** — Let an AI agent process data autonomously
+- **Delay** — Wait before continuing
+- **Form** — Collect user input mid-workflow
+
+## What you can build
+
+- Send Slack alerts when a deal reaches a certain stage
+- Auto-enrich new contacts with data from external APIs
+- Detect stale opportunities and notify the owner
+- Sync data between Twenty and your billing system
+- Generate PDFs or invoices from record data
+- Auto-reply to inbound emails matching certain criteria
+
+<Card title="Full Workflows guide" icon="arrow-right" href="/user-guide/workflows/overview">
+  Detailed reference on triggers, actions, variables, and real-world automation recipes.
+</Card>