mirror of
https://github.com/twentyhq/twenty
synced 2026-04-21 21:47:38 +00:00
183d034716
Reorganizing by Feature sections
Capabilities folders to give an overview of each feature
How-Tos folders to give guidance for advanced customizations
Reorganized the Developers section as well, moving the API sub section
there
added some new visuals and videos to illustrate the How-Tos articles
checked the typos, the links and added a section at the end of the
doc.json file to redirect existing links to the new ones (SEO purpose +
continuity of the user experience)
What I have not updated is the "l" folder that, per my understanding,
contains the translation of the User Guide - that I only edited in
English
<!-- CURSOR_SUMMARY -->
---
> [!NOTE]
> <sup>[Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) is
generating a summary for commit
5301502a32. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->
---------
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
Co-authored-by: github-actions <github-actions@twenty.com>
Co-authored-by: Abdul Rahman <ar5438376@gmail.com>
Co-authored-by: Félix Malfait <felix.malfait@gmail.com>
76 lines
3.3 KiB
Text
76 lines
3.3 KiB
Text
---
|
|
title: Workflows
|
|
description: Learn how to build automations in Twenty.
|
|
image: /images/user-guide/workflows/workflow.png
|
|
---
|
|
|
|
<Frame>
|
|
<img src="/images/user-guide/workflows/workflow.png" alt="Workflows" />
|
|
</Frame>
|
|
|
|
## Why Workflows Matter
|
|
|
|
Twenty was built to bring maximum flexibility to its users. Rather than forcing you to adapt your business processes to rigid, pre-built features, workflows enable you to build automations that create the CRM that best supports your unique business use cases.
|
|
|
|
Workflows are Twenty's in-app feature for building these automations. They give you the building blocks to create exactly what your business needs, when it needs it.
|
|
|
|
## What can I do with workflows?
|
|
|
|
We recommend building automations for two main purposes:
|
|
|
|
1. **Internal automations to facilitate your team's day-to-day**: Reduce the amount of manual entries and repetitive tasks that slow down your team.
|
|
2. **Bring data in and out of Twenty**: Connect Twenty via API calls and webhooks to your database and other tools.
|
|
|
|
## Building Your First Workflow
|
|
|
|
### Step 1: Create a New Workflow
|
|
1. Go to **Workflows** accessible below the other objects
|
|
2. Click **+ New Record**
|
|
3. Give your workflow a name
|
|
|
|
### Step 2: Add a Trigger
|
|
Every workflow starts with a trigger. Choose from:
|
|
- **Record events**: When a record is created, updated, or deleted
|
|
- **Schedule**: Run at specific times (daily, weekly, etc.)
|
|
- **Manual**: Triggered by a user action
|
|
- **Webhook**: Triggered by a webhook
|
|
|
|
<img src="/images/user-guide/workflows/workflow_triggers.png" style={{width:'100%'}}/>
|
|
|
|
### Step 3: Add Actions
|
|
After your trigger, add one or more actions:
|
|
- **Create Record**: Add new records to any object
|
|
- **Update Record**: Modify existing record data
|
|
- **Delete Record**: Remove records from objects
|
|
- **Search Records**: Find records matching criteria
|
|
- **Upsert Record**: Create or update based on matching criteria
|
|
- **Iterator**: Loop through arrays of records
|
|
- **Filter**: Control which records proceed
|
|
- **Delay**: Wait before continuing (duration or scheduled date)
|
|
- **Send Email**: Send emails via your connected account
|
|
- **Code**: Run custom JavaScript
|
|
- **HTTP Request**: Call external APIs
|
|
- **Form**: Get inputs from users within Twenty UI at the time of execution
|
|
- **AI Agent** (Coming soon): Run intelligent AI tasks
|
|
|
|
<img src="/images/user-guide/workflows/workflow_actions.png" style={{width:'100%'}}/>
|
|
|
|
|
|
### Step 4: Test and Activate
|
|
1. Use the **Test** button to run your workflow with sample data
|
|
2. Review the results to ensure it works as expected
|
|
3. Toggle the workflow **Active** when ready
|
|
|
|
## Workflow Best Practices
|
|
|
|
- **Edit step names**: Rename your workflow steps to clearly describe what each one does. This helps with maintenance and makes it easier to hand off to coworkers
|
|
- **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
|
|
|
|
|
|
## Next Steps
|
|
|
|
- [Workflow Triggers](/user-guide/workflows/capabilities/workflow-triggers)
|
|
- [Workflow Actions](/user-guide/workflows/capabilities/workflow-actions)
|
|
- [CRM Automations](/user-guide/workflows/how-tos/crm-automations/closed-won-automations)
|