QA & final edits of the entire User Guide released this morning (#15245)
This commit is contained in:
@@ -3,5 +3,5 @@ title: Collaboration
|
||||
icon: IconMail
|
||||
info: "Centralize communications and team collaboration."
|
||||
image: /images/user-guide/emails/emails_header.png
|
||||
sectionInfo: Centralize communications and team collaboration
|
||||
sectionInfo: Your complete guide to Twenty CRM features and best practices.
|
||||
---
|
||||
+4
-4
@@ -23,7 +23,7 @@ Email conversations appear in three main objects:
|
||||
### Viewing Email Threads
|
||||
|
||||
1. **Navigate to a Record**: Go to any Person, Company, or Opportunity record
|
||||
2. **Select the Emails Tab**: Click on the "Emails" tab to view synced emails
|
||||
2. **Select the Emails Tab**: Click on the `Emails` tab to view synced emails
|
||||
3. **Open an Email Thread**: Click on any email to open and read the full conversation
|
||||
4. **Browse History**: Scroll through the complete email history with that contact
|
||||
|
||||
@@ -59,7 +59,7 @@ Depending on your mailbox settings, you might see:
|
||||
|
||||
### Selective Folder Sync (Lab Feature)
|
||||
Control which email folders sync with Twenty:
|
||||
1. Enable "Message Folder" in Settings → Releases → Lab
|
||||
1. Enable `Message Folder` in Settings → Releases → Lab
|
||||
2. Configure folders under Settings → Accounts → Email
|
||||
3. Choose specific folders to include or exclude (Inbox, Sent, Archive, custom folders)
|
||||
|
||||
@@ -82,7 +82,7 @@ Control which email folders sync with Twenty:
|
||||
## Calendar Integration
|
||||
|
||||
### Calendar Tab
|
||||
Next to the Emails tab, you'll find a **Calendar** tab that contains the history of meetings scheduled with the record.
|
||||
Next to the Emails tab, you'll find a `Calendar` tab that contains the history of meetings scheduled with the record.
|
||||
|
||||
**Available for:**
|
||||
- **People**: View all meetings scheduled with a specific contact
|
||||
@@ -93,7 +93,7 @@ Next to the Emails tab, you'll find a **Calendar** tab that contains the history
|
||||
|
||||
### Viewing Meeting History
|
||||
1. **Navigate to a Record**: Go to any Person, Company, or Opportunity record
|
||||
2. **Select the Calendar Tab**: Click on the "Calendar" tab next to the Emails tab
|
||||
2. **Select the Calendar Tab**: Click on the `Calendar` tab next to the Emails tab
|
||||
3. **Browse Meeting History**: View all scheduled meetings and their details
|
||||
4. **Access Meeting Context**: See meeting participants, times, and related information
|
||||
|
||||
|
||||
@@ -39,7 +39,7 @@ Notes include a **Relations** field that allows you to attach a single note to m
|
||||
- The Opportunity being discussed
|
||||
- Any relevant Tasks or other records
|
||||
|
||||
This "morph many" relationship ensures important information is accessible from all relevant record pages.
|
||||
This morph many relationship ensures important information is accessible from all relevant record pages.
|
||||
|
||||
### User Tagging
|
||||
**Note**: User tagging within notes is not currently available. This feature is planned for 2026, which will allow you to mention team members and trigger notifications.
|
||||
@@ -64,7 +64,7 @@ You can format your notes right from the editor. Use Markdown syntax, press the
|
||||
|
||||
Highlight the text to see more formatting options like bold, italics, and alignment options.
|
||||
|
||||
You can also change the background color and text color of each block to highlight important things in your note. To do so, hover over the block you want to format and click on the `⋮` icon besides the `+` icon. Click on <b>Colors</b> to open up all color options for both the text and the background.
|
||||
You can also change the background color and text color of each block to highlight important things in your note. To do so, hover over the block you want to format and click on the `⋮` icon besides the `+` icon. Click on `Colors` to open up all color options for both the text and the background.
|
||||
|
||||
<div style={{padding:'69.01% 0 0 0', position:'relative', margin: '32px 0px 0px'}}>
|
||||
<iframe
|
||||
|
||||
@@ -38,13 +38,13 @@ Use [Workflows](/user-guide/section/workflows/getting-started-workflows) to auto
|
||||
## Task Features
|
||||
|
||||
### Relations Field
|
||||
Tasks include a **Relations** field that allows you to attach a single task to multiple records across different objects. For example, you can link one follow-up task to:
|
||||
Tasks include a `Relations` field that allows you to attach a single task to multiple records across different objects. For example, you can link one follow-up task to:
|
||||
- The Person you need to contact
|
||||
- The Company they represent
|
||||
- The Opportunity being pursued
|
||||
- Any relevant Notes or other records
|
||||
|
||||
This "morph many" relationship ensures tasks are accessible from all relevant record pages and provides complete context.
|
||||
This morph many relationship ensures tasks are accessible from all relevant record pages and provides complete context.
|
||||
|
||||
### User Tagging
|
||||
**Note**: User tagging within tasks is not currently available. This feature is planned for 2026, which will allow you to mention team members and trigger notifications when assigning or updating tasks.
|
||||
@@ -121,7 +121,7 @@ To edit a task, you should click on its card. This will open a side panel offeri
|
||||
To mark a task as complete:
|
||||
|
||||
1. Locate the task on your `Tasks` page or within a `Record page`.
|
||||
2. Click on the circle at the left of the task card - it will change to signify completion.
|
||||
2. Click on the circle at the left of the task card, it will change to signify completion.
|
||||
3. The task status will automatically update to `Done`.
|
||||
|
||||
This procedure will help keep an updated record of your accomplishments.
|
||||
|
||||
@@ -14,7 +14,7 @@ export const USER_GUIDE_INDEX = {
|
||||
{ fileName: 'customize-your-data-model' },
|
||||
{ fileName: 'objects' },
|
||||
{ fileName: 'fields' },
|
||||
{ fileName: 'object-relations' },
|
||||
{ fileName: 'relation-fields' },
|
||||
{ fileName: 'data-model-faq' },
|
||||
{ fileName: 'data-model' },
|
||||
],
|
||||
|
||||
@@ -3,7 +3,7 @@ title: CRM Essentials
|
||||
info: "Essential CRM features for managing leads, sales, and customers."
|
||||
icon: IconTarget
|
||||
image: /images/user-guide/home/contact-and-account-management.png
|
||||
sectionInfo: "Essential CRM features for managing leads, sales, and customers"
|
||||
sectionInfo: Your complete guide to Twenty CRM features and best practices.
|
||||
---
|
||||
|
||||
|
||||
|
||||
+9
-9
@@ -12,7 +12,7 @@ When you start using Twenty, you'll want to get your contacts and companies into
|
||||
|
||||
### Manual entry
|
||||
|
||||
The most straightforward approach is adding records directly through the Twenty interface. Go to the **People** section and click the **+** button to add a new contact. Fill in their name, email, phone, and link them to their company. For companies, head to the **Companies** section and add the organization details - company name, domain, industry, and size.
|
||||
The most straightforward approach is adding records directly through the Twenty interface. Go to the `People` section and click the `+` button to add a new contact. Fill in their name, email, phone, and link them to their company. For companies, head to the `Companies` section and add the organization details: company name, domain, industry, and size.
|
||||
|
||||
The domain field is particularly important for company identification, and the email field is essential for person identification.
|
||||
|
||||
@@ -26,7 +26,7 @@ For ongoing lead generation, you can set up automated workflows that bring data
|
||||
|
||||
**Website forms**: When someone fills out a form on your website, you can configure it to send the information to Twenty automatically. The form submission triggers a webhook that activates a workflow in Twenty, creating the new contact record without any manual work.
|
||||
|
||||
**Integration with other systems**: If you use other business tools, you can connect them to Twenty using API calls and workflows. This lets you automatically sync data between systems - for example, bringing in new customers from your billing system or leads from your marketing platform.
|
||||
**Integration with other systems**: If you use other business tools, you can connect them to Twenty using API calls and workflows. This lets you automatically sync data between systems: for example, bringing in new customers from your billing system or leads from your marketing platform.
|
||||
|
||||
To learn more about setting up these automated data flows, check out our [Workflows](/user-guide/section/workflows) section.
|
||||
|
||||
@@ -44,15 +44,15 @@ Even when adding data manually, you can use workflows to streamline the process.
|
||||
|
||||
### Keeping data unique and clean
|
||||
|
||||
Twenty automatically enforces uniqueness to keep your data organized. Each person's email address serves as a unique identifier - you can't have two people with the same email. Similarly, company domains are unique, so you won't accidentally create duplicate companies.
|
||||
Twenty automatically enforces uniqueness to keep your data organized. Each person's email address serves as a unique identifier: you can't have two people with the same email. Similarly, company domains are unique, so you won't accidentally create duplicate companies.
|
||||
|
||||
If your business needs other fields to be unique (like phone numbers, or reference codes), you can configure this in your data model. Head to our [Data Model](/user-guide/section/data-model/customize-your-data-model) section to learn how to set up additional uniqueness constraints for your specific needs.
|
||||
|
||||
### Handling duplicates
|
||||
|
||||
Sometimes you'll end up with duplicate records. Twenty has a merge feature for both People and Companies - you can combine duplicate records to keep your database clean without losing any information.
|
||||
Sometimes you'll end up with duplicate records. Twenty has a merge feature for both People and Companies: you can combine duplicate records to keep your database clean without losing any information.
|
||||
|
||||
To merge records, select 2 records, open the ```Cmd+K``` menu (the menu with the ... icon on the very top right) and click "Merge Records".
|
||||
To merge records, select 2 records, open the command menu `Cmd+K` on Mac, `Ctrl+K` on Windows and click `Merge Records`.
|
||||
|
||||
### Creating company hierarchies
|
||||
|
||||
@@ -60,7 +60,7 @@ If you work with large organizations that have subsidiaries or multiple division
|
||||
|
||||
### Customizing your views
|
||||
|
||||
Different team members might need to see different information. You can create custom views that show different columns for different purposes - maybe your sales team needs to see deal stages while your support team focuses on contact details. Learn more about this in our [View Management](/user-guide/section/crm-essentials/view-management) article.
|
||||
Different team members might need to see different information. You can create custom views that show different columns for different purposes: maybe your sales team needs to see deal stages while your support team focuses on contact details. Learn more about this in our [View Management](/user-guide/section/crm-essentials/view-management) article.
|
||||
|
||||
## Working with records
|
||||
|
||||
@@ -77,17 +77,17 @@ When you open a Person or Company record, you'll see all their information organ
|
||||
- **Emails**: Email threads with this contact (when your team has connected their mailboxes)
|
||||
- **Calendar**: Meetings and appointments with this contact
|
||||
|
||||
The Email and Calendar tabs are particularly powerful - they automatically show all email exchanges and meetings that anyone on your team has had with this contact, as long as they've connected their mailbox to Twenty. You can learn more about setting this up in our [Emails and Calendars](/user-guide/section/collaboration/emails-and-calendars) guide.
|
||||
The Email and Calendar tabs are particularly powerful: they automatically show all email exchanges and meetings that anyone on your team has had with this contact, as long as they've connected their mailbox to Twenty. You can learn more about setting this up in our [Emails and Calendars](/user-guide/section/collaboration/emails-and-calendars) guide.
|
||||
|
||||
### Adding the fields you need
|
||||
|
||||
The standard fields might not capture everything important for your business. If you need additional information - like customer segments, referral sources, or industry-specific data - you can add custom fields or modify existing ones. Head to our [Data Model](/user-guide/section/data-model/customize-your-data-model) section to learn how to customize your setup.
|
||||
The standard fields might not capture everything important for your business. If you need additional information: like customer segments, referral sources, or industry-specific data: you can add custom fields or modify existing ones. Head to our [Data Model](/user-guide/section/data-model/customize-your-data-model) section to learn how to customize your setup.
|
||||
|
||||
## Managing deleted records
|
||||
|
||||
When you delete a record in Twenty, it's not gone forever. Records are "soft deleted," which means they're hidden but can be restored if needed.
|
||||
|
||||
To access deleted records, use ```Cmd+K``` (or Ctrl+K on Windows) to open the command menu, then click "See deleted records." From there, you can either restore records or permanently delete them if you're sure you don't need them.
|
||||
To access deleted records, open the command menu `Cmd+K` on Mac, `Ctrl+K` on Windows, then click `See deleted records`. From there, you can either restore records or permanently delete them if you're sure you don't need them.
|
||||
|
||||
This safety net means you can clean up your database without worrying about accidentally losing important information.
|
||||
|
||||
|
||||
@@ -14,7 +14,7 @@ Twenty includes standard sales stages like Prospecting, Qualification, Proposal,
|
||||
|
||||
## Working with Kanban Views
|
||||
|
||||
Kanban views visually map out your pipeline, where each column represents a stage and each card represents an opportunity. Each card shows key information like deal value, close date, and assigned owner at a glance. For complete details - including notes, tasks, meetings, and email history - click on any card to open the full opportunity record.
|
||||
Kanban views visually map out your pipeline, where each column represents a stage and each card represents an opportunity. Each card shows key information like deal value, close date, and assigned owner at a glance. For complete details: including notes, tasks, meetings, and email history, click on any card to open the full opportunity record.
|
||||
|
||||
### Moving opportunities through your pipeline
|
||||
|
||||
@@ -45,7 +45,7 @@ You can tailor your pipeline to suit your specific sales process. Stages represe
|
||||
|
||||
#### Adding stages
|
||||
|
||||
To add a stage, access the Select Field Settings by navigating to Settings > Data Model, selecting your object, and then the field your Kanban board depends on.
|
||||
To add a stage, access the Select Field Settings by navigating to Settings → Data Model, selecting your object, and then the field your Kanban board depends on.
|
||||
|
||||
<div style={{padding:'69.01% 0 0 0', position:'relative', margin: '32px 0px 0px'}}>
|
||||
<iframe
|
||||
@@ -68,13 +68,13 @@ To add a stage, access the Select Field Settings by navigating to Settings > Dat
|
||||
|
||||
#### Removing stages
|
||||
|
||||
To remove a stage, hover the stage name or the `⋮` icon, click `Edit from settings` in the Select Field settings, and then click **Delete** next to the relevant stage.
|
||||
To remove a stage, hover the stage name or the `⋮` icon, click `Edit from settings` in the Select Field settings, and then click `Delete` next to the relevant stage.
|
||||
|
||||
<img src="/images/user-guide/kanban-views/edit-stage.png" style={{width:'100%'}}/>
|
||||
|
||||
### Customizing the cards
|
||||
|
||||
You can configure your Kanban board to display some fields and hide others. To hide a field, click on **Options** on the top right, then on **Fields** to bring up the list of options. Hover the field you want to hide to bring up the `-` button. Click on it to hide the field.
|
||||
You can configure your Kanban board to display some fields and hide others. To hide a field, click on `Options` on the top right, then on `Fields` to bring up the list of options. Hover the field you want to hide to bring up the `-` button. Click on it to hide the field.
|
||||
|
||||
You can also rearrange the order of fields by holding down the field name and dragging it to where you want it.
|
||||
|
||||
@@ -82,7 +82,7 @@ You can also rearrange the order of fields by holding down the field name and dr
|
||||
|
||||
### Compact view
|
||||
|
||||
You can also hide all the fields and get an overview of all the opportunities at a glance. To do so, click on **Options** on the top right and turn on the toggle for **Compact view** after selecting layout in kanban view.
|
||||
You can also hide all the fields and get an overview of all the opportunities at a glance. To do so, click on `Options` on the top right and turn on the toggle for `Compact view` after selecting layout in kanban view.
|
||||
|
||||
<img src="/images/user-guide/kanban-views/compact-view.png" style={{width:'100%'}}/>
|
||||
|
||||
@@ -97,6 +97,6 @@ Use [Workflows](/user-guide/section/workflows/getting-started-workflows) to auto
|
||||
|
||||
### Multiple pipelines
|
||||
|
||||
You can create different pipelines for various business lines, market segments, or specialized sales teams by creating new views. Each view can show different opportunities with specific filters and stages tailored to your needs. Learn more about setting this up in our [View Management](/user-guide/section/crm-essentials/view-management) guide.
|
||||
You can create different pipelines for various business lines, market segments, or specialized sales teams by creating new views. Each view can show different opportunities with specific filters and stages tailored to your needs. Learn how to create those views in our [View Management](/user-guide/section/crm-essentials/view-management) guide.
|
||||
|
||||
<ArticleEditContent></ArticleEditContent>
|
||||
|
||||
@@ -8,8 +8,8 @@ sectionInfo: "Essential CRM features for managing leads, sales, and customers"
|
||||
|
||||
## Advanced Sales Capabilities
|
||||
|
||||
GTM teams often need advanced sales capabilities like lead scoring, data enrichment, round robin / territory assignment, automated reminders, and email sequences. While these aren't built-in features in Twenty, they can all be configured and tailored to your specific needs using our flexible workflow system.
|
||||
GTM teams often need advanced sales capabilities like lead scoring, data enrichment, round robin, territory assignment, automated reminders, and email sequences. While these aren't built-in features in Twenty, they can all be configured and tailored to your specific needs using our flexible workflow system.
|
||||
|
||||
Visit our [Workflows section](/user-guide/section/workflows/getting-started-workflows) to learn how to build these automations step by step. For detailed examples, see our [Internal Automations](/user-guide/section/workflows/internal-automations) and [External Tool Integration](/user-guide/section/workflows/external-tool-integration) guides.
|
||||
Visit our [Workflows section](/user-guide/section/workflows) to learn how to build these automations step by step. For detailed examples, see our [Internal Automations](/user-guide/section/workflows/internal-automations) and [External Tool Integration](/user-guide/section/workflows/external-tool-integration) guides.
|
||||
|
||||
<ArticleEditContent></ArticleEditContent>
|
||||
@@ -11,7 +11,7 @@ sectionInfo: "Essential CRM features for managing leads, sales, and customers"
|
||||
You can display your data in three different layouts, each suited for different purposes. Custom layouts to customize what the page looks like for each type of record will be released in December 2025.
|
||||
|
||||
### Default View
|
||||
Each object comes with an unfiltered, unsorted, and undeletable view known as the Default view. It's named after the object's plural name, such as "All Companies," "All People," "All Opportunities".
|
||||
Each object comes with an unfiltered, unsorted, and undeletable view known as the Default view. It's named after the object's plural name, such as`All Companies`,`All People`, `All Opportunities`.
|
||||
<img src="/images/user-guide/views/default-view.png" style={{width:'100%'}}/>
|
||||
|
||||
### List Layout
|
||||
@@ -46,13 +46,17 @@ A visual board where each column represents a stage and each record appears as a
|
||||
|
||||
There are three ways to create a new view:
|
||||
|
||||
### Using Cmd+K Menu
|
||||
Use ```Cmd+K``` (or Ctrl+K on Windows) to open the command menu, then click "Create a new view".
|
||||
### Using the Command Menu
|
||||
Use `Cmd+K` on Mac (or `Ctrl+K` on Windows) to open the command menu, then click `Create a new view`.
|
||||
|
||||
### Using the View Dropdown Menu
|
||||
Click on the view dropdown menu (top left), then click "Add View" at the bottom. From this menu you can:
|
||||
Click on the view dropdown menu (top left), then click `Add View` at the bottom. From this menu you can:
|
||||
- Choose an icon and name for your view
|
||||
- Select the layout type (List or Kanban). Please note that you need to first select the List layout and then add a Group By. You cannot create a List Group By directly from there.
|
||||
- Select the layout type (List or Kanban)
|
||||
|
||||
<ArticleWarning>
|
||||
Important: You need to first select the List layout and then add a Group By. You cannot create a List Group By directly from there.
|
||||
</ArticleWarning>
|
||||
- For Kanban views, select which select field to use as column headers
|
||||
|
||||
<div style={{padding:'69.01% 0 0 0', position:'relative', margin: '32px 0px 0px'}}>
|
||||
@@ -76,7 +80,7 @@ Click on the view dropdown menu (top left), then click "Add View" at the bottom.
|
||||
|
||||
### Creating Views from Existing Filters
|
||||
|
||||
When you modify the sorting and filtering of an existing view, a "Save as new view" button appears. This lets you create a new view based on your current customizations.
|
||||
When you modify the sorting and filtering of an existing view, a `Save as new view` button appears. This lets you create a new view based on your current customizations.
|
||||
|
||||
<div style={{padding:'69.01% 0 0 0', position:'relative', margin: '32px 0px 0px'}}>
|
||||
<iframe
|
||||
@@ -99,25 +103,25 @@ When you modify the sorting and filtering of an existing view, a "Save as new vi
|
||||
|
||||
## Making Views Actionable
|
||||
|
||||
The guidance below shows you how to customize the columns of your views. We do not recommend keeping all the columns - those views can be simplified and made actionable by adding sorting conditions and displaying only certain columns that are relevant to your specific use case.
|
||||
The guidance below shows you how to customize the columns of your views. We do not recommend keeping all the columns: those views can be simplified and made actionable by adding sorting conditions and displaying only certain columns that are relevant to your specific use case.
|
||||
|
||||
## Customizing Your Views
|
||||
|
||||
All layouts support the same customization options: sorting, filtering, and field selection. You can make quick one-time changes by clicking directly on the column name, or use the Options Menu for more comprehensive editing.
|
||||
All layouts support the same customization options: sorting, filtering, and field selection. You can make quick one-time changes by clicking directly on the column name, or use the `Options Menu` for more comprehensive editing.
|
||||
|
||||
|
||||
### Quick Actions vs Options Menu
|
||||
|
||||
**For one-time changes**: Click directly on column headers to sort, or use the ```Move Left```, ```Move Right``` buttons.
|
||||
|
||||
**For multiple edits**: Use the **Options Menu** (top right corner) when you want to make several changes in a row. This menu gives you access to:
|
||||
**For multiple edits**: Use the `Options Menu` (top right corner) when you want to make several changes in a row. This menu gives you access to:
|
||||
- **Layout selection** (List, List Group By, Kanban)
|
||||
- **Grouping options** (for List Group By layout)
|
||||
- **Fields management** (show/hide and reorder columns)
|
||||
|
||||
### Filtering Your Data
|
||||
|
||||
You can apply filters to show only the records that match your criteria. Click **Filter** in the toolbar, select a field, choose your condition, and set the value. You can add multiple filters for advanced filtering based on several conditions.
|
||||
You can apply filters to show only the records that match your criteria. Click `Filter` in the toolbar, select a field, choose your condition, and set the value. You can add multiple filters for advanced filtering based on several conditions.
|
||||
|
||||
|
||||
<div style={{padding:'71.24% 0 0 0', position:'relative', margin: '32px 0px 0px'}}>
|
||||
@@ -165,7 +169,7 @@ Control the order of your records by clicking on any column header to sort by th
|
||||
|
||||
### Managing Fields and Columns
|
||||
|
||||
You can choose which fields to display and reorder them. For quick changes, click on a column name directly. For multiple edits, use **Options Menu > Fields** where you can:
|
||||
You can choose which fields to display and reorder them. For quick changes, click on a column name directly. For multiple edits, use `Options Menu → Fields` where you can:
|
||||
- Show or hide fields using the eye icon
|
||||
- Reorder fields by dragging and dropping
|
||||
- Make multiple changes efficiently in one place
|
||||
|
||||
@@ -3,5 +3,5 @@ title: Data Model
|
||||
info: Customize your data model to fit your unique business processes.
|
||||
icon: IconChecklist
|
||||
image: /images/user-guide/fields/data_model.png
|
||||
sectionInfo: Flexible data model designed to support your unique business processes
|
||||
sectionInfo: Your complete guide to Twenty CRM features and best practices.
|
||||
---
|
||||
|
||||
+9
-9
@@ -11,7 +11,7 @@ A data model is the structure that defines how information is organized in your
|
||||
|
||||
## Why should you customize your data model?
|
||||
Every business works differently. Being able to fully customize your data model means you can shape Twenty around your processes instead of forcing yours into a rigid system.
|
||||
Twenty offers the flexibility you need to shape the data model that will best support your day-to-day. You can create as many custom objects and fields as you need - the price won't change.
|
||||
Twenty offers the flexibility you need to shape the data model that will best support your day-to-day. You can create as many custom objects and fields as you need, the price won't change.
|
||||
|
||||
## Tips to design your data model
|
||||
There is rarely only one way to build a data model. Below are a few tips to help you build yours.
|
||||
@@ -21,29 +21,29 @@ Identify the main concepts you work with (e.g. Companies, People, Opportunities)
|
||||
Example: Stripe would need an object ```Subscriptions```, Airbnb would need an object ```Trips```, a start-up accelerator an object ```Batches```.
|
||||
|
||||
**2. Use fields for variations, not new objects.**
|
||||
If something is just a characteristic of an existing object (e.g. “Industry” for a Company, or “Status” for an Opportunity), make it a field. Fields are best for categories, labels, and attributes.
|
||||
If something is just a characteristic of an existing object (e.g. ```Industry``` for a Company, or ```Status``` for an Opportunity), make it a field. Fields are best for categories, labels, and attributes.
|
||||
|
||||
**3. Create a new object when it stands on its own.**
|
||||
If the concept has its own lifecycle, properties, or relationships, it usually deserves an object. For example:
|
||||
- **Projects** that have their own deadlines, owners, and tasks
|
||||
- **Subscriptions** that connect Companies, Products, and Invoices
|
||||
- **Events** that involve many Attendees and follow-up actions
|
||||
- **Subscriptions** that connect companies, products, and invoices
|
||||
- **Events** that involve many attendees and follow-up actions
|
||||
|
||||
These go beyond a single field because they carry their own data and relationships.
|
||||
|
||||
**4. Create an object when the number of related records is open-ended.**
|
||||
If something can be linked multiple times and you don’t know how many, it’s better as its own object. For instance, instead of creating fields like “Product 1”, “Product 2”, etc., define a **Product object** and relate it to the original record. This way, you can support one, two, or a hundred products without changing your model.
|
||||
If something can be linked multiple times and you don’t know how many, it’s better as its own object. For instance, instead of creating fields like `Product 1`, `Product 2`, etc., define a `Product` object and relate it to the original record. This way, you can support one, two, or a hundred products without changing your model.
|
||||
|
||||
**5. Keep it simple first.**
|
||||
Start with fields. Move to new objects only when you feel the limits — too many fields, repeated records, or relationships that don’t fit neatly.
|
||||
Start with fields. Move to new objects only when you feel the limits: too many fields, repeated records, or relationships that don’t fit neatly.
|
||||
|
||||
|
||||
### Special note on People, Companies and Opportunities
|
||||
|
||||
- **People, Companies and Opportunities are the only objects from where you can access the emails and meetings synchronized from your mailbox / calendar.** We recommend using those as much as possible. If you need to create categories of People or Companies, use fields rather than new objects.
|
||||
- **`People`, `Companies` and `Opportunities` are the only objects from where you can access the emails and meetings synchronized from your mailbox / calendar.** We recommend using those as much as possible. If you need to create categories of `People` or `Companies`, use fields rather than new objects.
|
||||
|
||||
Example: it is best to use the **People object** for both prospects and partners, adding a field called `Person Type`. Avoid creating a Partner object, since you wouldn’t be able to access email threads from it. Instead, create different views under People — one showing Partners, another showing Prospects.
|
||||
- Given the point above, it’s fine to have fields that don’t apply to every record. For example, under People you might add a **Referral Link** field that is only relevant when `Person Type = Partner`. That’s okay — you can hide this field from views where it doesn’t matter.
|
||||
Example: it is best to use the `People` object for both prospects and partners, adding a field called `Person Type`. Avoid creating a `Partner` object, since you wouldn’t be able to access email threads from it. Instead, create different views under `People`: one showing partners, another showing prospects.
|
||||
- Given the point above, it’s fine to have fields that don’t apply to every record. For example, under `People` you might add a `Referral Link` field that is only relevant when `Person Type = Partner`. That’s okay: you can hide this field from views where it is not needed.
|
||||
|
||||
|
||||
### Questions to guide your choice
|
||||
|
||||
@@ -41,7 +41,7 @@ Formula fields are coming in **Q1 2026**. In the meantime, you can use workflows
|
||||
<details>
|
||||
<summary>Can I have nested fields in my objects?</summary>
|
||||
|
||||
Nested fields are coming in **Q1 2026**. Currently, you can use workflows to bring field values from related objects. For example, to display a Company's industry on a Person record, create a custom field on People and use a workflow to sync the value.
|
||||
Nested fields are coming in **Q1 2026**. Currently, you can use workflows to bring field values from related objects. For example, to display a company's industry on a Person record, create a custom field on People and use a workflow to synchronize the value.
|
||||
|
||||
</details>
|
||||
|
||||
@@ -66,7 +66,7 @@ This creates limitations when singular and plural forms are the same, but it imp
|
||||
<details>
|
||||
<summary>Why are some field names protected?</summary>
|
||||
|
||||
Certain field names like "Type" are reserved for system use. Choose alternative names like "Category" or "Classification" instead.
|
||||
Certain field names like `Type` or `Application` are reserved for system use. Choose alternative names like `Category` or `Classification` instead.
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
@@ -15,7 +15,7 @@ Fields are like columns in a spreadsheet. They store different types of data lik
|
||||
|
||||
Standard fields come built-in with Twenty to handle common business needs.
|
||||
|
||||
For example, "First Name" and "Last Name" are standard fields in the `People` object. They store text data for individual names.
|
||||
For example, `First Name` and `Last Name` are standard fields in the `People` object. They store text data for individual names.
|
||||
|
||||
You cannot delete standard fields, but you can deactivate them if you don't need them.
|
||||
|
||||
@@ -25,9 +25,9 @@ You can also customize the options of the standard ```SELECT``` type fields, for
|
||||
|
||||
### Custom Fields
|
||||
|
||||
Custom fields let you add your own data fields to any object. You can store text, numbers, dates, dropdown selections, and more. Use custom fields to track information that's specific to your business.
|
||||
Custom fields can be added to any object. You can store text, numbers, dates, dropdown selections, and more. Use custom fields to track information that's specific to your business.
|
||||
|
||||
For instance, a custom field for SpaceX could be "Rocket Active Status", indicating if a rocket is operational.
|
||||
For instance, a custom field for SpaceX could be `Rocket Active Status`, indicating if a rocket is operational.
|
||||
|
||||
<img src="/images/user-guide/fields/custom-fields.png"style={{width:'100%'}}/>
|
||||
|
||||
@@ -39,7 +39,7 @@ To add a custom field to any object, follow these steps:
|
||||
3. Proceed by clicking on `Add Field`.
|
||||
4. Choose a field name and type that suits your requirements. Consider adding a field description for better understanding.
|
||||
|
||||
Your newly created field is now available within the application's fields. To display it on a specific view, click on the options menu, then select "Fields".
|
||||
Your newly created field is now available within the application's fields. To display it on a specific view, click on the options menu, then select `Fields`.
|
||||
|
||||
<div style={{padding:'71.15% 0 0 0', position:'relative', margin: '32px 0px 0px'}}>
|
||||
<iframe
|
||||
@@ -60,7 +60,7 @@ Your newly created field is now available within the application's fields. To di
|
||||
</div>
|
||||
<script src="https://player.vimeo.com/api/player.js"></script>
|
||||
|
||||
**Quick way:** Click the **+** button at the top right of any object table, then select "Customize fields". This takes you directly to the Data Model settings.
|
||||
**Quick way:** Click the **+** button at the top right of any object table, then select `Customize fields`. This takes you directly to the Data Model settings.
|
||||
|
||||
<img src="/images/user-guide/fields/quick-new-field.png" style={{width:'100%'}}/>
|
||||
|
||||
@@ -72,9 +72,9 @@ Here's how you can do it:
|
||||
|
||||
1. Find the field you want to deactivate in your object settings.
|
||||
|
||||
2. Click the three dots (⋮) next to the field to open the menu.
|
||||
2. Click the three dots `⋮` next to the field to open the menu.
|
||||
|
||||
3. Select "Deactivate" from the dropdown.
|
||||
3. Select `Deactivate` from the dropdown.
|
||||
|
||||
<img src="/images/user-guide/fields/deactivate-field.png" style={{width:'100%'}}/>
|
||||
|
||||
@@ -90,7 +90,7 @@ You can reactivate Standard and Custom Fields or have the option to permanently
|
||||
|
||||
## Make Fields Unique
|
||||
|
||||
Make a field unique to ensure no two records can have the same value. For example, email addresses should be unique for each person.
|
||||
Make a field unique to ensure distinct records cannot have the same value. For example, email addresses are unique for each person.
|
||||
|
||||
If you get an error when setting uniqueness, check for duplicate values in your data (including deleted records).
|
||||
|
||||
@@ -98,20 +98,20 @@ If you get an error when setting uniqueness, check for duplicate values in your
|
||||
|
||||
### Naming Conventions and Limitations
|
||||
- **Relation field names cannot be updated** after creation (impacts API structure)
|
||||
- **Singular and plural named must be distinct** - Our GraphQL API needs distinct names for mutations
|
||||
- **Protected field names** - some names are reserved for system usage (e.g., ```Type```)
|
||||
- **Singular and plural named must be distinct**: Our GraphQL API needs distinct names for mutations
|
||||
- **Protected field names**: some names are reserved for system usage (e.g., ```Type```)
|
||||
|
||||
### Currency and Phone Fields
|
||||
- **Default currency** - can be configured
|
||||
- **Default country codes** - can be configured for phone fields
|
||||
- **Default currency**: can be configured via the data model
|
||||
- **Default country codes**: can be configured for phone fields via the data model
|
||||
|
||||
### Select Fields
|
||||
- **A default option can be selected** for each Select field
|
||||
|
||||
### Record Text Fields
|
||||
- **Each object has one main display field** - This field appears in the leftmost column and represents the record when linked to other objects. It must be a text field. For example, People uses "Name" as the main field, so when you link a person to a company, you'll see their name in the company's view.
|
||||
- **Each object has one main display field**: This field appears in the leftmost column and represents the record when linked to other objects. It must be a text field. For example, People uses `Name` as the main field, so when you link a person to a company, you'll see their name in the company's view.
|
||||
|
||||
### Relation Fields
|
||||
- **Connect objects together** - Relation fields link records from different objects. For detailed information on creating and managing relationships, see our [Relation Fields](/user-guide/section/data-model/object-relations) article.
|
||||
- **Connect objects together**: Relation fields link records from different objects. For detailed information on creating and managing relationships, see our [Relation Fields](/user-guide/section/data-model/object-relations) article.
|
||||
|
||||
<ArticleEditContent></ArticleEditContent>
|
||||
|
||||
@@ -8,7 +8,7 @@ sectionInfo: Flexible data model designed to support your unique business proces
|
||||
|
||||
## Standard Objects
|
||||
|
||||
Standard objects are predefined entities in your workspace that offer integrated, standardized intelligence requiring no extra configuration. They're part of a shared data model accessible to all users of Twenty.
|
||||
Standard objects are predefined entities in your workspace to help you get started. They're part of a shared data model accessible to all users of Twenty. You can use them as-is, customize them or deactivate them.
|
||||
|
||||
<img src="/images/user-guide/objects/standard-objects.png"style={{width:'100%'}}/>
|
||||
|
||||
@@ -18,7 +18,7 @@ The `People` object stores your contacts. It includes contact details and intera
|
||||
|
||||
### Company
|
||||
|
||||
The `Companies` object stores your business accounts. It includes details like industry, size and location. You can add a field to detail your relationship with this account: prospect, customer, other. Companies connect to both People and Opportunities objects.
|
||||
The `Companies` object stores your business accounts. It includes details like industry, size and location. Companies connect to both `People` and `Opportunities` objects.
|
||||
|
||||
### Opportunities
|
||||
|
||||
@@ -59,7 +59,9 @@ To create a new custom object:
|
||||
|
||||
3. Click on `+ New object` at the top. Enter the name (both singular and plural), choose an icon, and add a description for your custom object and hit Save (at the top right). Using Listing as an example of custom object, the singular would be "listing" and the plural would be "listings" along with a description like "Listings that hosts created to showcase their property."
|
||||
|
||||
**Note:** The singular and plural names must be different. This is required for our GraphQL API to work properly.
|
||||
<ArticleWarning>
|
||||
The singular and plural names must be different. This is required for our GraphQL API to work properly.
|
||||
</ArticleWarning>
|
||||
|
||||
<div style={{padding:'71.24% 0 0 0', position:'relative', margin: '32px 0px 0px'}}>
|
||||
<iframe
|
||||
|
||||
+7
-5
@@ -28,16 +28,18 @@ You'll need to set names for both sides of the relationship:
|
||||
- **Source field name**: How the field appears on your current object
|
||||
- **Target field name**: How the reverse field appears on the target object
|
||||
|
||||
**Note:** Field names cannot be edited once the relation is saved as it impacts the API structure. Choose carefully!
|
||||
<ArticleWarning>
|
||||
Field names cannot be edited once the relation is saved as it impacts the API structure. Choose carefully.
|
||||
</ArticleWarning>
|
||||
|
||||
## Relating to Team Members
|
||||
|
||||
You can create relations to any object, including **Workspace Members** (your Twenty team users). This is useful for creating ownership fields:
|
||||
|
||||
- **Account Owner** - Link a Company to a team member who manages it
|
||||
- **Deal Owner** - Assign an Opportunity to a specific salesperson
|
||||
- **Account Owner**: Link a Company to a team member who manages it
|
||||
- **Deal Owner**: Assign an Opportunity to a specific salesperson
|
||||
|
||||
When you create a relation to Workspace Members, you'll see your team members' names in dropdown selections, making it easy to assign ownership and responsibilities.
|
||||
When you create a relation to`Workspace Members`, you'll see your team members' names in dropdown selections, making it easy to assign ownership and responsibilities.
|
||||
|
||||
## Best Practices
|
||||
|
||||
@@ -46,7 +48,7 @@ When you create a relation to Workspace Members, you'll see your team members' n
|
||||
- **Test relationships** with sample data before full implementation
|
||||
|
||||
## Upcoming Features
|
||||
- **Many-to-many relationships** (Coming Q1 2026)
|
||||
- **Morph Many relationships** (Coming Q4 2025)
|
||||
- **Many-to-many relationships** (Coming Q1 2026)
|
||||
|
||||
<ArticleEditContent></ArticleEditContent>
|
||||
@@ -3,5 +3,5 @@ title: Getting Started
|
||||
icon: IconUsers
|
||||
info: Start your Twenty journey with these essential guides.
|
||||
image: /images/user-guide/what-is-twenty/20.png
|
||||
sectionInfo: A brief guide to grasp the basics of Twenty
|
||||
sectionInfo: Your complete guide to Twenty CRM features and best practices.
|
||||
---
|
||||
+13
-13
@@ -6,12 +6,12 @@ image: /images/user-guide/what-is-twenty/getting_started.png
|
||||
sectionInfo: Discover Twenty, an open-source CRM.
|
||||
---
|
||||
|
||||
Every business works differently. That's why Twenty lets you shape the CRM around your needs—not force your processes into ours.
|
||||
Every business works differently. That's why Twenty lets you shape the CRM around your needs, not force your processes into ours.
|
||||
**Start with these three steps to set it up your way.**
|
||||
|
||||
💡 **Quick Win**: Start with connecting your mailbox and customizing your data model with a few key fields. This gives you immediate value and helps your team see Twenty in action with real data. You can do so under Settings → Accounts.
|
||||
**Quick Win**: Start with connecting your mailbox and customizing your data model with a few key fields. This gives you immediate value and helps your team see Twenty in action with real data. You can do so under Settings → Accounts.
|
||||
|
||||
# 1. Customize your data model
|
||||
## 1. Customize your data model
|
||||
Twenty offers the flexibility you need to shape the data model that will best support your day-to-day.
|
||||
Create objects and fields of any type, including relations between your different objects. You can do so under Settings → Data Model.
|
||||
Here are a few tips:
|
||||
@@ -25,22 +25,22 @@ Here are a few tips:
|
||||
|
||||
Read [this article](https://twenty.com/user-guide/section/data-model/customize-your-data-model) to learn how to design your data model.
|
||||
|
||||
# 2. Bring your data in
|
||||
## 2. Bring your data in
|
||||
Bringing your existing data into Twenty gives your team context from the start.
|
||||
|
||||
## Connect your mailbox
|
||||
### Connect your mailbox
|
||||
If you have not done so when creating your workspace, connect your **Google or Microsoft account** under Settings → Accounts. This allows Twenty to:
|
||||
- Import your messages and meetings
|
||||
- Auto-create contacts based on interactions (optional)
|
||||
- Keep communication history visible for your team
|
||||
|
||||
#### Using another provider?
|
||||
You can add another mailbox via SMPT or another calendar via CalDAV. You will need to activate the feature under Settings → Releases → Lab, and then go back to the Settings → Accounts tab.
|
||||
**Using another provider?**
|
||||
You can add another mailbox via SMTP or another calendar via CalDAV. You will need to activate the feature under Settings → Releases → Lab, and then go back to the Settings → Accounts tab.
|
||||
|
||||
## Import data via csv
|
||||
### Import data via csv
|
||||
Use the Command menu (```Cmd + K``` or ```Ctrl + K```) to import People, Companies, Opportunities, or any custom objects via CSV.
|
||||
|
||||
Key guidelines:
|
||||
**Key guidelines**:
|
||||
- Download the sample file to understand the expected format
|
||||
- Limit each file to 10k records
|
||||
- Remove duplicate emails for People or duplicate domains for Companies
|
||||
@@ -48,14 +48,14 @@ Key guidelines:
|
||||
|
||||
Read [this article](/user-guide/section/getting-started/import-export-data) to learn more about data import.
|
||||
|
||||
# 3. Create your first view
|
||||
## 3. Create your first view
|
||||
Creating different views is key to make the data actionable for your team.
|
||||
Here is how to proceed:
|
||||
- **Add or hide columns**
|
||||
Manage the fields visible in a given view clicking on Options → Fields (from the top right). You can show/hide fields from there.
|
||||
Manage the fields visible in a given view clicking on Options → Fields (from the top right). You can show/hide fields from there.
|
||||
|
||||
- **Reorder fields**
|
||||
Reorder the fields from a given view clicking on Options → Fields (from the top right). Drag and drop the fields to reorder them.
|
||||
Reorder the fields from a given view clicking on Options → Fields (from the top right). Drag and drop the fields to reorder them.
|
||||
|
||||
- **Filter your view**
|
||||
Narrow down the records displayed using the Filters from the top right.
|
||||
@@ -64,7 +64,7 @@ Here is how to proceed:
|
||||
Reorder records displayed using the Sort function from the top right, or by clicking directly on the column name.
|
||||
|
||||
- **Choose the layout**
|
||||
You can switch to a **Kanban layout** or a list **Group By** layout -- as long as the object has a “Stage” or similar select-type field.
|
||||
You can switch to a **Kanban layout** or a list **Group By** layout, as long as the object has a `Stage` or similar select-type field.
|
||||
|
||||
- **Save your view as Favorites**
|
||||
This can be done using the dropdown menu showing the different views.
|
||||
|
||||
+6
-3
@@ -9,7 +9,7 @@ sectionInfo: Discover Twenty, an open-source CRM.
|
||||
When you log into Twenty for the first time, the layout should feel intuitive. It’s designed to help you move fast and stay organized, without getting in your way.
|
||||
|
||||
## The Main Layout
|
||||
The center of the screen is **where your records live** — people, companies, opportunities, tasks, notes, workflows and any other object you created. This is where the day-to-day work happens.
|
||||
The center of the screen is **where your records live**: people, companies, opportunities, tasks, notes, workflows and any other object you created. This is where the day-to-day work happens.
|
||||
You can **view, edit, delete records** from there as well as **creating new views**.
|
||||
|
||||
## The Navigation Bar
|
||||
@@ -18,7 +18,10 @@ On the left side, from the top to the bottom, you’ll be able to:
|
||||
- Choose between the light and dark modes
|
||||
- Use the **search bar** (press `/` to focus on it instantly)
|
||||
- Open the **Settings** section
|
||||
**Please note that our API documentation is accessible under the Settings section and not the User Guide.**
|
||||
|
||||
<ArticleWarning>
|
||||
Please note that our API documentation is accessible under the Settings section and not the User Guide.
|
||||
</ArticleWarning>
|
||||
- Have direct access to your **Favourites views**. Favourites are unique for each user.
|
||||
- Switch between different objects
|
||||
- **Create automations** using workflows
|
||||
@@ -54,7 +57,7 @@ If you're new to Views, read our [View Management](/user-guide/section/crm-essen
|
||||
## Settings
|
||||
Open your Settings from the top left to:
|
||||
- **Connect your mailbox and calendar** accounts for seamless email and calendar sync
|
||||
- Customize your **data model** - create custom objects, fields, and relationships
|
||||
- Customize your **data model**: create custom objects, fields, and relationships
|
||||
- **Access the API playground and configure webhooks**
|
||||
- **Manage user permissions** and workspace access controls
|
||||
- Invite team members and manage user roles
|
||||
|
||||
+3
-3
@@ -12,9 +12,9 @@ Whether you need help getting started or creating advanced customizations, we ha
|
||||
### Onboarding Packs
|
||||
Get help from our core team to set up your Twenty workspace with our 4-hour [Onboarding packs](https://twenty.com/onboarding-packages):
|
||||
|
||||
- **Data Model Design** - Design and create your custom data model with objects, fields, and relationships
|
||||
- **Data Migration** - Migrate your existing data from your current CRM to Twenty
|
||||
- **Workflow Creation** - Create custom workflows to support your business processes
|
||||
- **Data Model Design**: Design and create your custom data model with objects, fields, and relationships
|
||||
- **Data Migration**: Migrate your existing data from your current CRM to Twenty
|
||||
- **Workflow Creation**: Create custom workflows to support your business processes
|
||||
|
||||
### Implementation Partners
|
||||
Work with certified Twenty partners for more advanced customizations and integrations. Reach out to our team via contact@twenty.com to be matched with our [partners](https://twenty.com/implementation-services).
|
||||
|
||||
+8
-4
@@ -26,10 +26,14 @@ Below are a few items to check before uploading your file.
|
||||
- We recommend using the syntax ```https://domain.com``` when uploading your domains, as this is the one used by our connector with your mailbox and calendar.
|
||||
- You can **import the relations between objects** by providing one of the unique fields of the associated record.
|
||||
- Example: You want to attach a person to a company. Add a column in the file containing all the `People` records that contains the `id` of the company -- or its `domain`. You will be able to map this field during the upload.
|
||||
- **Important note**
|
||||
- Relations between objects in Twenty are "One to Many". This means each record of object A can be attached to several records of object B. One company can be attached to several people. But each record of object B can belong to only one record of object A. One person can belong to only one company.
|
||||
- **To upload relations via the Import function, you need to provide the `id` (or any other unique field) of the attached object in the file containing the records on the "Many side" of the relationship**.
|
||||
- For example, you provide the `id` or `domain` of the company when uploading people records. You do not provide the people's `id` (or `email`) when uploading the file with companies.
|
||||
<ArticleWarning>
|
||||
**Important note:**
|
||||
- Relations between objects in Twenty are "One to Many". This means each record of object A can be attached to several records of object B. But each record of object B can belong to only one record of object A.
|
||||
*For example, one company can be attached to several people. And one person can belong to only one company.*
|
||||
|
||||
- To upload relations via the Import function, you need to provide the `id` (or any other unique field) of the attached object in the file containing the records on the "Many side" of the relationship.
|
||||
*For example, you provide the `id` or `domain` of the company when uploading people records. You do not provide the people's `id` (or `email`) when uploading the file with companies.*
|
||||
</ArticleWarning>
|
||||
|
||||
|
||||
### Upload your file
|
||||
|
||||
+17
-18
@@ -6,14 +6,10 @@ image: /images/user-guide/what-is-twenty/migrating_crm.png
|
||||
sectionInfo: A brief guide to grasp the basics of Twenty
|
||||
---
|
||||
|
||||
# Migrating from Other CRMs
|
||||
|
||||
Successfully migrate your data and processes from other CRMs to Twenty with minimal disruption to your business.
|
||||
|
||||
## Before You Start
|
||||
|
||||
### 1. Audit Your Current Data
|
||||
- **Select the few objects and fields to migrate**: this migration is the opportunity for a fresh start!
|
||||
- **Select the few objects and fields to migrate**: this migration is the opportunity for a fresh start
|
||||
- **Export this data** from your current CRM
|
||||
- **Remove duplicates** and outdated records
|
||||
- **List active workflows** and automations
|
||||
@@ -23,7 +19,7 @@ Follow our [data model guide](/user-guide/section/data-model/customize-your-data
|
||||
- **Design the data model** you need
|
||||
- **Map existing fields** to Twenty's standard objects / fields
|
||||
- **Identify the custom objects / fields** that you will need
|
||||
- **Create it** under Settings → Data model
|
||||
- **Create them** under Settings → Data model
|
||||
|
||||
## Migration Process
|
||||
|
||||
@@ -33,7 +29,7 @@ Follow our [data model guide](/user-guide/section/data-model/customize-your-data
|
||||
2. **People** second (linked to companies)
|
||||
3. **Opportunities** third (linked to people/companies)
|
||||
|
||||
Use CSV import via Command Menu (Cmd+K). See our [data import guide](/user-guide/section/getting-started/import-export-data) for detailed instructions.
|
||||
Use the CSV import via the Command Menu `Cmd + K` (Mac) or `Ctrl + K` (Windows). See our [data import guide](/user-guide/section/getting-started/import-export-data) for detailed instructions.
|
||||
|
||||
### 2. Recreate Workflows
|
||||
- **Start simple** - recreate your most critical automations first
|
||||
@@ -44,16 +40,19 @@ Use CSV import via Command Menu (Cmd+K). See our [data import guide](/user-guide
|
||||
### Data Formatting Issues
|
||||
- **Email addresses** - remove duplicates (People object requirement)
|
||||
- **Domain** - remove duplicates (Companies object requirement)
|
||||
Please note that domain URLs created by the synchronization with your mailbox and calendar have the following format ```https://domain.com```
|
||||
- **Date formats** - ensure consistent formatting (YYYY-MM-DD)
|
||||
- **Phone numbers** - use international format (+1234567890)
|
||||
<ArticleWarning>
|
||||
Please note that domain URLs created by the synchronization with your mailbox and calendar have the following format ```https://domain.com```
|
||||
</ArticleWarning>
|
||||
|
||||
- **Date formats** - ensure consistent formatting (YYYY-MM-DD) or edit this format under Settings → Experience
|
||||
- **Phone numbers** - use international format (+1234567890)
|
||||
|
||||
### Relationship Mapping
|
||||
To import relations between records using the csv import function, you can use the following fields
|
||||
- **Use Twenty IDs** for complex relationships
|
||||
- **Use email addresses** to link People records
|
||||
- **Use domain names** to link Company records
|
||||
- **Use any other field you set as unique**, which can be done in the Data Model section
|
||||
- **Use any other field you set as unique**, which can be done in the Data Model section.
|
||||
Read our [import-export data guide](/user-guide/section/getting-started/import-export-data) for detailed instructions on creating relationships during CSV import.
|
||||
|
||||
## Professional Help
|
||||
@@ -68,15 +67,15 @@ Discover our [implementation services](/user-guide/section/getting-started/imple
|
||||
If you're moving from Twenty self-hosted to Twenty Cloud:
|
||||
1. **Export your data** from your self-hosted instance
|
||||
2. **Follow the standard migration process** above
|
||||
3. **We can provide migration assistance** - reach out to our team
|
||||
3. **We can provide migration assistance**, reach out to our team
|
||||
|
||||
## Post-Migration Checklist
|
||||
|
||||
[ ] All data imported successfully
|
||||
[ ] Custom fields working correctly
|
||||
[ ] User permissions configured
|
||||
[ ] Email/calendar sync connected
|
||||
[ ] Critical workflows recreated and tested
|
||||
[ ] Team trained on new system
|
||||
<input type="checkbox" /> All data imported successfully
|
||||
<input type="checkbox" /> Custom fields working correctly
|
||||
<input type="checkbox" /> User permissions configured
|
||||
<input type="checkbox" /> Email/calendar sync connected
|
||||
<input type="checkbox" /> Critical workflows recreated and tested
|
||||
<input type="checkbox" /> Team trained on new system
|
||||
|
||||
<ArticleEditContent></ArticleEditContent>
|
||||
|
||||
@@ -6,48 +6,8 @@ image: /images/user-guide/what-is-twenty/20.png
|
||||
sectionInfo: Discover Twenty, an open-source CRM.
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
Twenty is the leading open-source CRM, crafted by hundreds of contributors to suit your unique business needs.
|
||||
|
||||
### Main Features
|
||||
|
||||
**Contact Management:** Efficiently store and manage customer data. [Learn more](/user-guide/section/crm-essentials/contact-and-account-management).
|
||||
|
||||
**Custom Objects:** Create and customize objects to fit your business needs. [Details](/user-guide/section/data-model/objects).
|
||||
|
||||
**Custom Fields:** Tailor data fields to capture and organize information specific to your operations. [Understand more](/user-guide/section/data-model/fields).
|
||||
|
||||
**Kanban & Table Views:** Optimize your workflow with flexible table views and [Pipeline Management](/user-guide/section/crm-essentials/pipeline).
|
||||
|
||||
**Pipeline Visualization:** Get a clear view of your processes with customizable views. [Explore views](/user-guide/section/crm-essentials/view-management).
|
||||
|
||||
**Email Integration:** View the emails of a specific customer or company within your workspace. [Integrate now](/user-guide/section/integrations/emails).
|
||||
|
||||
**Notes:** Create detailed notes for each record to share knowledge more effectively. [Add notes](/user-guide/section/collaboration/notes).
|
||||
|
||||
**Tasks:** Schedule tasks to track customer interactions. [See how](/user-guide/section/collaboration/tasks).
|
||||
|
||||
**API & Webhooks:** Connect to other apps and automate workflows with API and Webhooks. [Start integrating](/user-guide/section/integrations/api-webhooks).
|
||||
|
||||
**Workflows:** Automate your business processes and integrate with external tools using powerful workflow automation. [Get started](/user-guide/section/workflows/getting-started-workflows).
|
||||
|
||||
**Permissions:** Control access and manage user roles with flexible workspace and object-level permissions. [Configure permissions](/user-guide/section/settings/permissions).
|
||||
|
||||
### Benefits
|
||||
|
||||
**Customizable:** Designed to fit your business needs.
|
||||
|
||||
**Community-driven:** Built and maintained by a large open-source community.
|
||||
|
||||
**Cost-effective:** You'll never be vendor-locked, because you can always self-host.
|
||||
|
||||
### System Requirements
|
||||
|
||||
Modern web browser (Firefox, Chrome, Safari and Edge on their latest version are supported).
|
||||
|
||||
Internet connection (Offline mode isn't yet supported).
|
||||
|
||||
## Vision
|
||||
Creating a good CRM is hard because it's a balancing act.
|
||||
For each business, the requirements seem straightforward, yet everyone's needs are distinct.
|
||||
@@ -60,6 +20,41 @@ We prioritize universal principles and common patterns over feature lists.
|
||||
We don't try to have all the answers and instead empower users to find what works best for them.
|
||||
Open-source is the bedrock of our approach, ensuring that Twenty evolves with its community, for its community.
|
||||
|
||||
## Benefits
|
||||
|
||||
**Customizable:** Designed to fit your business needs.
|
||||
|
||||
**Community-driven:** Built and maintained by a large open-source community.
|
||||
|
||||
**Cost-effective:** You'll never be vendor-locked, because you can always self-host.
|
||||
|
||||
|
||||
|
||||
## Main Features
|
||||
|
||||
**Contact Management:** Efficiently store and manage customer data. [Learn more](/user-guide/section/crm-essentials/contact-and-account-management).
|
||||
|
||||
**Custom Objects:** Create and customize objects to fit your business needs. [Details](/user-guide/section/data-model/objects).
|
||||
|
||||
**Custom Fields:** Tailor data fields to capture and organize information specific to your operations. [Understand more](/user-guide/section/data-model/fields).
|
||||
|
||||
**Deal Management:** Track and manage your sales opportunities through customizable [Pipeline stages](/user-guide/section/crm-essentials/pipeline).
|
||||
|
||||
**Kanban & Table Views:** Make data actionable with [flexible table views](/user-guide/section/crm-essentials/view-management).
|
||||
|
||||
**Workflows:** Automate your business processes and integrate with external tools using powerful workflow automation. [Get started](/user-guide/section/workflows/getting-started-workflows).
|
||||
|
||||
**Email Integration:** View the emails of a specific customer or company within your workspace. [Synchronize your mailbox](/user-guide/section/collaboration/emails-and-calendars).
|
||||
|
||||
**Notes:** Create detailed notes for each record to share knowledge more effectively. [Add notes](/user-guide/section/collaboration/notes).
|
||||
|
||||
**Tasks:** Schedule tasks to track customer interactions. [See how](/user-guide/section/collaboration/tasks).
|
||||
|
||||
**Permissions:** Control access and manage user roles with flexible workspace and object-level permissions. [Configure permissions](/user-guide/section/settings/permissions).
|
||||
|
||||
**API & Webhooks:** Connect to other apps and automate workflows with API and Webhooks. [Start integrating](/user-guide/section/integrations-api/api-webhooks).
|
||||
|
||||
|
||||
## Join now
|
||||
|
||||
<ArticleLink href="https://app.twenty.com">Register here</ArticleLink> or <ArticleLink href="https://github.com/twentyhq/twenty">become a contributor on GitHub</ArticleLink>.
|
||||
|
||||
@@ -3,5 +3,5 @@ title: Integrations API
|
||||
info: Learn how to connect Twenty to your other tools.
|
||||
icon: IconBrandZapier
|
||||
image: /images/user-guide/integrations/plug.png
|
||||
sectionInfo: Connect Twenty to your existing tools and workflows
|
||||
sectionInfo: Your complete guide to Twenty CRM features and best practices.
|
||||
---
|
||||
@@ -10,8 +10,6 @@ sectionInfo: Learn how to connect Twenty to your other tools.
|
||||
|
||||
API keys allow automated access to your CRM data, synchronize data with other systems, and create custom integrations or solutions.
|
||||
|
||||
For example, you can use them to retrieve details of a specific `Person` or `Company` record, such as their name or address.
|
||||
|
||||
### Create an API Key
|
||||
|
||||
1. Go to **Settings → APIs & Webhooks**
|
||||
@@ -20,7 +18,7 @@ For example, you can use them to retrieve details of a specific `Person` or `Com
|
||||
- **Name**: Give your API key a descriptive name
|
||||
- **Expiration Date**: Set when the key should expire
|
||||
4. Click **Save** to generate your API key
|
||||
5. **Important**: Copy and store your API key immediately - it's only shown once
|
||||
5. **Important**: Copy and store your API key immediately, it's only shown once
|
||||
|
||||
Once created, your API key provides access to your custom API documentation and playground where you can test endpoints with your actual data model.
|
||||
|
||||
|
||||
@@ -29,11 +29,9 @@ We maintain a Zapier integration for users who prefer no-code automation:
|
||||
|
||||
1. Visit <ArticleLink href="https://zapier.com/apps/twenty/integrations">Twenty on Zapier</ArticleLink>
|
||||
2. Create a new Zap with Twenty as trigger or action
|
||||
3. Generate an API key in [Settings → API & Webhooks](/user-guide/section/integrations-api/api-webhooks)
|
||||
3. Generate an API key in Settings → API & Webhooks
|
||||
4. Connect your Twenty workspace to Zapier
|
||||
|
||||
**Note**: We recommend using Workflows for new integrations as they offer more flexibility and control.
|
||||
|
||||
## Future Vision: Community-Built Connectors (2026)
|
||||
|
||||
### Extensibility Platform
|
||||
|
||||
@@ -1,111 +0,0 @@
|
||||
---
|
||||
title: API and Webhooks
|
||||
info: "Learn how to manage API keys and Webhooks in Twenty."
|
||||
icon: IconApi
|
||||
image: /images/user-guide/api/api.png
|
||||
sectionInfo: Learn how to connect Twenty to your other tools.
|
||||
---
|
||||
## Twenty API
|
||||
Twenty offers APIs in **REST and GraphQL**.
|
||||
- Use the **Metadata API** for anything related to your workspace and its data model.
|
||||
- Use the **Core API** for anything related to your records.
|
||||
|
||||
### Your unique APIs
|
||||
Unique APIs are generated for your workspace, to perfectly reflect your custom data model.
|
||||
This means you will have a dedicated endpoint for each of your custom objects and custom fields - which will make the dev experience much nicer!
|
||||
|
||||
|
||||
### Benefits of the GraphQL APIs
|
||||
- **Batch operations** are available with the GraphQL APIs. You just need to use the plural name of your object.
|
||||
*Example*: use the mutation `CreateCompanies` instead of `CreateCompany` for your batch creation.
|
||||
*(This is the reason why the singular and plural names of your object needs to be distinct.)*
|
||||
|
||||
- **Upsert** option is available with the GraphQL APIs.
|
||||
|
||||
|
||||
## API Documentation
|
||||
**Twenty API documentation is accessible under your workspace Settings → APIs & Webhooks.**
|
||||
As unique APIs are generated to perfectly reflect your data model, Twenty creates customized API documentation.
|
||||
This is why you need to input an API key to access it.
|
||||
You will also find a playground where you can test the APIs and the data returned.
|
||||
|
||||
|
||||
## API Keys
|
||||
|
||||
API keys allow automated access to your CRM data, synchronize data with other systems, and create custom integrations or solutions.
|
||||
|
||||
For example, you can use them to retrieve details of a specific `Person` or `Company` record, such as their name or address.
|
||||
|
||||
### Generate an API key
|
||||
|
||||
1. Go to Settings in the sidebar on the left.
|
||||
2. Open **APIs & Webhooks**.
|
||||
3. To generate a new key, click on `+ Create key` at the top right.
|
||||
4. Give your API key a name, an expiration date, and a logo.
|
||||
5. Hit save to see your API key.
|
||||
6. Since the key is only visible once, make sure you store it somewhere safe.
|
||||
|
||||
<ArticleWarning>
|
||||
Since your API key gives access to sensitive information, you shouldn't share it with services you don't fully trust. If leaked, someone can use it maliciously. If your API key's security is compromised, immediately delete it and generate a new one.
|
||||
</ArticleWarning>
|
||||
<div style={{padding:'70.59% 0 0 0', position:'relative', margin: '32px 0px 0px' }}>
|
||||
<iframe
|
||||
src="https://player.vimeo.com/video/928786722?autoplay=1&loop=1&autopause=0&background=1&app_id=58479"
|
||||
frameBorder="0"
|
||||
allow="autoplay; fullscreen; picture-in-picture; clipboard-write"
|
||||
style={{
|
||||
position:'absolute',
|
||||
top:0,
|
||||
left:0,
|
||||
width:'100%',
|
||||
height:'100%',
|
||||
borderRadius: '16px',
|
||||
border:'2px solid black'
|
||||
}}
|
||||
title="Export data"
|
||||
></iframe>
|
||||
</div>
|
||||
<script src="https://player.vimeo.com/api/player.js"></script>
|
||||
|
||||
|
||||
### Regenerating an API key
|
||||
|
||||
To regenerate an API key, click on the key you want to regenerate. You'll then be able to see a button to regenerate the API key.
|
||||
|
||||
## Webhooks
|
||||
|
||||
Webhooks allow for immediate updates to your specified URL about changes or events related to your customer data.
|
||||
|
||||
For instance, a webhook can alert your system in real-time when someone creates a new person record or updates an existing note.
|
||||
|
||||
### Creating Webhooks
|
||||
|
||||
1. From Settings > APIs & Webhooks > Webhooks, click `+` Create webhook.
|
||||
2. Enter your URL.
|
||||
3. Click Save.
|
||||
|
||||
<div style={{padding:'70.59% 0 0 0', position:'relative', margin: '32px 0px 0px'}}>
|
||||
<iframe
|
||||
src="https://player.vimeo.com/video/928786708?autoplay=1&loop=1&autopause=0&background=1&app_id=58479"
|
||||
frameBorder="0"
|
||||
allow="autoplay; fullscreen; picture-in-picture; clipboard-write"
|
||||
style={{
|
||||
position:'absolute',
|
||||
top:0,
|
||||
left:0,
|
||||
width:'100%',
|
||||
height:'100%',
|
||||
borderRadius: '16px',
|
||||
border:'2px solid black'
|
||||
}}
|
||||
title="Export data"
|
||||
></iframe>
|
||||
</div>
|
||||
<script src="https://player.vimeo.com/api/player.js"></script>
|
||||
|
||||
### Deleting Webhooks
|
||||
|
||||
1. In Settings > APIs & Webhooks > Webhooks, find your webhook.
|
||||
2. Click on your webhook and press **Delete** to remove it. A confirmation popup will appear to confirm.
|
||||
|
||||
<ArticleEditContent></ArticleEditContent>
|
||||
@@ -1,76 +0,0 @@
|
||||
---
|
||||
title: Emails
|
||||
info: "Understand the concept of email synchronization in Twenty, including how to read synced emails, connect new mailboxes, and set sharing levels."
|
||||
icon: IconChecklist
|
||||
image: /images/user-guide/emails/emails_header.png
|
||||
sectionInfo: Learn how to connect Twenty to your other tools.
|
||||
---
|
||||
|
||||
## Email Synchronization
|
||||
|
||||
The system links emails from known contacts directly to their CRM records, keeping all communication up to date. It's important to avoid syncing emails from impersonal addresses such as team@ and support@, or from personal email providers like Gmail or Outlook, to ensure privacy and relevance.
|
||||
|
||||
|
||||
### Internal Emails
|
||||
|
||||
Internal emails are emails between two people in the same organization. We consider an email to be internal when every participant shares the same domain: *from*, *to*, *cc* and *bcc*. **Internal emails are not synced to the CRM.**
|
||||
|
||||
If you use a personal email provider like `@gmail.com`, all your emails will be synced to the CRM.
|
||||
|
||||
|
||||
### Reading an Email
|
||||
|
||||
Go to a specific `Person` or `Company` record page, then select the `Emails` tab to view synced emails instantly. Click on an email to open it.
|
||||
|
||||
<img src="/images/user-guide/emails/show-inbox.png" style={{width:'100%'}}/>
|
||||
|
||||
You can customize how you share and manage your emails through the settings.
|
||||
|
||||
## Mailbox Settings
|
||||
|
||||
### Connecting a New Mailbox
|
||||
|
||||
To connect a Gmail mailbox, go to Settings > Accounts, then click the `Add account` button. You can add several mailboxes to your account.
|
||||
|
||||
After connecting a mailbox, visit the `Emails` tab and select the desired mailbox to customize its settings.
|
||||
|
||||
The initial import may take some time, and it will be followed by automatic updates every ten minutes.
|
||||
|
||||
<img src="/images/user-guide/emails/connect-account.png" style={{width:'100%'}}/>
|
||||
|
||||
### Sharing Levels
|
||||
|
||||
From here, you can choose different levels of sharing for outbound and inbound emails:
|
||||
|
||||
- **Metadata Only**: Share only the basic information of the email (sender, recipient, date, and time).
|
||||
- **Subject and Metadata**: Share the subject line of the email along with the metadata.
|
||||
- **All Email Content**: Share the entire content of the email, including attachments.
|
||||
|
||||
<img src="/images/user-guide/emails/privacy-settings.png" style={{width:'100%'}}/>
|
||||
|
||||
### Contacts Auto-Creation
|
||||
|
||||
Contact auto-creation is a handy built-in feature. This default feature automatically adds email contacts not already in your CRM, boosting your contact list without any extra effort on your part. To manage this feature, go to `Settings` > `Email`. You can toggle it on or off. Remember, turning it off means that all new email contacts must be manually entered into the CRM.
|
||||
|
||||
So if you delete a contact from Twenty, it will not be re-imported when receiving a new email from that contact.
|
||||
|
||||
Note that internal emails are not synced to the CRM, so your colleagues won't be automatically created.
|
||||
|
||||
<img src="/images/user-guide/emails/auto-creation.png" style={{width:'100%'}}/>
|
||||
|
||||
### Multiple emails support
|
||||
|
||||
You can add multiple email addresses to each contact, including a primary email and additional ones.
|
||||
When syncing emails and calendar events, they remain linked even if they come from additional email addresses.
|
||||
|
||||
|
||||
Note: For now, we only support linking an email or an event to one contact.
|
||||
If two contacts have the same email: one primary, and one additional, the email will be linked to the primary contact.
|
||||
If two contacts have the same additional email (edge case), the email will be linked to the oldest one.
|
||||
Soft deleted contacts are still linked to the email. Emails and events are rematched only when the contact is destroyed.
|
||||
|
||||
### Upcoming Features
|
||||
|
||||
Soon, you will have the capability to send emails, view attachments, and request access to email content that you're not allowed to read.
|
||||
|
||||
<ArticleEditContent></ArticleEditContent>
|
||||
-53
@@ -1,53 +0,0 @@
|
||||
---
|
||||
title: Getting started with workflows
|
||||
info: "Learn how to add automations in Twenty and how to data in and out."
|
||||
icon: IconNote
|
||||
image: /images/user-guide/create-workspace/workspace-cover.png
|
||||
sectionInfo: Learn how to connect Twenty to your other tools.
|
||||
---
|
||||
## What can I do with workflows?
|
||||
There are two main categories of actions you can automate using the workflows.
|
||||
1. **Automate the busy work within Twenty**: reduce the time spent by your team manually updating their CRM.
|
||||
2. **Bring data in and out of Twenty from your other tools**: forms, product data, enrichment, call recorders, invoicing solution and so on.
|
||||
|
||||
Let's deep dive into a few examples before getting into the how.
|
||||
|
||||
## 1. Automate the busy work
|
||||
Your CRM is only helpful if the data is up to date — but no one likes updating it.
|
||||
Use workflows to automate low-value, repeatable tasks.
|
||||
- Automatically attach the person you've just created with the related Company record.
|
||||
- When an opportunity is moved to `Won`, automatically update the Company tag from `Prospect` to `Customer`, create onboarding Tasks and assign them to the relevant team.
|
||||
- Automatically update the Company tag from `Customer` to `Churned` when the subscription is cancelled.
|
||||
- Send an email alert to the company owner when a key prospect starts engaging with your solution.
|
||||
- Send an email alert to the company owner when a contract comes to an end or engagement drops.
|
||||
|
||||
To do so, you will mainly use the triggers `Create/Update Records` and the actions `Create/Update Records`, `Send Email`.
|
||||
|
||||
|
||||
## 2. Bring data in and out of Twenty
|
||||
If you need to bring data in and out of Twenty from your other tools, let's do this using a workflow.
|
||||
Below are a few examples of what you can build.
|
||||
- Create records from **web forms**: demo requests in real-time, log job applicants, ...
|
||||
- Give your sellers the context they need to be on top of their accounts, bringing **product data** in Twenty
|
||||
- Connect your **call recorder** to automatically create a Note in Twenty with the summary of a meeting and a Task with the action items
|
||||
- Enrich your leads with demographics enrichment to know who your team is talking to
|
||||
- Send the information needed to generate an invoice when a deal is closed
|
||||
|
||||
To do so, you will mainly leverage the ```On a schedule``` and ```Webhook``` triggers, as well as the ```HTTP``` and ```Code``` functions.
|
||||
|
||||
### What if I don't want to build those connections?
|
||||
We offer [Implementation Services](https://twenty.com/implementation-services) to help you create the automations you need.
|
||||
Depending on the scope of you project, we will suggest an [Onboarding pack](https://twenty.com/onboarding-packages) or we will put you in contact with our certified implementation partners. They can create your data model, migrate your data, build your workflows.
|
||||
|
||||
### I'm not sure the connection I need is doable
|
||||
Send us a message and we will help you assess the feasibility.
|
||||
|
||||
## What we're working on
|
||||
Here are the main items we're working on to improve workflows:
|
||||
- If / Else step
|
||||
- Paths
|
||||
- Loops
|
||||
- AI agent to build workflows on your behalf
|
||||
|
||||
|
||||
<ArticleEditContent></ArticleEditContent>
|
||||
@@ -1,45 +0,0 @@
|
||||
---
|
||||
title: Integrations
|
||||
info: "Learn how to connect Twenty to your other tools."
|
||||
icon: IconBrandZapier
|
||||
image: /images/user-guide/integrations/plug.png
|
||||
sectionInfo: Learn how to connect Twenty to your other tools.
|
||||
---
|
||||
|
||||
## About
|
||||
|
||||
Integration with Zapier is available for automating your workflows.
|
||||
|
||||
## Zapier
|
||||
|
||||
Sync Twenty with 3000+ apps using <ArticleLink href="https://zapier.com/apps/twenty/integrations">Zapier</ArticleLink>, and automate your work. Here's how you can connect Twenty to Zapier:
|
||||
|
||||
1. Go to Zapier and log in.
|
||||
2. Click on `+ Create Zap` in the left sidebar.
|
||||
3. Choose the application you want to set as the trigger. A trigger refers to an event that starts the automation.
|
||||
4. Select Twenty as the action. An action is the event performed whenever an application triggers an automation. <ArticleLink href="https://zapier.com/how-it-works">Learn more about triggers and actions in Zapier.</ArticleLink>
|
||||
5. Once you choose the Twenty account that you want to use for your automation, you'll have to allow Zapier to access it by adding an API key. You can learn [how to generate your API key here.](/user-guide/section/integrations/api-webhooks)
|
||||
6. Enter your API key and click on 'Yes, Continue to Twenty.'
|
||||
|
||||
<div style={{padding:'69.01% 0 0 0', position:'relative', margin: '32px 0px 0px'}}>
|
||||
<iframe
|
||||
src="https://player.vimeo.com/video/927913866?autoplay=1&loop=1&autopause=0&background=1&app_id=58479"
|
||||
frameBorder="0"
|
||||
allow="autoplay; fullscreen; picture-in-picture; clipboard-write"
|
||||
style={{
|
||||
position:'absolute',
|
||||
top:0,
|
||||
left:0,
|
||||
width:'100%',
|
||||
height:'100%',
|
||||
borderRadius: '16px',
|
||||
border:'2px solid black'
|
||||
}}
|
||||
title="Export data"
|
||||
></iframe>
|
||||
</div>
|
||||
<script src="https://player.vimeo.com/api/player.js"></script>
|
||||
|
||||
You can now continue creating your automation!
|
||||
|
||||
<ArticleEditContent></ArticleEditContent>
|
||||
@@ -3,5 +3,5 @@ title: Pricing
|
||||
icon: IconChecklist
|
||||
info: Understand how Twenty pricing works.
|
||||
image: /images/user-guide/setup/pricing.png
|
||||
sectionInfo: A brief guide to grasp the basics of Twenty
|
||||
sectionInfo: Your complete guide to Twenty CRM features and best practices.
|
||||
---
|
||||
|
||||
@@ -5,11 +5,23 @@ image: /images/user-guide/setup/pricing.png
|
||||
sectionInfo: Understand how Twenty pricing works.
|
||||
---
|
||||
## Pricing
|
||||
<details>
|
||||
<summary><strong>Can I use Twenty for free while self-hosting?</strong></summary>
|
||||
|
||||
Yes, you can use Twenty for free while self-hosting. You will get access to everything included in the (cloud) Pro subscription, except the support from our core-team. Support is accessible via our Discord community.
|
||||
If you want to self-host and have access to the features included in the (cloud) Organization subscription, including support from our core-team, you can do so by choosing the paid Organization licences, available in self-hosting.
|
||||
|
||||
</details>
|
||||
<details>
|
||||
<summary><strong>Do you offer free seats for view-only users?</strong></summary>
|
||||
|
||||
We do not offer free seats. Pricing is per user and each user needs a licence to access Twenty.
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><strong>Where can I switch my subscription to the Organization plan?</strong></summary>
|
||||
|
||||
You can do so under `Settings > Billing`. Then click on `Switch to Organization`.
|
||||
You can do so under `Settings → Billing`. Then click on `Switch to Organization`.
|
||||
|
||||
</details>
|
||||
|
||||
@@ -23,7 +35,7 @@ Please reach out to our team directly via the Support, there is no easy way to d
|
||||
<details>
|
||||
<summary><strong>Where can I switch my subscription to Yearly?</strong></summary>
|
||||
|
||||
You can do so under `Settings > Billing`. Then click on `Switch to Yearly`.
|
||||
You can do so under `Settings → Billing`. Then click on `Switch to Yearly`.
|
||||
|
||||
</details>
|
||||
|
||||
@@ -37,7 +49,7 @@ Please reach out to our team directly via the Support, there is no easy way to d
|
||||
<details>
|
||||
<summary><strong>Where can I see my credit usage?</strong></summary>
|
||||
|
||||
You will find this under `Settings > Billing`.
|
||||
You will find this under `Settings → Billing`.
|
||||
|
||||
</details>
|
||||
|
||||
@@ -65,7 +77,7 @@ Credits are deducted in real-time when workflows execute. You can monitor your u
|
||||
<details>
|
||||
<summary><strong>Can I buy more workflow credits?</strong></summary>
|
||||
|
||||
You can buy additional credits under `Settings / Billing`.
|
||||
You can buy additional credits under `Settings → Billing`.
|
||||
|
||||
</details>
|
||||
|
||||
@@ -74,28 +86,28 @@ You can buy additional credits under `Settings / Billing`.
|
||||
<details>
|
||||
<summary><strong>Where can I manage the Billing details?</strong></summary>
|
||||
|
||||
You can do so under `Settings > Billing`.
|
||||
You can do so under `Settings → Billing`.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><strong>Where can I update my payment method?</strong></summary>
|
||||
|
||||
You can do so under `Settings > Billing`. Then click on `View billing details`. You'll be able to add a new payment method there.
|
||||
You can do so under `Settings → Billing`. Then click on `View billing details`. You'll be able to add a new payment method there.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><strong>Where can I update my billing information?</strong></summary>
|
||||
|
||||
You can do so under `Settings > Billing`. Then click on `View billing details`. You'll be able to edit the billing information there.
|
||||
You can do so under `Settings → Billing`. Then click on `View billing details`. You'll be able to edit the billing information there.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><strong>Where can I access my invoices?</strong></summary>
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
@@ -3,5 +3,5 @@ title: Reporting
|
||||
icon: IconChart
|
||||
info: Track performance with custom reports and dashboards. Coming Q4 2025
|
||||
image: /images/user-guide/reporting/reporting.png
|
||||
sectionInfo: Track performance with custom reports and dashboards
|
||||
sectionInfo: Your complete guide to Twenty CRM features and best practices.
|
||||
---
|
||||
|
||||
@@ -3,5 +3,5 @@ title: Resources
|
||||
icon: IconHelp
|
||||
info: Terminology definitions and community links.
|
||||
image: /images/user-guide/glossary/glossary.png
|
||||
sectionInfo: Terminology resources and community information
|
||||
sectionInfo: Your complete guide to Twenty CRM features and best practices.
|
||||
---
|
||||
@@ -10,7 +10,7 @@ sectionInfo: Terminology resources and community information
|
||||
API (Application Programming Interface) allows you to connect Twenty with other software systems and build custom integrations.
|
||||
|
||||
## Command Menu
|
||||
The Command Menu is a quick-access interface (opened with Cmd/Ctrl + K) that lets you perform actions, create records, and navigate your workspace efficiently.
|
||||
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:
|
||||
|
||||
@@ -3,5 +3,5 @@ title: Settings
|
||||
icon: IconSettings2
|
||||
info: Configure your Twenty workspace settings and preferences.
|
||||
image: /images/user-guide/setup/settings.png
|
||||
sectionInfo: Configure your Twenty workspace settings and preferences
|
||||
sectionInfo: Your complete guide to Twenty CRM features and best practices.
|
||||
---
|
||||
@@ -19,7 +19,7 @@ sectionInfo: Configure your Twenty workspace settings and preferences
|
||||
Just delete the workspaces you no longer need, you can do so under `Settings → Workspace Settings`.
|
||||
|
||||
<ArticleWarning>
|
||||
Do not delete your account (accessible under Settings → Profile Settings) — your account is shared among the different workspaces.
|
||||
Do not delete your account (accessible under Settings → Profile Settings): your account is shared among the different workspaces.
|
||||
</ArticleWarning>
|
||||
</details>
|
||||
|
||||
|
||||
@@ -3,5 +3,5 @@ title: Workflows
|
||||
icon: IconSettings
|
||||
info: Automate processes and integrate with external tools.
|
||||
image: /images/user-guide/workflows/workflow.png
|
||||
sectionInfo: Automate processes and integrate with external tools
|
||||
sectionInfo: Your complete guide to Twenty CRM features and best practices.
|
||||
---
|
||||
|
||||
+2
-2
@@ -23,7 +23,7 @@ Let's explore examples of what's possible before diving into the how.
|
||||
|
||||
## 1. Internal Automations
|
||||
|
||||
Your CRM is only helpful if the data is up to date — but no one likes updating it. Use workflows to automate low-value, repeatable tasks and keep your team focused on what matters.
|
||||
Your CRM is only helpful if the data is up to date, but no one likes updating it. Use workflows to automate low-value, repeatable tasks and keep your team focused on what matters.
|
||||
|
||||
Examples of what you can automate internally:
|
||||
- **Data management**: Auto-flag personal emails, lead assignment, data validation
|
||||
@@ -58,7 +58,7 @@ As you start building workflows, keep these tips in mind:
|
||||
- **Leverage previous step data**: You can use fields from records returned by any previous step in your workflow
|
||||
- **Start simple**: Begin with basic workflows and add complexity over time as you become more comfortable with the system
|
||||
- **Plan before building**: Map out your workflow logic before you start building to avoid getting stuck halfway through
|
||||
- **Use branches wisely**: After a "Search Records" step, create branches to handle both "update existing record" and "create new record" scenarios, then merge the paths back together
|
||||
- **Use branches wisely**: After a `Search Records` step, create branches to handle both "update existing record" and "create new record" scenarios, then merge the paths back together
|
||||
|
||||
|
||||
## What we're working on
|
||||
|
||||
@@ -20,9 +20,9 @@ Consider professional services for:
|
||||
|
||||
### Onboarding Packs
|
||||
Get help from our core team with our 4-hour [Onboarding packs](https://twenty.com/onboarding-packages):
|
||||
- **Workflow Creation** - Build custom workflows for your business processes
|
||||
- **Data Model Design** - Optimize your data structure for workflow automation
|
||||
- **Data Migration** - Import existing data with proper workflow integration
|
||||
- **Workflow Creation**: Build custom workflows for your business processes
|
||||
- **Data Model Design**: Optimize your data structure for workflow automation
|
||||
- **Data Migration**: Import existing data with proper workflow integration
|
||||
|
||||
### Implementation Partners
|
||||
Work with certified partners for advanced customizations. Contact us at contact@twenty.com to connect with our [implementation partners](https://twenty.com/implementation-services).
|
||||
|
||||
@@ -65,7 +65,7 @@ If you need more credits beyond your plan allocation:
|
||||
- **Minimize HTTP Requests**: Use efficient search criteria and combine operations where possible
|
||||
- **Batch Processing**: Use bulk operations and Iterator actions efficiently
|
||||
- **Error Handling**: Implement proper error handling to prevent unnecessary retries
|
||||
- **Manual Trigger Optimization**: For manual triggers, choose "Bulk" availability to process multiple records in a single workflow run (see [Workflow Features](/user-guide/section/workflows/workflow-features) for details)
|
||||
- **Manual Trigger Optimization**: For manual triggers, choose `Bulk` availability to process multiple records in a single workflow run (see [Workflow Features](/user-guide/section/workflows/workflow-features) for details)
|
||||
|
||||
### Action Optimization
|
||||
- Use basic internal operations when possible (lower credit consumption)
|
||||
|
||||
+8
-6
@@ -39,7 +39,7 @@ Forms are currently designed for manual triggers only. For workflows with other
|
||||
|
||||
**Common Causes & Solutions**:
|
||||
- **Inefficient API Calls**: Batch API calls when possible instead of individual requests
|
||||
- **Wrong Manual Trigger Configuration**: Use "Bulk" availability instead of "Single" to process multiple records in one workflow run
|
||||
- **Wrong Manual Trigger Configuration**: Use `Bulk` availability instead of `Single` to process multiple records in one workflow run
|
||||
- **Missing Filters**: Add conditional logic to stop workflows when criteria aren't met
|
||||
- **Unnecessary Steps**: Remove redundant actions and optimize workflow logic
|
||||
- **Real-time vs. Scheduled**: Use scheduled workflows for non-urgent processes
|
||||
@@ -52,7 +52,7 @@ You cannot run more than 100 workflows in parallel at any given time per workspa
|
||||
</ArticleWarning>
|
||||
|
||||
**Solutions**:
|
||||
- Use "Bulk" availability for manual triggers to process multiple records in one run
|
||||
- Use `Bulk` availability for manual triggers to process multiple records in one run
|
||||
- Implement delays between workflow executions using scheduled triggers
|
||||
- Optimize workflows to run faster and reduce concurrent execution time
|
||||
- Consider batch processing during off-peak hours
|
||||
@@ -70,21 +70,23 @@ You cannot run more than 100 workflows in parallel at any given time per workspa
|
||||
**Problem**: Iterator actions not working as expected.
|
||||
|
||||
**Solutions**:
|
||||
- **Note**: Iterator is currently in beta. Activate it under Settings > Releases > Lab
|
||||
- **Note**: Iterator is currently in beta. Activate it under Settings → Releases → Lab
|
||||
- Verify the input is an array of records from a previous step
|
||||
- Check that actions within the Iterator are properly configured
|
||||
- Use Iterator with "Bulk" manual triggers for optimal performance
|
||||
- Use Iterator with `Bulk` manual triggers for optimal performance
|
||||
|
||||
### Missing Permissions
|
||||
**Problem**: Cannot access workflows section.
|
||||
|
||||
**Note**: If you don't see the Workflows section, this is due to a permissions issue. Contact your workspace administrator to grant you access to workflows.
|
||||
<ArticleWarning>
|
||||
If you don't see the Workflows section, this is due to a permissions issue. Contact your workspace administrator to grant you access to workflows.
|
||||
</ArticleWarning>
|
||||
|
||||
## Optimization Tips
|
||||
|
||||
### Performance Best Practices
|
||||
- **Start simple** and add complexity gradually
|
||||
- **Use "Bulk" availability** for manual triggers to process multiple records efficiently
|
||||
- **Use `Bulk` availability** for manual triggers to process multiple records efficiently
|
||||
- **Add filters early** to stop workflows when criteria aren't met
|
||||
- **Batch API calls** and use scheduled workflows for non-urgent processes
|
||||
- **Hide workflow runs** from pages showing all workflows to improve loading performance
|
||||
|
||||
Reference in New Issue
Block a user