Abdul RahmanandGitHub
9f97be67b1
## Summary Completes the migration of all documentation from twenty-website to a new Mintlify-powered documentation site at docs.twenty.com. ## Changes Made ### New Package: `twenty-docs` - ✅ Created new Mintlify documentation package - ✅ Migrated 95 content pages (user-guide, developers, twenty-ui) - ✅ Migrated 81 images - ✅ Converted all custom components to Mintlify native components - ✅ Configured navigation with 2 tabs and 94 pages - ✅ Added Helper AI Agent with searchArticles tool for docs search ### Updated: `twenty-website` - ✅ Added 11 redirect rules (301 permanent) in next.config.js - ✅ Removed all documentation content (111 files) - ✅ Removed documentation routes (user-guide, developers, twenty-ui) - ✅ Removed documentation components (9 files) - ✅ Updated keystatic.config.ts - ✅ Preserved all marketing/release pages ### Updated: Core Files - ✅ Updated README.md - docs links point to docs.twenty.com - ✅ Updated CONTRIBUTING.md - code quality link updated - ✅ Updated SupportDropdown.tsx - user guide link updated - ✅ Updated Footer.tsx - user guide link updated
88 lines
3.5 KiB
Plaintext
88 lines
3.5 KiB
Plaintext
---
|
|
title: Workflow Credits
|
|
info: Understand workflow credit consumption, monitoring, and cost management for your automations.
|
|
image: /images/user-guide/workflows/workflow-credits.png
|
|
sectionInfo: Automate processes and integrate with external tools
|
|
---
|
|
<Frame>
|
|
<img src="/images/user-guide/workflows/workflow-credits.png" alt="Header" />
|
|
</Frame>
|
|
|
|
Workflow credits power your automations in Twenty. Understanding how they work helps you optimize costs and manage your automation budget effectively.
|
|
|
|
## Credit Allocation by Plan
|
|
|
|
Workflow credits are allocated per workspace based on your subscription plan:
|
|
|
|
- **Trial**: 5 million credits
|
|
- **Pro Plan**: 10 million credits per month
|
|
- **Organization Plan**: 20 million credits per month
|
|
|
|
## How Credit Consumption Works
|
|
|
|
Credits are consumed when workflows execute, not when you create them. Each workflow action consumes credits based on its complexity:
|
|
|
|
### Credit Consumption by Action Type
|
|
|
|
- **Basic internal operations**: Very low credit consumption
|
|
- Search Records
|
|
- Create Record
|
|
- Update Record
|
|
- Delete Record
|
|
- Form actions
|
|
|
|
- **Complex operations**: Higher credit consumption
|
|
- Code actions (JavaScript execution)
|
|
- HTTP Requests to external services
|
|
|
|
|
|
- **AI features**: Significant credit consumption (coming soon)
|
|
- AI prompts and processing will consume credits based on usage
|
|
|
|
### Real-Time Deduction
|
|
|
|
Credits are deducted in real-time as workflows execute. This means:
|
|
- Draft workflows don't consume credits
|
|
- Only active, running workflows use your credit allocation
|
|
- Failed workflows still consume credits for completed steps
|
|
|
|
## Managing Credits
|
|
|
|
### Check Credit Usage
|
|
1. Go to **Settings → Billing**
|
|
2. View your current credit consumption and remaining balance
|
|
3. Monitor usage patterns to optimize your workflows
|
|
|
|
### Purchasing Additional Credits
|
|
If you need more credits beyond your plan allocation:
|
|
1. Go to **Settings → Billing**
|
|
2. Click on the option to purchase additional credits. Packages of different sizes are available.
|
|
3. Credits are added to your current balance
|
|
|
|
## Best Practices
|
|
|
|
### Efficient Workflow Design
|
|
- **Start Simple**: Begin with basic actions and add complexity gradually
|
|
- **Test in Draft**: Thoroughly test workflows before activation to avoid wasting credits on errors
|
|
- **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/workflows/workflow-features) for details)
|
|
|
|
### Action Optimization
|
|
- Use basic internal operations when possible (lower credit consumption)
|
|
- Optimize Code actions for efficiency
|
|
- Consider manual triggers for non-urgent processes
|
|
- Batch operations to reduce individual action calls
|
|
|
|
### Credit Management
|
|
- **Regular Monitoring**: Check your credit usage weekly in Settings → Billing
|
|
- **Usage Tracking**: Keep track of consumption patterns to avoid unexpected overages
|
|
- **Plan Accordingly**: Consider upgrading your plan if you consistently need more credits
|
|
- **Workflow Review**: Regularly review high-consumption workflows and deactivate unused ones
|
|
- **Strategic Planning**: Plan workflow deployment based on credit availability
|
|
|
|
For detailed billing information and credit management, visit **Settings → Billing** in your Twenty workspace.
|
|
|
|
|