Documentation update (#23091)

<!-- This is an auto-generated description by cubic. -->
<a
href="https://cubic.dev/pr/twentyhq/twenty/pull/23091?utm_source=github"
target="_blank" rel="noopener noreferrer"
data-no-image-dialog="true"><picture><source
media="(prefers-color-scheme: dark)"
srcset="https://www.cubic.dev/buttons/review-in-cubic-dark.svg"><source
media="(prefers-color-scheme: light)"
srcset="https://www.cubic.dev/buttons/review-in-cubic-light.svg"><img
alt="Review in cubic"
src="https://www.cubic.dev/buttons/review-in-cubic-dark.svg"></picture></a>
<!-- End of auto-generated description by cubic. -->
This commit is contained in:
BOHEUS
2026-07-21 17:39:39 +02:00
committed by GitHub
parent 23cf85f745
commit 00e5917d4d
20 changed files with 132 additions and 89 deletions
Binary file not shown.

After

Width:  |  Height:  |  Size: 214 KiB

+1 -1
View File
@@ -197,7 +197,7 @@ export const ChartIcon = ({ icon, size = 20 }) => {
</svg>
),
};
// TODO: add table icon
const selectedIcon = icons[icon];
if (!selectedIcon) {
@@ -3,10 +3,6 @@ title: AI Agents
description: Integrate AI capabilities directly into your automation workflows.
---
<Note>
This feature is in development and will be available in beta soon.
</Note>
## Overview
Integrate AI capabilities directly into your automation workflows for intelligent data processing and decision-making.
@@ -3,10 +3,6 @@ title: AI Chatbot
description: An intelligent assistant that helps you interact with your CRM data using natural language.
---
<Note>
This feature is in development and will be available in beta soon.
</Note>
## Overview
An intelligent assistant that helps you interact with your CRM data using natural language.
@@ -3,10 +3,6 @@ title: MCP Server
description: Connect AI assistants to your Twenty workspace using the Model Context Protocol.
---
<Warning>
MCP is currently in **alpha** and is only available on some workspaces. It may not be enabled for your workspace yet.
</Warning>
Twenty exposes an [MCP](https://modelcontextprotocol.io/) server so that AI assistants — Claude Desktop, Claude Code, Cursor, ChatGPT, and others — can read and write your CRM data through natural language.
Use your **workspace URL** (the URL you use to access Twenty) as the MCP endpoint. On Twenty Cloud, your workspace URL might be `https://{mycompany}.twenty.com` or a custom domain. The server is available at:
@@ -72,20 +68,20 @@ If your MCP client does not support OAuth, or you prefer static credentials, pas
Your API key grants access to workspace data. Keep it out of version control and shared dotfiles.
</Warning>
To create an API key, go to **Settings > APIs & Webhooks > + Create key**. See [APIs](/developers/extend/api#create-an-api-key) for details.
To create an API key, go to **Settings → MCP & APIs → API → + Create key**. See [APIs](/developers/extend/api#create-an-api-key) for details.
## Quick Start
### 1. Copy the config
Go to **Settings > AI > More > MCP Server** in Twenty. Choose your authentication method (OAuth or API Key), copy the JSON snippet (it will already use your workspace URL), and paste it into your MCP client's config file.
Go to **Settings → MCP & APIs → MCP** in Twenty. Choose your authentication method (OAuth or API Key), copy the JSON snippet (it will already use your workspace URL), and paste it into your MCP client's config file.
| Client | Config file location |
|--------|---------------------|
| **Claude Desktop** | `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS) or `%APPDATA%\Claude\claude_desktop_config.json` (Windows) |
| **Claude Code** | `~/.claude.json` (user) or `.mcp.json` (project) |
| **Cursor** | `.cursor/mcp.json` in your project, or `~/.cursor/mcp.json` globally |
| **ChatGPT** | Turn on Developer Mode in **Settings > Apps & Connectors > Advanced settings**, then use **Create** in **Settings > Apps & Connectors** to add the MCP server |
| **ChatGPT** | Turn on Developer Mode in **Settings Apps & Connectors Advanced settings**, then use **Create** in **Settings Apps & Connectors** to add the MCP server |
### 2. Connect
@@ -113,7 +109,7 @@ You don't need to remember tool names. Ask your AI assistant what it can do and
MCP connections inherit the permissions of the authenticated user (OAuth) or the role assigned to the API key. To restrict what the MCP server can do:
- **OAuth**: The user's workspace role applies.
- **API Key**: Assign a role to the API key under **Settings > Roles**. See [Permissions](/user-guide/permissions-access/capabilities/permissions).
- **API Key**: Assign a role to the API key under **Settings → Members → Roles**. See [Permissions](/user-guide/permissions-access/capabilities/permissions).
## Self-Hosted Configuration
@@ -5,27 +5,27 @@ description: Frequently asked questions about AI features in Twenty.
<AccordionGroup>
<Accordion title="When will AI features be available?">
AI features are currently in development and will be released in beta soon. Stay tuned for updates!
</Accordion>
<Accordion title="What AI capabilities are planned?">
We're building two main AI capabilities:
<Accordion title="What AI capabilities are available?">
Two main capabilities of AI are:
1. **AI Chatbot**: A context-aware assistant that can access your Twenty data and help you with queries
2. **AI Agents in Workflows**: Intelligent automation that can process data, make decisions, and execute tasks within your workflows
</Accordion>
<Accordion title="Will AI agents have access to all my data?">
<Accordion title="Do AI agents have access to all my data?">
AI agents will operate under the permission system. You can assign specific roles to AI agents under **Settings → Members → Roles**, giving you full control over what data they can access and what actions they can perform.
</Accordion>
<Accordion title="How will AI credits work?">
AI actions will consume workflow credits based on the complexity of the task and the AI model used. More details will be available when the features launch.
<Accordion title="How do AI credits work?">
AI actions consume workflow credits based on the complexity of the task and the AI model used.
</Accordion>
<Accordion title="Can I use my own AI models?">
Initially, Twenty will use built-in AI models. Support for custom or external AI models may be added in future releases based on user feedback.
On cloud, you can use only AI models provided by Twenty. On your self-hosted instance, you can use your own AI models after obtaining an Organization license.
</Accordion>
<Accordion title="I don't see a role I assigned to AI agent, where is it?">
By default, the Roles list is filtered to roles assignable to workspace members. If a role is assignable only to AI agents, you need to change filter to include AI-agent roles.
</Accordion>
</AccordionGroup>
@@ -1,15 +1,15 @@
---
title: AI
description: AI-powered features coming soon to Twenty.
description: AI-powered features in Twenty.
---
<Frame>
<img src="/images/user-guide/workflows/robot.png" alt="AI" />
</Frame>
## What's Coming
## Features
Twenty is building AI capabilities to help your team work smarter. We're focusing on two major areas:
Currently, Twenty offers:
### 1. AI Chatbot
@@ -42,7 +42,7 @@ Extend your workflows with AI-powered actions and autonomous agents.
## Permissions and Access Control
AI agents will be managed through the existing permissions system:
AI agents are managed through the existing permissions system:
1. Go to **Settings → Members → Roles**
2. Configure which data each AI agent can access
@@ -50,9 +50,5 @@ AI agents will be managed through the existing permissions system:
This ensures AI agents respect your data governance policies and only access what they need.
## Stay Updated
We'll update this section as AI features become available. In the meantime:
- Follow our [GitHub](https://github.com/twentyhq/twenty) for development updates
- Join our [Discord](https://discord.gg/UfGNZJfAG6) to share feedback and feature requests
@@ -20,6 +20,7 @@ Cost scales with the work. Everyday automation and quick AI messages cost a tiny
| Send a quick AI chat message or simple AI step | A fraction of a cent | Hundreds per credit |
| Run a large AI agent task (e.g. "configure 10 workspace objects") | Can run to **~$1 or more** | A few per credit |
| Run an AI web search | A fixed per-search cost | Hundreds of searches per credit |
| Trigger app's logic function | A small fraction of a credit | Thousands per credit |
<Note>
For most teams, standard automations are effectively free — you'll only make a noticeable dent in your balance when you lean on AI features or run heavy code nodes. That's by design: the included credits are meant to let you build without watching a meter.
@@ -64,7 +65,7 @@ Reviewing this regularly makes it easy to spot a heavy workflow early and decide
If you run out — or want a buffer before a big automation push — you can buy additional credit packs at any time:
1. Go to **Settings → Billing**
2. Choose to **purchase additional credits**
3. Select the amount you need
2. Click **Increase** button
3. Select the amount you need and accept changes
Purchased credits are added to your available balance immediately.
@@ -17,13 +17,13 @@ For teams ready to scale:
- Standard support
<Note>
Premium features (SSO, row-level permissions and AI usage data) are not included in the Pro plan.
Premium features (SSO, row-level permissions, AI usage data and more) are not included in the Pro plan.
</Note>
### Organization (Cloud)
For larger teams with advanced needs:
- Everything in Pro
- **Premium features**: SSO integration, row-level permissions and AI usage data
- **Premium features**: SSO integration, row-level permissions, AI usage data and more
- Priority support
## Self-Hosted Plans
@@ -37,7 +37,7 @@ Host Twenty on your own infrastructure at no cost:
### Organization (Self-Hosted)
For teams who need premium features while self-hosting:
- All Pro features
- **Premium features**: SSO integration, row-level permissions and AI usage data
- **Premium features**: SSO integration, row-level permissions, AI usage data and more
- Twenty team support
- No requirement to publish custom code as open-source before distributing
@@ -47,24 +47,32 @@ Premium features are only available on the Organization plans (Cloud or Self-Hos
- **SSO integration**: Single Sign-On with your identity provider
- **Row-level permissions**: Fine-grained access control at the record level
- **AI usage data**: Track AI consumption across the workspace
- **Audit logs**: Check what each workspace member has been doing
- **Email campaigns**: Plan which emails should be sent (available soon)
- **Unlimited workspaces**: Create as many workspaces as you want (self-hosted only)
- **Private source code**: No requirement to publish changes to publicly available repository (self-hosted only)
## Switching Plans
### Upgrade to Organization
1. Go to **Settings → Billing**
1. Go to **Settings → Billing → Plans**
2. Click **Switch to Organization**
3. Confirm your upgrade
### Downgrade to Pro
Contact support to downgrade your plan.
1. Go to **Settings → Billing → Plans**
2. Click **Switch to Pro**
3. Confirm your downgrade
### Switch to Yearly Billing
1. Go to **Settings → Billing**
2. Click **Switch to Yearly**
2. Click **Upgrade to Yearly**
3. Save with annual billing
### Switch to Monthly Billing
Contact support to switch back to monthly billing.
1. Go to **Settings → Billing**
2. Click **Downgrade to Monthly**
3. Save with monthly billing
## Obtain an Enterprise Key for Organization (Self-Hosted)
@@ -9,7 +9,7 @@ description: Frequently asked questions about Twenty pricing and billing.
<Accordion title="Can I use Twenty for free while self-hosting?">
Yes, you can use Twenty for free while self-hosting. You will get access to everything included in the Pro (Cloud) plan, except the support from our core-team. Support is accessible via our Discord community.
If you want to self-host and need the Premium features (SSO and row-level permissions), you can choose the paid Organization (Self-Hosted) license. This also includes support from the Twenty team and removes the requirement to publish custom code as open-source before distributing.
If you want to self-host and need the Premium features (SSO, row-level permissions and more), you can choose the paid Organization (Self-Hosted) license. This also includes support from the Twenty team and removes the requirement to publish custom code as open-source before distributing.
</Accordion>
<Accordion title="What are the Premium features?">
@@ -17,6 +17,10 @@ Premium features are only available on the Organization plans (Cloud or Self-Hos
- **SSO integration**: Single Sign-On with your identity provider
- **Row-level permissions**: Fine-grained access control at the record level
- **AI usage data**: Track AI consumption across the workspace
- **Audit logs**: Check what each workspace member has been doing
- **Email campaigns**: Plan which emails should be sent (available soon)
- **Unlimited workspaces**: Create as many workspaces as you want (self-hosted only)
- **Private source code**: No requirement to publish changes to publicly available repository (self-hosted only)
</Accordion>
<Accordion title="Is Organization plan on cloud and Organization plan on self-hosted the same?">
@@ -28,19 +32,19 @@ We do not offer free seats. Pricing is per user and each user needs a licence to
</Accordion>
<Accordion title="Where can I switch my subscription to the Organization plan?">
You can do so under `Settings → Billing`. Then click on `Switch to Organization`.
You can do so under `Settings → Billing → Plans`. Then click on `Switch to Organization`.
</Accordion>
<Accordion title="Where can I switch my subscription to the Pro plan?">
Please reach out to our team directly via the Support, there is no easy way to do this using the UI at the moment.
You can do so under `Settings → Billing → Plans`. Then click on `Switch to Pro`.
</Accordion>
<Accordion title="Where can I switch my subscription to Yearly?">
You can do so under `Settings → Billing`. Then click on `Switch to Yearly`.
<Accordion title="Where can I switch my subscription to yearly?">
You can do so under `Settings → Billing`. Then click on `Upgrade to yearly`.
</Accordion>
<Accordion title="Where can I switch my subscription to Monthly?">
Please reach out to our team directly via the Support, there is no easy way to do this using the UI at the moment.
<Accordion title="Where can I switch my subscription to monthly?">
You can do so under `Settings → Billing`. Then click on `Downgrade to monthly`.
</Accordion>
<Accordion title="Where can I see my credit usage?">
@@ -57,14 +61,19 @@ The number of credits depends on your billing cycle, not your plan:
Each workflow action consumes credits based on its complexity:
- **Basic internal operations** (such as search, update, create records) consume very few credits
- **More complex operations** like code nodes and requests to external services consume more credits
- **AI prompts** (coming soon!) will also consume more credits based on usage
- **AI prompts** also consume more credits based on usage
- **Apps** also consume more credits similarly to Code node
Credits are deducted in real-time when workflows execute. You can monitor your usage in **Settings → Billing** to track consumption and remaining credits.
Credits are deducted in real-time when workflows or apps execute. You can monitor your usage in **Settings → Billing** to track consumption and remaining credits.
</Accordion>
<Accordion title="Can I buy more workflow credits?">
You can buy additional credits under `Settings → Billing`.
</Accordion>
<Accordion title="Can I buy more workflow credits only for 1 month?">
Yes, go to `Settings → Billing`, click `Increase` button, choose how many credits you want and confirm, they'll be applied for current billing period. Then click `Increase` button again, change value back to original and confirm, downgrade will be applied starting next billing period.
</Accordion>
</AccordionGroup>
## Billing
@@ -85,4 +94,12 @@ You can do so under `Settings → Billing`. Then click on `View billing details`
<Accordion title="Where can I access my invoices?">
You can do so under `Settings → Billing`. Then click on `View billing details`. You'll see all your invoices at the bottom of the screen.
</Accordion>
<Accordion title="Why are my seats different from the number of users in my workspace?">
Workspace seat counts are synchronized with the payment system every 6 hours; invoices are adjusted based on the difference.
</Accordion>
<Accordion title="Why did I get an invoice for a new workspace member?">
When a new workspace member is added to workspace, an invoice is sent to cover the difference. When a workspace member is removed, the change is applied in the next standard monthly/yearly invoice.
</Accordion>
</AccordionGroup>
@@ -21,9 +21,9 @@ Twenty offers flexible pricing plans to fit your team's needs. Manage your subsc
| Plan | Key Features |
|------|--------------|
| **Free (Self-Hosted)** | All Pro features, community support |
| **Pro (Cloud)** | Everything apart from the Premium features (SSO and row-level permissions), standard support |
| **Organization (Cloud)** | All from Pro + the Premium features (SSO and row-level permissions), priority support |
| **Organization (Self-Hosted)** |All from Pro + the Premium features (SSO, row-level permissions), Twenty team support, not required to publish your custom code as open-source before distributing |
| **Pro (Cloud)** | Everything apart from the Premium features (SSO, row-level permissions and more), standard support |
| **Organization (Cloud)** | All from Pro + the Premium features (SSO, row-level permissions and more), priority support |
| **Organization (Self-Hosted)** | All from Pro + the Premium features (SSO, row-level permissions and more), Twenty team support, not required to publish your custom code as open-source before distributing |
## Quick answers
@@ -55,24 +55,28 @@ For reference:
- **External Emails**: All emails with contacts outside your organization
- **Automatic Linking**: Emails connect to existing People and Company records
- **Multiple Addresses**: Emails from any address link to the same contact record
- **Updates**: New emails appear within 5 minutes
- **Updates**: New emails appear immediately
### What Doesn't Get Synced
- **Internal Emails**: Emails between colleagues (same domain) remain private
- **Internal Emails**: By default, emails between colleagues (same domain) remain private (configured in Settings → General → Security)
- **Group Emails**: Distribution lists and group emails are excluded
- **Excluded Folders**: Folders you've chosen not to sync (configured under Settings → Accounts → Email)
### Internal emails
Choose if internal emails are synchronized in Twenty:
1. Go to **Settings → General → Security**
2. Toggle **Sync Internal Emails** on/off
### Selective Folder Sync
Control which email folders sync with Twenty:
1. Go to **Settings → Accounts** and select your connected email account
2. Configure folders under the Email section
3. Choose specific folders to include or exclude (Inbox, Sent, Archive, custom folders)
## Troubleshooting Email Sync
### Common Sync Issues
- **Sync Delays**: Emails appear within 5 minutes, but initial imports take longer
- **Sync Delays**: Emails appear immediately, but initial imports take longer
- **Missing Emails**: Check if:
- Folders are excluded in Message Folder settings
- Contact auto-creation is disabled (emails need existing Twenty records)
@@ -5,24 +5,21 @@ description: Information about booking meetings directly from Twenty.
## Current Status
**No, Twenty does not currently support booking meetings directly from the platform.**
Twenty's calendar integration is designed to **sync and display** your existing calendar events.
Twenty's calendar integration is designed to **sync and display** your existing calendar events, not to create new ones. All meeting scheduling should be done through your native calendar application (Google Calendar, Microsoft Outlook, etc.).
## Scheduling Meetings via Workflows
While it's not possible to schedule meetings manually, you can do them in Twenty using workflows
1. Create a new workflow
2. Select any trigger depending on your needs
3. Add the **Create Calendar Event** node
4. Configure all necessary data
5. Activate the workflow
## What You Can Do
- **View meeting history** on People, Companies, and Opportunities records
- **See upcoming meetings** with contacts in your CRM
- **Track meeting context** alongside email communications
- **Auto-create contacts** from meeting participants
## How to Schedule Meetings
1. Use your native calendar app (Google Calendar, Outlook, etc.)
2. Create the meeting as you normally would
3. The meeting will automatically sync to Twenty within 5 minutes
4. View the meeting on the relevant CRM records
## Future Plans
Meeting creation from within Twenty is on our roadmap. Join our [GitHub discussions](https://github.com/twentyhq/twenty/discussions) to share your use case and help prioritize this feature.
- **Auto-create contacts** from meeting participants
@@ -5,9 +5,16 @@ description: Information about sending emails directly from Twenty.
## Current Status
Twenty's email integration is designed to **sync and display** your email history. Emails cannot be composed or sent directly from Twenty's interface.
Twenty's email integration is designed to **sync and display** your email history as well as compose and send emails.
When you view an email thread on a record page and click **Reply**, you'll be redirected to the original thread in your mailbox (Gmail, Outlook, etc.). This is where you compose and send your reply.
When you view an email thread on a record page and click **Reply**, you're able to directly compose and send an email.
## How to send a message from Twenty
Prerequisite: mail connected account with possibility to send emails
1. Open Command menu with **Ctrl+K** or **CMD+K** shortcut
2. Click "Compose email" option
3. Choose recipients, add subject, body and attachments to your mail
4. Click "Send" button to send email
## What You Can Do Today
@@ -19,7 +26,7 @@ When you view an email thread on a record page and click **Reply**, you'll be re
## Sending Emails via Workflows
While you can't send emails manually from Twenty, you **can send emails automatically using Workflows**. This is useful for:
You **can send emails automatically using Workflows**. This is useful for:
- Automated follow-ups
- Notifications to contacts
- Triggered communications based on record changes
@@ -14,7 +14,7 @@ Twenty supports **unlimited email accounts per user**. This is useful if you man
1. Go to **Settings → Accounts**
2. Click **Add account**
3. Connect your additional Google or Microsoft account
3. Connect your additional Google, Microsoft account or any other mail provider supporting IMAP/SMTP protocols
4. Configure sync settings for this mailbox
5. Repeat for each mailbox you want to connect
@@ -36,4 +36,4 @@ Emails from all your connected mailboxes are synced to Twenty and appear on:
## Important Notes
<Warning>Only true mailboxes can be connected. Email aliases that forward to another mailbox cannot be connected separatelythey'll sync through the main mailbox.</Warning>
<Warning>Only true mailboxes can be connected. Email aliases that forward to another mailbox cannot be connected separatelythey'll sync through the main mailbox.</Warning>
@@ -12,8 +12,8 @@ By default, Twenty syncs all external emails from your connected mailbox. You ca
Control which email folders sync with Twenty:
1. Go to **Settings → Accounts**
4. Select your connected email account
5. Choose which folders to sync:
2. Select your connected email account
3. Choose which folders to sync:
| Folder | Description |
|--------|-------------|
@@ -22,7 +22,7 @@ Control which email folders sync with Twenty:
| **Archive** | Archived messages |
| **Custom Folders** | Any specific folders you want |
6. Exclude folders you don't want synced (Spam, Trash, personal folders)
4. Exclude folders you don't want synced (Spam, Trash, personal folders)
<Note>This gives you precise control over which emails appear in your CRM without syncing everything.</Note>
@@ -37,14 +37,22 @@ Control when contacts are created from emails:
- **Sent & Received**: Create contacts from all external emails
- **Sent Only**: Only create contacts from emails you send
## Internal emails
Messages between colleagues (same domain) can be synchronized in Twenty:
1. Go to **Settings → General → Security**
2. Toggle **Sync Internal Emails** on/off
<Note>By default, this option is turned off.</Note>
## What's Always Excluded
These emails are never synced, regardless of settings:
- **Internal emails**: Messages between colleagues (same domain)
- **Group emails**: Distribution lists and group messages
- **Spam/Trash**: System folders are typically excluded
## Important Note
<Note>We don't provide a CC email address for selective syncing. Use the folder selection feature above to achieve the same level of control.</Note>
<Note>We don't provide a CC email address for selective syncing yet. Use the folder selection feature above to achieve the same level of control.</Note>
@@ -88,6 +88,23 @@ Display single key values prominently.
### <span style={{ display: 'inline-flex', alignItems: 'center', gap: '8px' }}><ChartIcon icon="frame" />iFrames</span>
Embed external tools and content directly in your dashboard.
<Frame>
<img src="/images/user-guide/dashboard/dashboard-widget-table.png" alt="table"/>
</Frame>
**Best for:**
- Searching individual items
- Checking exact values
- Auditing or reference
**Example uses:**
- Deals closing this month
- New leads this week
- Overdue invoices
### <span style={{ display: 'inline-flex', alignItems: 'center', gap: '8px' }}><ChartIcon icon="table" />Table</span>
See filtered records directly in your dashboard.
<Frame>
<img src="/images/user-guide/dashboard/dashboard-widget-iframe.png" alt="iFrame" />
</Frame>
@@ -120,7 +137,7 @@ Add formatted text and content directly to your dashboard.
- Markdown-style editing
<Note>
**Coming soon**: Gauge charts and tables are not yet available but are on our roadmap.
**Coming soon**: Gauge charts are not yet available but are on our roadmap.
</Note>
@@ -35,8 +35,8 @@ description: Frequently asked questions about dashboards in Twenty.
Dashboard-level filters are not available yet, but this feature is on our roadmap. Currently, you need to apply filters to each widget individually.
</Accordion>
<Accordion title="Are gauge charts or tables available?">
Not yet. Gauge charts and tables are on our roadmap and will be added in a future release.
<Accordion title="Are gauge charts available?">
Not yet. Gauge charts are on our roadmap and will be added in a future release.
</Accordion>
<Accordion title="How do I duplicate a dashboard?">
@@ -37,7 +37,7 @@ Widgets are individual visualizations that display specific data. Types include:
<Note>
**Current limitations**:
- Exporting dashboards and sharing with external users (non-Twenty users) are not available at the moment.
- Gauge charts and tables are not yet available.
- Gauge charts are not yet available.
</Note>
## Getting Started
@@ -25,7 +25,7 @@ Rows with issues are highlighted in **yellow**. You can:
- **Edit the cell directly** to fix the error
- **Remove the row** to skip it entirely
This inline editing saves timeno need to go back to your spreadsheet, fix errors, and re-upload.
This inline editing saves timeno need to go back to your spreadsheet, fix errors, and re-upload.
## Common Error Types