Activepieces Quick Start
- - Design reusable flows around one clear automation outcome.
- - Follow TypeScript best practices for custom pieces.
- - Keep cloud and self-hosted compatibility in mind.
- - Test with realistic data, edge cases, and failure paths.
General Submission Guidelines
Quality Standards
- Clear purpose: Solve one recognizable business problem and make the expected outcome obvious.
- Production ready: Test with realistic data, document required accounts, and include recovery paths for failures.
- No secrets: Never ship API keys, passwords, bearer tokens, private URLs, customer data, or environment-specific IDs.
- Original work: Submit only original templates or properly licensed open-source work with attribution.
- Reusability: Design flows so users can adapt them without rewriting core logic.
- Compatibility: Avoid assumptions that only work in one hosted environment.
Flow Development
- Logical order: Arrange pieces in a clear trigger, process, branch, action sequence.
- Validation: Validate user input and mapped fields before making external API calls.
- Fallbacks: Include error handling and recovery paths for common API failures.
Custom Pieces
- Type safety: Use TypeScript types and interfaces for inputs, outputs, and API responses.
- Naming: Use camelCase for variables, PascalCase for types, and kebab-case for file names.
- Authentication: Document required auth configuration and avoid embedded credentials.
Documentation Structure
- Overview: Explain what the automation does and who it is for in plain language.
- Prerequisites: List required accounts, scopes, credentials, API access, paid plans, and sample data.
- Setup: Give ordered setup steps that match the imported template or component exactly.
- Customization: Show the fields users are expected to change and explain safe defaults.
- Troubleshooting: Document common failures, rate limits, permission errors, and validation issues.