Activepieces

Docs

• Changelog: A log of all notable changes to Activepieces
• i18n Translations
• License
• Event Streaming: Forward audit events to a webhook and build fully customizable alerts on top
• Manage Concurrency: Control how many flows can run at the same time per project
• Override OAuth2 Apps: Use your own OAuth2 credentials instead of the default Activepieces apps
• How to Manage Pieces: Control which integrations are available to your users
• Manage User Roles: Documentation on project permissions in Activepieces
• Project Releases: Learn how to manage and deploy releases across projects
• SCIM Overview: Automate user lifecycle management with SCIM in Activepieces.
• SCIM with Okta: Configure SCIM provisioning from Okta to Activepieces.
• AWS Secrets Manager: Connect AWS Secrets Manager to Activepieces for centralized secret management
• CyberArk Conjur: Connect CyberArk Conjur to Activepieces for centralized secret management
• HashiCorp Vault: Connect HashiCorp Vault to Activepieces for enterprise-grade secret management
• 1Password: Connect 1Password to Activepieces for centralized secret management
• Overview: Connect external secret management systems to securely store and retrieve credentials
• Setup AI Providers
• How to Setup SSO: Configure Single Sign-On (SSO) to enable secure, centralized authentication for your Activepieces platform
• How to Structure Projects
• Connection Deleted
• Connection Upserted
• Flow Activated
• Flow Created
• Flow Deactivated
• Flow Deleted
• Flow Published
• Flow Run Finished
• Flow Run Started
• Flow Updated
• Folder Created
• Folder Deleted
• Folder Updated
• Overview: Track every action on your platform and forward events to your tools
• Signing Key Created
• User Email Verified
• User Password Reset
• User Signed In
• User Signed Up
• Security & Data Practices: We prioritize security and follow these practices to keep information safe.
• Create Action
• Create Trigger
• Development setup
• Overview: This section helps developers build and contribute pieces.
• Add Piece Authentication
• Create Piece Definition
• Fork Repository
• Start Building
• Build Custom Pieces
• GitHub Codespaces
• Dev Containers
• Migrate from Nx to Turbo
• Custom Pieces CI/CD
• Setup Private Fork
• Publish Custom Pieces
• Testing Pieces: How to add unit tests to your pieces
• Piece Auth: Learn about piece authentication
• Enable Custom API Calls: Learn how to enable custom API calls for your pieces
• Piece Examples: Explore a collection of example triggers and actions
• External Libraries: Learn how to install and use external libraries.
• Files: Learn how to use files object to create file references.
• Flow Control: Learn how to control flow execution from inside a piece
• Piece i18n: Learn about translating pieces to multiple locales
• Persistent Storage: Learn how to store and retrieve data from a key-value store
• Piece versioning: How to choose a version number when publishing a piece
• Props: Learn about different types of properties used in triggers / actions
• Props Validation: Learn about different types of properties validation
• Overview
• Polling Trigger: Periodically call endpoints to check for changes
• Webhook Trigger: Listen to user events through a single URL
• Community (Public NPM): Learn how to publish your piece to the community.
• Contribute: Learn how to contribute a piece to the main repository.
• Overview: Learn the different ways to publish your own piece on activepieces.
• Private: Learn how to share your pieces privately.
• Configure Embedding: Set up your platform before provisioning users
• Show/Hide Pieces
• Embed Builder
• Create/Update Connections
• Navigation
• Overview: Understanding how embedding works
• Predefined Connection
• Provision Users: Automatically authenticate your SaaS users to your Activepieces instance
• SDK Changelog: A log of all notable changes to Activepieces SDK
• API Requests: Send requests to your Activepieces instance from the embedded app
• Delete Connection: Delete an app connection
• List Connections: List app connections
• Connection Schema
• Upsert Connection: Upsert an app connection based on the app name
• Add allowed embed origins: Add origins to the list allowed to embed this platform in an iframe. Existing origins are preserved; duplicates are ignored.
• Get Flow Run: Get Flow Run
• List Flows Runs: List Flow Runs
• Flow Run Schema
• Create Flow: Create a flow
• Delete Flow: Delete a flow
• Get Flow: Get a flow by id
• List Flows: List flows
• Flow Schema
• Apply Flow Operation: Apply an operation to a flow
• Create Folder: Create a new folder
• Delete Folder: Delete a folder
• Get Folder: Get a folder by id
• List Folders: List folders
• Folder Schema
• Update Folder: Update an existing folder
• Configure: Upsert a git repository information for a project.
• Git Repos Schema
• Delete Global Connection
• List Global Connections
• Global Connection Schema
• Update Global Connection
• Upsert Global Connection
• Overview
• Install Piece: Add a piece to a platform
• Piece Schema
• Delete Project Member
• List Project Member
• Project Member Schema
• Create Project Release
• Project Release Schema
• Create Project
• Delete Project
• List Projects
• Project Schema
• Update Project
• Get Sample Data
• Create Template: Create a template.
• Delete Template: Delete a template.
• Get Template: Get a template.
• List Templates: List templates.
• Template Schema
• Delete User Invitation
• List User Invitations
• User Invitation Schema
• Send User Invitation (Upsert): Send a user invitation to a user. If the user already has an invitation, the invitation will be updated.
• Delete User: Delete user
• List Users: List users
• User Schema
• Update User: Update user
• Queue Metrics
• Building Flows: Flow consists of two parts, trigger and actions
• Debugging Runs: Ensuring your business automations are running properly
• Data Manipulation Functions: Every data manipulation function, grouped by category
• Technical Limits: Limits enforced on Activepieces Cloud, with self-hosted overrides
• Passing Data: Using data from previous steps in the current one
• Publishing Flows: Make your flow work by publishing your updates
• Data Manipulation: Transform and combine data inside any text input using data manipulation
• Version History: Learn how flow versioning works in Activepieces
• How to handle Requests
• Overview
• How to use Pylon: Guide for using Pylon to manage customer support tickets
• Tone & Communication
• Handling Downtime
• Engineering Workflow
• On-Call
• Onboarding Check List
• Release Cycle
• Stack & Tools
• Overview
• AI Engineering Guide
• Canary Deployment
• Connect Claude to Chrome
• Database Migrations: Guide for creating database migrations in Activepieces
• E2E Tests
• Frontend Best Practices
• Cloud Infrastructure
• Feature Announcement
• Releases & Deployment
• Run Enterprise Edition
• Security Advisory Response: Internal lifecycle for handling security reports from intake to public disclosure
• Setup BetterStack
• Testing Strategy: Canonical 4-layer testing taxonomy for Activepieces
• Infrastructure Upgrade — Mar 16–17, 2026
• Delay Step Infinite Loop — Mar 19, 2026
• Redis QueueEvents Overload — Mar 20, 2026
• Our Compensation
• Our Hiring Process
• Our Roles & Levels
• Our Team Structure
• Activepieces Handbook
• Interface Design
• Teams
• Benchmark
• Durable Execution
• Network Security: How Activepieces isolates outbound traffic from your internal network
• Overview
• Piece syncing & versioning: How pieces are packaged, distributed, and pinned to flow versions
• Sandboxing: Choose the right isolation mode for running flow code
• Waitpoints
• Workers: Run, scale, and tune the container that executes your flows
• Breaking Changes: This list shows all versions that include breaking changes and how to upgrade.
• Environment Variables
• Hardware Requirements: Specifications for hosting Activepieces
• Deployment Checklist: Checklist to follow after deploying Activepieces
• Telemetry
• Rollback Guide: How to rollback Activepieces to a previous version
• How to Separate Workers
• How to Setup App Webhooks
• How to Setup OpenTelemetry: Configure OpenTelemetry for observability and tracing
• How to Setup S3: Configure S3-compatible storage for files and run logs
• Setup HTTPS
• AWS (Pulumi): Get Activepieces up & running on AWS with Pulumi for IaC
• Docker: Single docker image deployment with PGLite and Memory Queue
• Docker Compose
• Easypanel: Run Activepieces with Easypanel 1-Click Install
• Elestio: Run Activepieces with Elestio 1-Click Install
• GCP
• Helm: Deploy Activepieces on Kubernetes using Helm
• Railway: Deploy Activepieces to the cloud in minutes using Railway's one-click template
• Overview: Introduction to the different ways to install Activepieces
• Queues Dashboard
• Reset Password: How to reset your password on a self-hosted instance
• Truncated Logs: Understanding and resolving truncated flow run logs
• Websocket Issues: Troubleshoot websocket connection problems
• MCP Server: Connect AI assistants to Activepieces using the Model Context Protocol (MCP)
• Tools Reference: Complete catalog of all MCP tools available in Activepieces
• Welcome: Your friendliest open source all-in-one automation tool, designed to be extensible.

OpenAPI Specs

• openapi