# Table of Contents - [Welcome - Activepieces](#welcome-activepieces) - [License - Activepieces](#license-activepieces) - [Setup AI Providers - Activepieces](#setup-ai-providers-activepieces) - [Overview - Activepieces](#overview-activepieces) - [How to Setup SSO - Activepieces](#how-to-setup-sso-activepieces) - [Override OAuth2 Apps - Activepieces](#override-oauth2-apps-activepieces) - [How to Manage Pieces - Activepieces](#how-to-manage-pieces-activepieces) - [i18n Translations - Activepieces](#i18n-translations-activepieces) - [SCIM Overview - Activepieces](#scim-overview-activepieces) - [Manage User Roles - Activepieces](#manage-user-roles-activepieces) - [Event Streaming - Activepieces](#event-streaming-activepieces) - [Changelog - Activepieces](#changelog-activepieces) - [SCIM with Okta - Activepieces](#scim-with-okta-activepieces) - [Project Releases - Activepieces](#project-releases-activepieces) - [AWS Secrets Manager - Activepieces](#aws-secrets-manager-activepieces) - [HashiCorp Vault - Activepieces](#hashicorp-vault-activepieces) - [How to Structure Projects - Activepieces](#how-to-structure-projects-activepieces) - [CyberArk Conjur - Activepieces](#cyberark-conjur-activepieces) - [1Password - Activepieces](#1password-activepieces) - [Flow Created - Activepieces](#flow-created-activepieces) - [List Connections - Activepieces](#list-connections-activepieces) - [Connection Schema - Activepieces](#connection-schema-activepieces) - [Upsert Connection - Activepieces](#upsert-connection-activepieces) - [Get Flow Run - Activepieces](#get-flow-run-activepieces) - [Security & Data Practices - Activepieces](#security-data-practices-activepieces) - [Queue Metrics - Activepieces](#queue-metrics-activepieces) - [List Project Member - Activepieces](#list-project-member-activepieces) - [Create/Update Connections - Activepieces](#create-update-connections-activepieces) - [Update Global Connection - Activepieces](#update-global-connection-activepieces) - [Flow Run Started - Activepieces](#flow-run-started-activepieces) - [Flow Deleted - Activepieces](#flow-deleted-activepieces) - [Connection Upserted - Activepieces](#connection-upserted-activepieces) - [Delete User Invitation - Activepieces](#delete-user-invitation-activepieces) - [Overview - Activepieces](#overview-activepieces) - [Overview - Activepieces](#overview-activepieces) - [Delete Global Connection - Activepieces](#delete-global-connection-activepieces) - [Flow Run Finished - Activepieces](#flow-run-finished-activepieces) - [List Projects - Activepieces](#list-projects-activepieces) - [Folder Created - Activepieces](#folder-created-activepieces) - [Get Folder - Activepieces](#get-folder-activepieces) - [List Templates - Activepieces](#list-templates-activepieces) - [Delete Connection - Activepieces](#delete-connection-activepieces) - [User Invitation Schema - Activepieces](#user-invitation-schema-activepieces) - [Show/Hide Pieces - Activepieces](#show-hide-pieces-activepieces) - [Create Folder - Activepieces](#create-folder-activepieces) - [Git Repos Schema - Activepieces](#git-repos-schema-activepieces) - [Overview - Activepieces](#overview-activepieces) - [Install Piece - Activepieces](#install-piece-activepieces) - [Delete Folder - Activepieces](#delete-folder-activepieces) - [List Folders - Activepieces](#list-folders-activepieces) - [Predefined Connection - Activepieces](#predefined-connection-activepieces) - [Delete Project Member - Activepieces](#delete-project-member-activepieces) - [Project Release Schema - Activepieces](#project-release-schema-activepieces) - [Template Schema - Activepieces](#template-schema-activepieces) - [Flow Run Schema - Activepieces](#flow-run-schema-activepieces) - [API Requests - Activepieces](#api-requests-activepieces) - [Connection Deleted - Activepieces](#connection-deleted-activepieces) - [Folder Updated - Activepieces](#folder-updated-activepieces) - [List Flows Runs - Activepieces](#list-flows-runs-activepieces) - [Overview - Activepieces](#overview-activepieces) - [Signing Key Created - Activepieces](#signing-key-created-activepieces) - [SDK Changelog - Activepieces](#sdk-changelog-activepieces) - [Embed Builder - Activepieces](#embed-builder-activepieces) - [Delete Flow - Activepieces](#delete-flow-activepieces) - [Folder Schema - Activepieces](#folder-schema-activepieces) - [Folder Deleted - Activepieces](#folder-deleted-activepieces) - [Delete Template - Activepieces](#delete-template-activepieces) - [Navigation - Activepieces](#navigation-activepieces) - [Delete Project - Activepieces](#delete-project-activepieces) - [Project Member Schema - Activepieces](#project-member-schema-activepieces) - [Configure - Activepieces](#configure-activepieces) - [Create Project Release - Activepieces](#create-project-release-activepieces) - [Get Flow - Activepieces](#get-flow-activepieces) - [Get Template - Activepieces](#get-template-activepieces) - [Get Sample Data - Activepieces](#get-sample-data-activepieces) - [Building Flows - Activepieces](#building-flows-activepieces) - [Flow Schema - Activepieces](#flow-schema-activepieces) - [Create Flow - Activepieces](#create-flow-activepieces) - [User Signed Up - Activepieces](#user-signed-up-activepieces) - [Global Connection Schema - Activepieces](#global-connection-schema-activepieces) - [Apply Flow Operation - Activepieces](#apply-flow-operation-activepieces) - [List Flows - Activepieces](#list-flows-activepieces) - [Delete User - Activepieces](#delete-user-activepieces) - [Project Schema - Activepieces](#project-schema-activepieces) - [Create Template - Activepieces](#create-template-activepieces) - [Flow Updated - Activepieces](#flow-updated-activepieces) - [User Signed In - Activepieces](#user-signed-in-activepieces) - [Debugging Runs - Activepieces](#debugging-runs-activepieces) - [Update Folder - Activepieces](#update-folder-activepieces) - [User Schema - Activepieces](#user-schema-activepieces) - [List Users - Activepieces](#list-users-activepieces) - [Create Project - Activepieces](#create-project-activepieces) - [Send User Invitation (Upsert) - Activepieces](#send-user-invitation-upsert-activepieces) - [Update User - Activepieces](#update-user-activepieces) - [List User Invitations - Activepieces](#list-user-invitations-activepieces) - [List Global Connections - Activepieces](#list-global-connections-activepieces) - [User Email Verified - Activepieces](#user-email-verified-activepieces) - [Development setup - Activepieces](#development-setup-activepieces) - [Create Piece Definition - Activepieces](#create-piece-definition-activepieces) - [Add Piece Authentication - Activepieces](#add-piece-authentication-activepieces) - [User Password Reset - Activepieces](#user-password-reset-activepieces) - [GitHub Codespaces - Activepieces](#github-codespaces-activepieces) - [Start Building - Activepieces](#start-building-activepieces) - [Version History - Activepieces](#version-history-activepieces) - [Update Project - Activepieces](#update-project-activepieces) - [Upsert Global Connection - Activepieces](#upsert-global-connection-activepieces) - [Community (Public NPM) - Activepieces](#community-public-npm-activepieces) - [Dev Containers - Activepieces](#dev-containers-activepieces) - [Passing Data - Activepieces](#passing-data-activepieces) - [External Libraries - Activepieces](#external-libraries-activepieces) - [Fork Repository - Activepieces](#fork-repository-activepieces) - [Technical Limits - Activepieces](#technical-limits-activepieces) - [Publishing Flows - Activepieces](#publishing-flows-activepieces) - [Build Custom Pieces - Activepieces](#build-custom-pieces-activepieces) - [Piece Examples - Activepieces](#piece-examples-activepieces) - [Provision Users - Activepieces](#provision-users-activepieces) - [Migrate from Nx to Turbo - Activepieces](#migrate-from-nx-to-turbo-activepieces) - [Piece Schema - Activepieces](#piece-schema-activepieces) - [Publish Custom Pieces - Activepieces](#publish-custom-pieces-activepieces) - [Custom Pieces CI/CD - Activepieces](#custom-pieces-ci-cd-activepieces) - [Flow Control - Activepieces](#flow-control-activepieces) - [Welcome - Activepieces](#welcome-activepieces) - [Enable Custom API Calls - Activepieces](#enable-custom-api-calls-activepieces) - [Setup Private Fork - Activepieces](#setup-private-fork-activepieces) - [Testing Pieces - Activepieces](#testing-pieces-activepieces) - [Files - Activepieces](#files-activepieces) - [Piece i18n - Activepieces](#piece-i18n-activepieces) - [Piece Versioning - Activepieces](#piece-versioning-activepieces) - [Persistent Storage - Activepieces](#persistent-storage-activepieces) - [Create Action - Activepieces](#create-action-activepieces) - [Props Validation - Activepieces](#props-validation-activepieces) - [MCP Server - Activepieces](#mcp-server-activepieces) - [Create Trigger - Activepieces](#create-trigger-activepieces) - [Webhook Trigger - Activepieces](#webhook-trigger-activepieces) - [Hardware Requirements - Activepieces](#hardware-requirements-activepieces) - [Contribute - Activepieces](#contribute-activepieces) - [Overview - Activepieces](#overview-activepieces) - [Overview - Activepieces](#overview-activepieces) - [Telemetry - Activepieces](#telemetry-activepieces) - [Private - Activepieces](#private-activepieces) - [Overview - Activepieces](#overview-activepieces) - [Engine - Activepieces](#engine-activepieces) - [Handling Downtime - Activepieces](#handling-downtime-activepieces) - [How to Separate Workers - Activepieces](#how-to-separate-workers-activepieces) - [Our Roles & Levels - Activepieces](#our-roles-levels-activepieces) - [Environment Variables - Activepieces](#environment-variables-activepieces) - [Polling Trigger - Activepieces](#polling-trigger-activepieces) - [Run Enterprise Edition - Activepieces](#run-enterprise-edition-activepieces) - [Overview - Activepieces](#overview-activepieces) - [How to Setup OpenTelemetry - Activepieces](#how-to-setup-opentelemetry-activepieces) - [How to Setup App Webhooks - Activepieces](#how-to-setup-app-webhooks-activepieces) - [How to Setup S3 - Activepieces](#how-to-setup-s3-activepieces) - [Websocket Issues - Activepieces](#websocket-issues-activepieces) - [Reset Password - Activepieces](#reset-password-activepieces) - [Tools Reference - Activepieces](#tools-reference-activepieces) - [Piece Auth - Activepieces](#piece-auth-activepieces) - [Our Hiring Process - Activepieces](#our-hiring-process-activepieces) - [Engineering Workflow - Activepieces](#engineering-workflow-activepieces) - [Database Migrations - Activepieces](#database-migrations-activepieces) - [Benchmark - Activepieces](#benchmark-activepieces) - [Overview - Activepieces](#overview-activepieces) - [Truncated Logs - Activepieces](#truncated-logs-activepieces) - [Overview - Activepieces](#overview-activepieces) - [Deployment Checklist - Activepieces](#deployment-checklist-activepieces) - [How to handle Requests - Activepieces](#how-to-handle-requests-activepieces) - [Activepieces Handbook - Activepieces](#activepieces-handbook-activepieces) - [Our Compensation - Activepieces](#our-compensation-activepieces) - [Cloud Infrastructure - Activepieces](#cloud-infrastructure-activepieces) - [Tone & Communication - Activepieces](#tone-communication-activepieces) - [Queues Dashboard - Activepieces](#queues-dashboard-activepieces) --- # Welcome - Activepieces [Skip to main content](https://www.activepieces.com/docs/getting-started/introduction#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Overview Welcome [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [🔥 Why Activepieces is Different:](https://www.activepieces.com/docs/getting-started/introduction#-why-activepieces-is-different) Learn Concepts -------------- Learn how to work with Activepieces Pieces ------ Browse available pieces Install ------- Learn how to install Activepieces Build pieces ------------ How to Build Pieces and Contribute [​](https://www.activepieces.com/docs/getting-started/introduction#-why-activepieces-is-different) 🔥 Why Activepieces is Different: ======================================================================================================================================= * **💖 Loved by Everyone**: Intuitive interface and great experience for both technical and non-technical users with a quick learning curve. ![](https://mintcdn.com/activepieces/uHZ35vXyxX7goNO-/resources/templates.gif?s=076362bc114929ee518e20251d901b17) * **🌐 Open Ecosystem:** All pieces are open source and available on npmjs.com, **60% of the pieces are contributed by the community**. * **🛠️ Pieces are written in Typescript**: Pieces are npm packages in TypeScript, offering full customization with the best developer experience, including **hot reloading** for **local** piece development on your machine. 😎 ![](https://mintcdn.com/activepieces/ki8mFooo8mAmhMdP/resources/create-action.png?w=2500&fit=max&auto=format&n=ki8mFooo8mAmhMdP&q=85&s=fb6b48d36b7deb67a7ba801a6780a8b6) * **🤖 AI-Ready**: Native AI pieces and agents are built into Activepieces. Integrating AI into your flows is seamless and simple—experiment with popular providers, or quickly create custom agents using our easy-to-use AI SDK. * **🏢 Enterprise-Ready**: Developers set up the tools, and anyone in the organization can use the no-code builder. Full customization from branding to control. * **🔒 Secure by Design**: Self-hosted and network-gapped for maximum security and control over your data. * **🧠 Human in Loop**: Delay execution for a period of time or require approval. These are just pieces built on top of the piece framework, and you can build many pieces like that. 🎨 [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/overview/welcome.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/overview/welcome) [Building Flows](https://www.activepieces.com/docs/flows/building-flows) ⌘I --- # License - Activepieces [Skip to main content](https://www.activepieces.com/docs/about/license#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation About License [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) Activepieces’ **core** is released as open source under the [MIT license](https://github.com/activepieces/activepieces/blob/main/LICENSE) and enterprise / cloud editions features are released under [Commercial License](https://github.com/activepieces/activepieces/blob/main/packages/ee/LICENSE) The MIT license is a permissive license that grants users the freedom to use, modify, or distribute the software without any significant restrictions. The only requirement is that you include the license notice along with the software when distributing it. Using the enterprise features (under the packages/ee and packages/server/api/src/app/ee folder) with a self-hosted instance requires an Activepieces license. If you are looking for these features, contact us at [\[email protected\]](https://www.activepieces.com/cdn-cgi/l/email-protection#3d4e5c51584e7d5c5e49544b584d54585e584e135e5250) . **Benefits of Dual Licensing Repo** * **Transparency** - Everyone can see what we are doing and contribute to the project. * **Clarity** - Everyone can see what the difference is between the open source and commercial versions of our software. * **Audit** - Everyone can audit our code and see what we are doing. * **Faster Development** - We can develop faster and more efficiently. If you are still confused or have feedback, please open an issue on GitHub or send a message in the #contribution channel on Discord. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/about/license.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/about/license) [Changelog](https://www.activepieces.com/docs/about/changelog) ⌘I --- # Setup AI Providers - Activepieces [Skip to main content](https://www.activepieces.com/docs/admin-guide/guides/setup-ai-providers#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Guides Setup AI Providers [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Supported Providers](https://www.activepieces.com/docs/admin-guide/guides/setup-ai-providers#supported-providers) * [How to Setup](https://www.activepieces.com/docs/admin-guide/guides/setup-ai-providers#how-to-setup) * [Cost Control & Logging](https://www.activepieces.com/docs/admin-guide/guides/setup-ai-providers#cost-control-%26-logging) AI providers are configured by the platform admin to centrally manage credentials and access, making [AI pieces](https://www.activepieces.com/pieces/ai) and their features available to everyone in all projects. [​](https://www.activepieces.com/docs/admin-guide/guides/setup-ai-providers#supported-providers) Supported Providers ----------------------------------------------------------------------------------------------------------------------- * **OpenAI** * **Anthropic** * **Gemini** * **Vercel AI Gateway** * **Cloudflare AI Gateway** [​](https://www.activepieces.com/docs/admin-guide/guides/setup-ai-providers#how-to-setup) How to Setup --------------------------------------------------------------------------------------------------------- Go to **Admin Console** → **AI** page. Add your provider’s base URL and API key. These settings apply to all projects. ![Manage AI Providers](https://mintcdn.com/activepieces/ki8mFooo8mAmhMdP/resources/screenshots/configure-ai-provider.png?w=2500&fit=max&auto=format&n=ki8mFooo8mAmhMdP&q=85&s=9bf447af05f4b1358f88d11a8bd23f94) [​](https://www.activepieces.com/docs/admin-guide/guides/setup-ai-providers#cost-control-&-logging) Cost Control & Logging ----------------------------------------------------------------------------------------------------------------------------- Use an AI gateway like **Vercel AI Gateway** or **Cloudflare AI Gateway** to: * Set rate limits and budgets * Log and monitor all AI requests * Track usage across projects Just set the gateway URL as your provider’s base URL in the Admin Console. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/admin-guide/guides/setup-ai-providers.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/admin-guide/guides/setup-ai-providers) [Override OAuth2 Apps](https://www.activepieces.com/docs/admin-guide/guides/manage-oauth2) [Overview](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/overview) ⌘I --- # Overview - Activepieces [Skip to main content](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/overview#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Secret Managers Overview [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Benefits](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/overview#benefits) * [Supported Providers](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/overview#supported-providers) * [How to Connect](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/overview#how-to-connect) * [Connection Scopes](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/overview#connection-scopes) * [Using Secret Managers in Connection Dialogs](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/overview#using-secret-managers-in-connection-dialogs) * [How It Works](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/overview#how-it-works) * [Caching](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/overview#caching) * [Security Considerations](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/overview#security-considerations) * [Troubleshooting](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/overview#troubleshooting) Secret Managers allow you to integrate external secret management systems with Activepieces, enabling centralized credential management and enhanced security for your global connections. This feature is available in our paid editions. Contact us [here](https://www.activepieces.com/sales) , and we'll be delighted to assist you! [​](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/overview#benefits) Benefits ------------------------------------------------------------------------------------------------------- * **Centralized Management**: Store all credentials in one secure location * **Enhanced Security**: Credentials are managed by dedicated secret management systems * **Audit & Compliance**: Track access and changes to secrets * **Rotation Support**: Easily rotate credentials without updating flows * **Access Control**: Use your existing secret manager access policies [​](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/overview#supported-providers) Supported Providers ----------------------------------------------------------------------------------------------------------------------------- * **[HashiCorp Vault](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/hashicorp) ** - Enterprise-grade secrets management * **[CyberArk Conjur](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/cyberark-conjur) ** - Centralized secrets management with host-based authentication * **[AWS Secrets Manager](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/aws) ** - Managed secrets storage on AWS * **[1Password](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/onepassword) ** - Consumer and team password manager with Secrets Automation [​](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/overview#how-to-connect) How to Connect ------------------------------------------------------------------------------------------------------------------- 1. Go to **Platform Admin → Security → Secret Managers** 2. Click **New Connection** 3. Select the secret manager provider you want to connect 4. Enter a **Name** for the connection 5. Choose a **Scope** (see [Connection Scopes](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/overview#connection-scopes) below) 6. Follow the provider-specific setup instructions in the provider documentation 7. Enter the required connection details 8. Click **Save** to test and save the connection The connection will be encrypted and stored securely. You can edit or delete it at any time from the Secret Managers page. [​](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/overview#connection-scopes) Connection Scopes ------------------------------------------------------------------------------------------------------------------------- Each secret manager connection has a **scope** that controls which projects can use it: | Scope | Description | | --- | --- | | **Platform** | Available to all projects on the platform | | **Project** | Restricted to specific projects you select | When creating or editing a connection, select **Project** scope and choose the projects that should have access. Platform-scoped connections are always visible to all projects. [​](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/overview#using-secret-managers-in-connection-dialogs) Using Secret Managers in Connection Dialogs ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Once connected, you can reference secrets from your secret managers when configuring piece connections: 1. Open a connection dialog (either a global connection or one inside the flow builder) 2. Click the **key icon** (🔑) next to a credential field 3. Select a secret manager connection from the dropdown 4. Enter the secret path/identifier required by your provider (see provider-specific documentation) 5. The connection will automatically retrieve the secret from your secret manager when needed **Global connections (Platform Admin):** All platform-scoped and project-scoped secret manager connections are available to select. **Flow builder connections:** Only secret manager connections that are accessible to the current project are shown — this includes platform-scoped connections and project-scoped connections assigned to that project. ![Manage Oauth2 apps](https://mintcdn.com/activepieces/yqMjtHswhi3w4D2R/resources/screenshots/secret-manager.png?w=2500&fit=max&auto=format&n=yqMjtHswhi3w4D2R&q=85&s=608015daeff79c8368a12c5fa2d488e0) [​](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/overview#how-it-works) How It Works --------------------------------------------------------------------------------------------------------------- When you use a secret manager in a connection: * The global connection stores a reference to the secret (not the actual credential) * When the flow runs, Activepieces authenticates with your secret manager and retrieves the secret * Secrets are fetched on-demand and never stored in Activepieces * If the secret is updated in your secret manager, flows will use the new value after the cache expires (up to 1 hour), or immediately after clearing the cache [​](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/overview#caching) Caching ----------------------------------------------------------------------------------------------------- Connection checks and retrieved secrets are cached in Redis (encrypted) for **1 hour** to reduce latency and provider API load. To force a refresh (e.g. after rotating credentials or updating secrets), platform admins can clear the cache per connection using the **refresh icon** next to each connection row in the Secret Managers page. ![Clear secret manager cache](https://mintcdn.com/activepieces/4VmBz4sovrlimK2J/resources/screenshots/clear-secret-manager-cache.png?w=2500&fit=max&auto=format&n=4VmBz4sovrlimK2J&q=85&s=eeea58560084b3808ee9bbc26b433aab) You can also clear the cache via the API. Omit `connectionId` to clear all cached entries for the platform, or pass a `connectionId` to clear only that connection’s cache: # Clear cache for a specific connection curl --request DELETE \ --url 'https:///api/v1/secret-managers/cache?connectionId=' \ --header 'Authorization: Bearer ' # Clear all platform cache entries curl --request DELETE \ --url 'https:///api/v1/secret-managers/cache' \ --header 'Authorization: Bearer ' [​](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/overview#security-considerations) Security Considerations ------------------------------------------------------------------------------------------------------------------------------------- * **Encryption**: Secret managers authentication configuration is encrypted * **Access Control**: Use your secret manager’s access policies to control who can access secrets * **Network Security**: Ensure your secret manager is accessible from your Activepieces instance * **Credential Management**: Regularly rotate authentication credentials for secret managers [​](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/overview#troubleshooting) Troubleshooting --------------------------------------------------------------------------------------------------------------------- **Connection Failed:** * Verify the connection details are correct and accessible * Check that authentication credentials are valid * Ensure network connectivity between Activepieces and your secret manager * Review provider-specific troubleshooting guides **Secret Not Found:** * Verify the secret path/name is correct * Check that the secret exists in your secret manager * Ensure the authentication credentials have permissions to read the secret **Permission Denied:** * Verify the authentication credentials have the necessary permissions * Check your secret manager’s access control policies * Review audit logs in your secret manager for detailed error information [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/admin-guide/guides/secret-managers/overview.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/admin-guide/guides/secret-managers/overview) [Setup AI Providers](https://www.activepieces.com/docs/admin-guide/guides/setup-ai-providers) [AWS Secrets Manager](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/aws) ⌘I --- # How to Setup SSO - Activepieces [Skip to main content](https://www.activepieces.com/docs/admin-guide/guides/sso#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Guides How to Setup SSO [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Overview](https://www.activepieces.com/docs/admin-guide/guides/sso#overview) * [Prerequisites](https://www.activepieces.com/docs/admin-guide/guides/sso#prerequisites) * [Accessing SSO Configuration](https://www.activepieces.com/docs/admin-guide/guides/sso#accessing-sso-configuration) * [Enforcing SSO](https://www.activepieces.com/docs/admin-guide/guides/sso#enforcing-sso) * [Supported SSO Providers](https://www.activepieces.com/docs/admin-guide/guides/sso#supported-sso-providers) * [Google](https://www.activepieces.com/docs/admin-guide/guides/sso#google) * [GitHub](https://www.activepieces.com/docs/admin-guide/guides/sso#github) * [SAML with Okta](https://www.activepieces.com/docs/admin-guide/guides/sso#saml-with-okta) * [SAML with JumpCloud](https://www.activepieces.com/docs/admin-guide/guides/sso#saml-with-jumpcloud) * [Troubleshooting](https://www.activepieces.com/docs/admin-guide/guides/sso#troubleshooting) * [Need Help?](https://www.activepieces.com/docs/admin-guide/guides/sso#need-help) This feature is available in our paid editions. Contact us [here](https://www.activepieces.com/sales) , and we'll be delighted to assist you! [​](https://www.activepieces.com/docs/admin-guide/guides/sso#overview) Overview ---------------------------------------------------------------------------------- Single Sign-On (SSO) allows your team to authenticate using your organization’s existing identity provider, eliminating the need for separate Activepieces credentials. This improves security, simplifies user management, and provides a seamless login experience. [​](https://www.activepieces.com/docs/admin-guide/guides/sso#prerequisites) Prerequisites -------------------------------------------------------------------------------------------- Before configuring SSO, ensure you have: * **Admin access** to your Activepieces platform * **Admin access** to your identity provider (Google, GitHub, Okta, or JumpCloud) * The **redirect URL** from your Activepieces SSO configuration screen [​](https://www.activepieces.com/docs/admin-guide/guides/sso#accessing-sso-configuration) Accessing SSO Configuration ------------------------------------------------------------------------------------------------------------------------ Navigate to **Platform Settings** → **SSO** in your Activepieces admin dashboard to access the SSO configuration screen. ![SSO Configuration](https://mintcdn.com/activepieces/uHZ35vXyxX7goNO-/resources/screenshots/sso.png?w=2500&fit=max&auto=format&n=uHZ35vXyxX7goNO-&q=85&s=c4cd4418c83c077bfebbd6d74509d52e) [​](https://www.activepieces.com/docs/admin-guide/guides/sso#enforcing-sso) Enforcing SSO -------------------------------------------------------------------------------------------- You can enforce SSO by specifying your organization’s email domain. When SSO enforcement is enabled: * Users with matching email domains must authenticate through the SSO provider * Email/password login can be disabled for enhanced security * All authentication is routed through your designated identity provider We recommend testing SSO with a small group of users before enforcing it organization-wide. [​](https://www.activepieces.com/docs/admin-guide/guides/sso#supported-sso-providers) Supported SSO Providers ---------------------------------------------------------------------------------------------------------------- Activepieces supports multiple SSO providers to integrate with your existing identity management system. ### [​](https://www.activepieces.com/docs/admin-guide/guides/sso#google) Google 1 [](https://www.activepieces.com/docs/admin-guide/guides/sso#) Access Google Cloud Console Go to the [Google Cloud Console](https://console.cloud.google.com/) and select your project (or create a new one). 2 [](https://www.activepieces.com/docs/admin-guide/guides/sso#) Create OAuth2 Credentials Navigate to **APIs & Services** → **Credentials** → **Create Credentials** → **OAuth client ID**.Select **Web application** as the application type. 3 [](https://www.activepieces.com/docs/admin-guide/guides/sso#) Configure Redirect URI Copy the **Redirect URL** from the Activepieces SSO configuration screen and add it to the **Authorized redirect URIs** in Google Cloud Console. 4 [](https://www.activepieces.com/docs/admin-guide/guides/sso#) Copy Credentials to Activepieces Copy the **Client ID** and **Client Secret** from Google and paste them into the corresponding fields in Activepieces. 5 [](https://www.activepieces.com/docs/admin-guide/guides/sso#) Save Configuration Click **Finish** to complete the setup. ### [​](https://www.activepieces.com/docs/admin-guide/guides/sso#github) GitHub 1 [](https://www.activepieces.com/docs/admin-guide/guides/sso#) Access GitHub Developer Settings Go to [GitHub Developer Settings](https://github.com/settings/developers) → **OAuth Apps** → **New OAuth App**. 2 [](https://www.activepieces.com/docs/admin-guide/guides/sso#) Register New Application Fill in the application details: * **Application name**: Choose a recognizable name (e.g., “Activepieces SSO”) * **Homepage URL**: Enter your Activepieces instance URL 3 [](https://www.activepieces.com/docs/admin-guide/guides/sso#) Configure Authorization Callback Copy the **Redirect URL** from the Activepieces SSO configuration screen and paste it into the **Authorization callback URL** field. 4 [](https://www.activepieces.com/docs/admin-guide/guides/sso#) Complete Registration Click **Register application** to create the OAuth App. 5 [](https://www.activepieces.com/docs/admin-guide/guides/sso#) Generate Client Secret After registration, click **Generate a new client secret** and copy it immediately (it won’t be shown again). 6 [](https://www.activepieces.com/docs/admin-guide/guides/sso#) Copy Credentials to Activepieces Copy the **Client ID** and **Client Secret** and paste them into the corresponding fields in Activepieces. 7 [](https://www.activepieces.com/docs/admin-guide/guides/sso#) Save Configuration Click **Finish** to complete the setup. ### [​](https://www.activepieces.com/docs/admin-guide/guides/sso#saml-with-okta) SAML with Okta 1 [](https://www.activepieces.com/docs/admin-guide/guides/sso#) Create New Application in Okta Go to the [Okta Admin Portal](https://login.okta.com/) → **Applications** → **Create App Integration**. 2 [](https://www.activepieces.com/docs/admin-guide/guides/sso#) Select SAML 2.0 Choose **SAML 2.0** as the sign-on method and click **Next**. 3 [](https://www.activepieces.com/docs/admin-guide/guides/sso#) Configure General Settings Enter an **App name** (e.g., “Activepieces”) and optionally upload a logo. Click **Next**. 4 [](https://www.activepieces.com/docs/admin-guide/guides/sso#) Configure SAML Settings * **Single sign-on URL**: Copy the SSO URL from the Activepieces configuration screen * **Audience URI (SP Entity ID)**: Enter `Activepieces` * **Name ID format**: Select `EmailAddress` 5 [](https://www.activepieces.com/docs/admin-guide/guides/sso#) Add Attribute Statements Add the following attribute mappings: | Name | Value | | --- | --- | | `firstName` | `user.firstName` | | `lastName` | `user.lastName` | | `email` | `user.email` | 6 [](https://www.activepieces.com/docs/admin-guide/guides/sso#) Complete Setup in Okta Click **Next**, select the appropriate feedback option, and click **Finish**. 7 [](https://www.activepieces.com/docs/admin-guide/guides/sso#) Export IdP Metadata Go to the **Sign On** tab → **View SAML setup instructions** or **View IdP metadata**. Copy the Identity Provider metadata XML. 8 [](https://www.activepieces.com/docs/admin-guide/guides/sso#) Configure Activepieces * Paste the **IdP Metadata** XML into the corresponding field * Copy the **X.509 Certificate** from Okta and paste it into the **Signing Key** field 9 [](https://www.activepieces.com/docs/admin-guide/guides/sso#) Save Configuration Click **Save** to complete the setup. ### [​](https://www.activepieces.com/docs/admin-guide/guides/sso#saml-with-jumpcloud) SAML with JumpCloud 1 [](https://www.activepieces.com/docs/admin-guide/guides/sso#) Create New Application in JumpCloud Go to the [JumpCloud Admin Portal](https://console.jumpcloud.com/) → **SSO Applications** → **Add New Application** → **Custom SAML App**. 2 [](https://www.activepieces.com/docs/admin-guide/guides/sso#) Configure ACS URL Copy the **ACS URL** from the Activepieces configuration screen and paste it into the **ACS URLs** field in JumpCloud.![JumpCloud ACS URL](https://mintcdn.com/activepieces/uHZ35vXyxX7goNO-/resources/screenshots/jumpcloud/acl-url.png?w=2500&fit=max&auto=format&n=uHZ35vXyxX7goNO-&q=85&s=21d5aae4e46ebd6cfc5611b4d5d30c88) 3 [](https://www.activepieces.com/docs/admin-guide/guides/sso#) Configure SP Entity ID Set the **SP Entity ID** (Audience URI) to `Activepieces`. 4 [](https://www.activepieces.com/docs/admin-guide/guides/sso#) Add User Attributes Configure the following attribute mappings: | Service Provider Attribute | JumpCloud Attribute | | --- | --- | | `firstName` | `firstname` | | `lastName` | `lastname` | | `email` | `email` | ![JumpCloud User Attributes](https://mintcdn.com/activepieces/uHZ35vXyxX7goNO-/resources/screenshots/jumpcloud/user-attribute.png?w=2500&fit=max&auto=format&n=uHZ35vXyxX7goNO-&q=85&s=51b3448b758b1e2c90f09646421b87a0) 5 [](https://www.activepieces.com/docs/admin-guide/guides/sso#) Enable HTTP-Redirect Binding JumpCloud does not include the `HTTP-Redirect` binding by default. You **must** enable this option.![JumpCloud Redirect Binding](https://mintcdn.com/activepieces/uHZ35vXyxX7goNO-/resources/screenshots/jumpcloud/declare-login.png?w=2500&fit=max&auto=format&n=uHZ35vXyxX7goNO-&q=85&s=5d1e72816ff38b9a77ed29991bf25a57) Without HTTP-Redirect binding, the SSO integration will not work correctly. 6 [](https://www.activepieces.com/docs/admin-guide/guides/sso#) Export Metadata Click **Save**, then refresh the page and click **Export Metadata**.![JumpCloud Export Metadata](https://mintcdn.com/activepieces/uHZ35vXyxX7goNO-/resources/screenshots/jumpcloud/export-metadata.png?w=2500&fit=max&auto=format&n=uHZ35vXyxX7goNO-&q=85&s=b2541f12de981d893e8ea7810ab64dc4) Verify that the exported XML contains `Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect"` to ensure the binding was properly enabled. 7 [](https://www.activepieces.com/docs/admin-guide/guides/sso#) Configure IdP Metadata in Activepieces Paste the exported metadata XML into the **IdP Metadata** field in Activepieces. 8 [](https://www.activepieces.com/docs/admin-guide/guides/sso#) Configure Signing Certificate Locate the `` element in the IdP metadata and extract its value. Format it as a PEM certificate: -----BEGIN CERTIFICATE----- [PASTE THE CERTIFICATE VALUE HERE] -----END CERTIFICATE----- Paste this into the **Signing Key** field. 9 [](https://www.activepieces.com/docs/admin-guide/guides/sso#) Assign Users to Application In JumpCloud, assign the application to the appropriate users or user groups.![JumpCloud Assign App](https://mintcdn.com/activepieces/uHZ35vXyxX7goNO-/resources/screenshots/jumpcloud/user-groups.png?w=2500&fit=max&auto=format&n=uHZ35vXyxX7goNO-&q=85&s=5a829b002dfb0106cf16945b7381cba4) 10 [](https://www.activepieces.com/docs/admin-guide/guides/sso#) Save Configuration Click **Finish** to complete the setup. [​](https://www.activepieces.com/docs/admin-guide/guides/sso#troubleshooting) Troubleshooting ------------------------------------------------------------------------------------------------ Users cannot log in after SSO configuration * Verify the redirect URL is correctly configured in your identity provider * Ensure users are assigned to the application in your identity provider * Check that email domains match the SSO enforcement settings SAML authentication fails * Confirm the IdP metadata is complete and correctly formatted * Verify the signing certificate is properly formatted with BEGIN/END markers * Ensure all required attributes (firstName, lastName, email) are mapped HTTP-Redirect binding error (JumpCloud) * Enable the HTTP-Redirect binding option in JumpCloud * Re-export the metadata after enabling the binding * Verify the binding appears in the exported XML [​](https://www.activepieces.com/docs/admin-guide/guides/sso#need-help) Need Help? ------------------------------------------------------------------------------------- If you encounter issues during SSO setup, please contact our enterprise support or [sales team](https://www.activepieces.com/sales) . [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/admin-guide/guides/sso.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/admin-guide/guides/sso) [How to Manage Pieces](https://www.activepieces.com/docs/admin-guide/guides/manage-pieces) [SCIM Overview](https://www.activepieces.com/docs/admin-guide/guides/scim/overview) ⌘I --- # Override OAuth2 Apps - Activepieces [Skip to main content](https://www.activepieces.com/docs/admin-guide/guides/manage-oauth2#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Guides Override OAuth2 Apps [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Default Behavior](https://www.activepieces.com/docs/admin-guide/guides/manage-oauth2#default-behavior) * [Why Replace OAuth2 Apps?](https://www.activepieces.com/docs/admin-guide/guides/manage-oauth2#why-replace-oauth2-apps) * [How to Configure](https://www.activepieces.com/docs/admin-guide/guides/manage-oauth2#how-to-configure) This feature is available in our paid editions. Contact us [here](https://www.activepieces.com/sales) , and we'll be delighted to assist you! [​](https://www.activepieces.com/docs/admin-guide/guides/manage-oauth2#default-behavior) Default Behavior ------------------------------------------------------------------------------------------------------------ When users connect to services like Google Sheets or Slack, they see “Activepieces” as the app requesting access. This works out of the box with no setup required. [​](https://www.activepieces.com/docs/admin-guide/guides/manage-oauth2#why-replace-oauth2-apps) Why Replace OAuth2 Apps? --------------------------------------------------------------------------------------------------------------------------- * **Branding**: Show your company name instead of “Activepieces” in authorization screens * **Higher Limits**: Some services have stricter rate limits for shared OAuth apps * **Compliance**: Your organization may require using company-owned credentials [​](https://www.activepieces.com/docs/admin-guide/guides/manage-oauth2#how-to-configure) How to Configure ------------------------------------------------------------------------------------------------------------ 1. Go to **Platform Admin → Setup → Pieces** 2. Find the piece you want to configure (e.g., Google Sheets) 3. Click the lock icon to open the OAuth2 settings 4. Enter your own Client ID and Client Secret ![Manage Oauth2 apps](https://mintcdn.com/activepieces/uHZ35vXyxX7goNO-/resources/screenshots/manage-oauth2.png?w=2500&fit=max&auto=format&n=uHZ35vXyxX7goNO-&q=85&s=33b36a1667c9879a845e9ffa6302678c) [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/admin-guide/guides/manage-oauth2.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/admin-guide/guides/manage-oauth2) [SCIM with Okta](https://www.activepieces.com/docs/admin-guide/guides/scim/providers/okta) [Setup AI Providers](https://www.activepieces.com/docs/admin-guide/guides/setup-ai-providers) ⌘I --- # How to Manage Pieces - Activepieces [Skip to main content](https://www.activepieces.com/docs/admin-guide/guides/manage-pieces#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Guides How to Manage Pieces [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Overview](https://www.activepieces.com/docs/admin-guide/guides/manage-pieces#overview) * [Platform-Level Management](https://www.activepieces.com/docs/admin-guide/guides/manage-pieces#platform-level-management) * [Project-Level Management](https://www.activepieces.com/docs/admin-guide/guides/manage-pieces#project-level-management) * [Show/Hide Pieces in a Project](https://www.activepieces.com/docs/admin-guide/guides/manage-pieces#show%2Fhide-pieces-in-a-project) * [Install Private Pieces](https://www.activepieces.com/docs/admin-guide/guides/manage-pieces#install-private-pieces) This feature is available in our paid editions. Contact us [here](https://www.activepieces.com/sales) , and we'll be delighted to assist you! [​](https://www.activepieces.com/docs/admin-guide/guides/manage-pieces#overview) Overview -------------------------------------------------------------------------------------------- **Pieces** are the building blocks of Activepieces — they are integrations and connectors (like Google Sheets, Slack, OpenAI, etc.) that users can use in their automation flows. As a platform administrator, you have full control over which pieces are available to your users. This allows you to: * **Enforce security policies** by restricting access to certain integrations * **Simplify the user experience** by showing only relevant pieces for your use case * **Deploy custom/private pieces** that are specific to your organization There are **two levels** of piece management: | Level | Who Can Manage | Scope | | --- | --- | --- | | **Platform Level** | Platform Admin | Install and remove across the entire platform | | **Project Level** | Project Admin | Show/hide specific pieces for specfic project | * * * [​](https://www.activepieces.com/docs/admin-guide/guides/manage-pieces#platform-level-management) Platform-Level Management ------------------------------------------------------------------------------------------------------------------------------ Platform administrators can manage pieces for the entire Activepieces instance from **Platform Admin → Setup → Pieces**. [​](https://www.activepieces.com/docs/admin-guide/guides/manage-pieces#project-level-management) Project-Level Management ---------------------------------------------------------------------------------------------------------------------------- Project administrators can further restrict which pieces are available within their specific project. This is useful when different teams or projects need access to different integrations. ### [​](https://www.activepieces.com/docs/admin-guide/guides/manage-pieces#show/hide-pieces-in-a-project) Show/Hide Pieces in a Project 1 [](https://www.activepieces.com/docs/admin-guide/guides/manage-pieces#) Open Project Settings Navigate to your project and go to **Settings → Pieces**. 2 [](https://www.activepieces.com/docs/admin-guide/guides/manage-pieces#) Configure Visibility You’ll see a list of all pieces installed on the platform. Toggle the visibility for each piece: * **Enabled**: Users in this project can use the piece * **Disabled**: The piece is hidden from users in this project 3 [](https://www.activepieces.com/docs/admin-guide/guides/manage-pieces#) Save Changes Changes take effect immediately — users will only see the enabled pieces when building their flows. ![Manage Pieces](https://mintcdn.com/activepieces/uHZ35vXyxX7goNO-/resources/screenshots/manage-pieces.png?w=2500&fit=max&auto=format&n=uHZ35vXyxX7goNO-&q=85&s=ea899782b139f0fa2f5d2a2d481ef256) ![Manage Pieces](https://mintcdn.com/activepieces/uHZ35vXyxX7goNO-/resources/screenshots/manage-pieces-2.png?w=2500&fit=max&auto=format&n=uHZ35vXyxX7goNO-&q=85&s=3e0a74e89a61b988c3f8e84099f8a3a1) Project-level settings can only **hide** pieces that are installed at the platform level. You cannot add pieces at the project level that aren’t already installed on the platform. ### [​](https://www.activepieces.com/docs/admin-guide/guides/manage-pieces#install-private-pieces) Install Private Pieces For detailed instructions on building custom pieces, check the [Building Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) documentation. If you’ve built a custom piece for your organization, you can upload it directly as a tarball (`.tgz`) file. 1 [](https://www.activepieces.com/docs/admin-guide/guides/manage-pieces#) Build Your Piece Build your piece using the Activepieces CLI: npm run pieces -- build --name=your-piece-name This generates a tarball in `dist/packages/pieces/your-piece-name`. 2 [](https://www.activepieces.com/docs/admin-guide/guides/manage-pieces#) Navigate to Pieces Settings Go to **Platform Admin → Setup → Pieces** and click **Install Piece**. 3 [](https://www.activepieces.com/docs/admin-guide/guides/manage-pieces#) Select File Upload Choose **Upload File** as the installation source. 4 [](https://www.activepieces.com/docs/admin-guide/guides/manage-pieces#) Upload the Tarball Select the `.tgz` file from your build output and upload it. ![Install Piece](https://mintcdn.com/activepieces/uHZ35vXyxX7goNO-/resources/screenshots/install-piece.png?w=2500&fit=max&auto=format&n=uHZ35vXyxX7goNO-&q=85&s=f0d73c60a5077685d90f537a4f8a4ec1) [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/admin-guide/guides/manage-pieces.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/admin-guide/guides/manage-pieces) [How to Structure Projects](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [How to Setup SSO](https://www.activepieces.com/docs/admin-guide/guides/sso) ⌘I --- # i18n Translations - Activepieces [Skip to main content](https://www.activepieces.com/docs/about/i18n#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation About i18n Translations [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Contribute to existing translations](https://www.activepieces.com/docs/about/i18n#contribute-to-existing-translations) * [Adding a new language](https://www.activepieces.com/docs/about/i18n#adding-a-new-language) This guide helps you understand how to change or add new translations. Activepieces uses Crowdin because it helps translators who don’t know how to code. It also makes the approval process easier. Activepieces automatically sync new text from the code and translations back into the code. [​](https://www.activepieces.com/docs/about/i18n#contribute-to-existing-translations) Contribute to existing translations ---------------------------------------------------------------------------------------------------------------------------- 1. Create Crowdin account 2. Join the project [https://crowdin.com/project/activepieces](https://crowdin.com/project/activepieces) ![Join Project](https://mintcdn.com/activepieces/ki8mFooo8mAmhMdP/resources/crowdin.png?w=2500&fit=max&auto=format&n=ki8mFooo8mAmhMdP&q=85&s=497c4c227a57393942aced37358b2615) 3. Click on the language you want to translate 4. Click on “Translate All” ![Translate All](https://mintcdn.com/activepieces/ki8mFooo8mAmhMdP/resources/crowdin-translate-all.png?w=2500&fit=max&auto=format&n=ki8mFooo8mAmhMdP&q=85&s=7b09feacb0d45bbea605269aad2bf44e) 5. Select Strings you want to translate and click on “Save” button [​](https://www.activepieces.com/docs/about/i18n#adding-a-new-language) Adding a new language ------------------------------------------------------------------------------------------------ * Please contact us ([\[email protected\]](https://www.activepieces.com/cdn-cgi/l/email-protection#e5969095958a9791a58486918c9380958c80868096cb868a88) ) if you want to add a new language. We will add it to the project and you can start translating. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/about/i18n.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/about/i18n) [Tools Reference](https://www.activepieces.com/docs/mcp/tools) [Changelog](https://www.activepieces.com/docs/about/changelog) ⌘I --- # SCIM Overview - Activepieces [Skip to main content](https://www.activepieces.com/docs/admin-guide/guides/scim/overview#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation SCIM SCIM Overview [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [What is SCIM?](https://www.activepieces.com/docs/admin-guide/guides/scim/overview#what-is-scim) * [What SCIM Handles](https://www.activepieces.com/docs/admin-guide/guides/scim/overview#what-scim-handles) * [SCIM and SSO](https://www.activepieces.com/docs/admin-guide/guides/scim/overview#scim-and-sso) * [Supported Providers](https://www.activepieces.com/docs/admin-guide/guides/scim/overview#supported-providers) * [Configuration](https://www.activepieces.com/docs/admin-guide/guides/scim/overview#configuration) * [Architecture](https://www.activepieces.com/docs/admin-guide/guides/scim/overview#architecture) This feature is available in our paid editions. Contact us [here](https://www.activepieces.com/sales) , and we'll be delighted to assist you! [​](https://www.activepieces.com/docs/admin-guide/guides/scim/overview#what-is-scim) What is SCIM? ----------------------------------------------------------------------------------------------------- SCIM (System for Cross-domain Identity Management) lets your identity provider automatically create, update, and deactivate users in Activepieces. [​](https://www.activepieces.com/docs/admin-guide/guides/scim/overview#what-scim-handles) What SCIM Handles -------------------------------------------------------------------------------------------------------------- * **Provision users** when they are assigned in your identity provider * **Sync profile updates** such as name or email changes * **Deprovision users** when access is removed or accounts are deactivated [​](https://www.activepieces.com/docs/admin-guide/guides/scim/overview#scim-and-sso) SCIM and SSO ---------------------------------------------------------------------------------------------------- SCIM handles user lifecycle management. SSO handles sign-in and authentication. You can use both together so user access is managed centrally in your identity provider. [​](https://www.activepieces.com/docs/admin-guide/guides/scim/overview#supported-providers) Supported Providers ------------------------------------------------------------------------------------------------------------------ Okta ---- Configure SCIM provisioning from Okta to Activepieces. [​](https://www.activepieces.com/docs/admin-guide/guides/scim/overview#configuration) Configuration ------------------------------------------------------------------------------------------------------ | Variable | Description | Default | | --- | --- | --- | | `AP_SCIM_DEFAULT_PROJECT_ROLE` | The project role assigned to members when added via SCIM group sync. Accepted values: `Admin`, `Editor`, `Viewer`. | `Editor` | [​](https://www.activepieces.com/docs/admin-guide/guides/scim/overview#architecture) Architecture ---------------------------------------------------------------------------------------------------- ![SCIM Architecture Placeholder](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/screenshots/scim/scim-overview-placeholder.svg) Replace this placeholder with your final architecture image later. Keep the same image path to avoid doc changes. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/admin-guide/guides/scim/overview.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/admin-guide/guides/scim/overview) [How to Setup SSO](https://www.activepieces.com/docs/admin-guide/guides/sso) [SCIM with Okta](https://www.activepieces.com/docs/admin-guide/guides/scim/providers/okta) ⌘I --- # Manage User Roles - Activepieces [Skip to main content](https://www.activepieces.com/docs/admin-guide/guides/permissions#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Guides Manage User Roles [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Default Roles](https://www.activepieces.com/docs/admin-guide/guides/permissions#default-roles) * [Custom Roles](https://www.activepieces.com/docs/admin-guide/guides/permissions#custom-roles) This feature is available in our paid editions. Contact us [here](https://www.activepieces.com/sales) , and we'll be delighted to assist you! Activepieces utilizes Role-Based Access Control (RBAC) for managing permissions within projects. Each project consists of multiple flows and users, with each user assigned specific roles that define their actions within the project. [​](https://www.activepieces.com/docs/admin-guide/guides/permissions#default-roles) Default Roles ---------------------------------------------------------------------------------------------------- Activepieces comes with four standard roles out of the box. The table below shows the permissions for each role: | Permission | Admin | Editor | Operator | Viewer | | --- | --- | --- | --- | --- | | **Flows** | | | | | | View Flows | ✓ | ✓ | ✓ | ✓ | | Edit Flows | ✓ | ✓ | | | | Publish / Toggle Flows | ✓ | ✓ | ✓ | | | **Runs** | | | | | | View Runs | ✓ | ✓ | ✓ | ✓ | | Retry Runs | ✓ | ✓ | ✓ | | | **Connections** | | | | | | View Connections | ✓ | ✓ | ✓ | ✓ | | Edit Connections | ✓ | ✓ | ✓ | | | **Team** | | | | | | View Project Members | ✓ | ✓ | ✓ | ✓ | | Add/Remove Project Members | ✓ | | | | | **Git Sync** | | | | | | Configure Git Repo | ✓ | | | | | Pull Flows from Git | ✓ | | | | | Push Flows to Git | ✓ | | | | [​](https://www.activepieces.com/docs/admin-guide/guides/permissions#custom-roles) Custom Roles -------------------------------------------------------------------------------------------------- If the default roles don’t fit your needs, you can create custom roles with specific permissions. 1 [](https://www.activepieces.com/docs/admin-guide/guides/permissions#) Navigate to Project Roles Go to **Platform Admin** → **Security** → **Project Roles** 2 [](https://www.activepieces.com/docs/admin-guide/guides/permissions#) Create a New Role Click **Create Role** and give it a name 3 [](https://www.activepieces.com/docs/admin-guide/guides/permissions#) Configure Permissions Select the specific permissions you want to grant to this role Custom roles are useful when you need fine-grained control, such as allowing users to view and retry runs without being able to edit flows. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/admin-guide/guides/permissions.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/admin-guide/guides/permissions) [1Password](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/onepassword) [Event Streaming](https://www.activepieces.com/docs/admin-guide/guides/event-streaming) ⌘I --- # Event Streaming - Activepieces [Skip to main content](https://www.activepieces.com/docs/admin-guide/guides/event-streaming#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Guides Event Streaming [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Overview](https://www.activepieces.com/docs/admin-guide/guides/event-streaming#overview) * [Use Cases](https://www.activepieces.com/docs/admin-guide/guides/event-streaming#use-cases) * [Available Events](https://www.activepieces.com/docs/admin-guide/guides/event-streaming#available-events) * [Flow Events](https://www.activepieces.com/docs/admin-guide/guides/event-streaming#flow-events) * [Folder Events](https://www.activepieces.com/docs/admin-guide/guides/event-streaming#folder-events) * [Connection Events](https://www.activepieces.com/docs/admin-guide/guides/event-streaming#connection-events) * [User Events](https://www.activepieces.com/docs/admin-guide/guides/event-streaming#user-events) * [Security Events](https://www.activepieces.com/docs/admin-guide/guides/event-streaming#security-events) * [How to Configure](https://www.activepieces.com/docs/admin-guide/guides/event-streaming#how-to-configure) * [Requirements](https://www.activepieces.com/docs/admin-guide/guides/event-streaming#requirements) * [Troubleshooting](https://www.activepieces.com/docs/admin-guide/guides/event-streaming#troubleshooting) This feature is available in our paid editions. Contact us [here](https://www.activepieces.com/sales) , and we'll be delighted to assist you! [​](https://www.activepieces.com/docs/admin-guide/guides/event-streaming#overview) Overview ---------------------------------------------------------------------------------------------- Event Streaming allows you to configure webhook destinations that receive real-time notifications when specific events occur in your Activepieces platform. This enables you to integrate Activepieces with external systems, monitoring tools, analytics platforms, or custom applications. [​](https://www.activepieces.com/docs/admin-guide/guides/event-streaming#use-cases) Use Cases ------------------------------------------------------------------------------------------------ * **Monitoring & Analytics**: Track flow executions, user activity, and system changes in real-time * **Integration**: Sync events with external systems like SIEM tools, data warehouses, or custom dashboards * **Compliance**: Maintain audit trails in external systems for compliance requirements * **Automation**: Trigger downstream processes based on platform events [​](https://www.activepieces.com/docs/admin-guide/guides/event-streaming#available-events) Available Events -------------------------------------------------------------------------------------------------------------- You can configure destinations to receive the following event types: ### [​](https://www.activepieces.com/docs/admin-guide/guides/event-streaming#flow-events) Flow Events * **Flow Created**: When a new flow is created * **Flow Updated**: When a flow is modified * **Flow Deleted**: When a flow is removed * **Flow Run Started**: When a flow execution begins * **Flow Run Finished**: When a flow execution completes * **Flow Run Resumed**: When a paused flow execution resumes ### [​](https://www.activepieces.com/docs/admin-guide/guides/event-streaming#folder-events) Folder Events * **Folder Created**: When a new folder is created * **Folder Updated**: When a folder is modified * **Folder Deleted**: When a folder is removed ### [​](https://www.activepieces.com/docs/admin-guide/guides/event-streaming#connection-events) Connection Events * **Connection Upserted**: When a connection is created or updated * **Connection Deleted**: When a connection is removed ### [​](https://www.activepieces.com/docs/admin-guide/guides/event-streaming#user-events) User Events * **User Signed Up**: When a new user registers * **User Signed In**: When a user logs in * **User Password Reset**: When a password reset is requested * **User Email Verified**: When a user verifies their email ### [​](https://www.activepieces.com/docs/admin-guide/guides/event-streaming#security-events) Security Events * **Signing Key Created**: When a new signing key is generated * **Project Role Created**: When a project role is created * **Project Role Updated**: When a project role is modified * **Project Role Deleted**: When a project role is removed * **Project Release Created**: When a project release is created [​](https://www.activepieces.com/docs/admin-guide/guides/event-streaming#how-to-configure) How to Configure -------------------------------------------------------------------------------------------------------------- 1. Go to **Platform Admin → Infrastructure → Event Destinations** 2. Click **Create Destination** 3. Enter your **Webhook URL** (must be a valid HTTPS endpoint) 4. Select the **Events** you want to receive 5. Click **Test Destination** to verify the connection (optional) 6. Click **Create Destination** to save [​](https://www.activepieces.com/docs/admin-guide/guides/event-streaming#requirements) Requirements ------------------------------------------------------------------------------------------------------ * **Enterprise Edition**: Event Streaming requires an enterprise plan with Audit Logs enabled * **HTTPS Endpoint**: Webhook URLs must use HTTPS * **Publicly Accessible**: Your endpoint must be accessible from the internet [​](https://www.activepieces.com/docs/admin-guide/guides/event-streaming#troubleshooting) Troubleshooting ------------------------------------------------------------------------------------------------------------ * **Events Not Received**: Verify your endpoint is publicly accessible and returns 2xx status codes * **Test Fails**: Check that your URL is valid and uses HTTPS * **Missing Events**: Ensure the event type is selected in your destination configuration [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/admin-guide/guides/event-streaming.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/admin-guide/guides/event-streaming) [Manage User Roles](https://www.activepieces.com/docs/admin-guide/guides/permissions) [Project Releases](https://www.activepieces.com/docs/admin-guide/guides/project-releases) ⌘I --- # Changelog - Activepieces [Skip to main content](https://www.activepieces.com/docs/about/changelog#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation About Changelog [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [March 2026](https://www.activepieces.com/docs/about/changelog#march-2026) * [March 2026](https://www.activepieces.com/docs/about/changelog#march-2026-2) * [March 2026](https://www.activepieces.com/docs/about/changelog#march-2026-3) [​](https://www.activepieces.com/docs/about/changelog#march-2026) March 2026 Stability & Reliability Improvements ### [​](https://www.activepieces.com/docs/about/changelog#stability-&-reliability-improvements) Stability & reliability improvements Major investments in worker architecture, testing, and resilience to ensure more reliable flow execution.**Worker Architecture** * Complete worker rewrite (worker v2) focused on stability and reliability * New sandbox process model with improved error handling and resource cleanup **Testing & Quality — what we added and why it matters**Race condition tests: * **Queue dispatcher** (12 tests) — tests orphaned job handling when a job is dequeued but all waiters have timed out, prevents double-loop spawn during close with in-flight dequeue, verifies single dequeue concurrency control, tests waiter timeout and retry behavior * **Subflow resume** (8 tests) — tests the race condition where the engine writes pause metadata to Redis before it’s persisted to DB, verifies Redis fallback when DB is stale, simulates concurrent reads/writes with spy mocks, covers sync endpoint with concurrent Redis updates * **Rate limiter** (5+ tests) — tests concurrent job slot allocation, idempotency with concurrent dispatch, per-project isolation so different projects don’t interfere * **Concurrent flow execution** — end-to-end test creating 5 concurrent flow runs verifying none get stuck or deadlocked * **Memory lock** — verifies mutual exclusion (two concurrent lock acquire calls on same key are serialized) Worker unit tests: * **Worker polling** — tests job execution lifecycle, resilience to invalid job data, null polls, unrecognized job types, mixed valid/invalid sequences * **Sandbox execution** — tests sandbox creation, startup, RPC communication, stdout/stderr accumulation, resource cleanup on timeout or memory issues, process cleanup and listener removal * **Process forking** — tests execArgv configuration (memory limits, node options), environment variable propagation * **Cache logic** — tests cache hit/miss, disk persistence, memory caching, cache invalidation predicates * **Configuration** — tests config loading for different container types (WORKER\_AND\_APP vs WORKER) End-to-end validation: * **[Smoke tests](https://github.com/activepieces/activepieces/blob/main/.github/workflows/smoke-test.yml) in GitHub Actions** — validates health checks and webhook flow execution on AMD64 and ARM64 * **[Benchmark tests](https://github.com/activepieces/activepieces/blob/main/.github/workflows/benchmark.yml) in GitHub Actions** — load testing across 6 app/worker configurations measuring throughput, mean latency, P50, P99 ([see results](https://www.activepieces.com/docs/install/architecture/benchmark) ) **Resilience** * Worker gracefully handles invalid job data, null polls, and unrecognized job types * Sandbox properly cleans up processes, listeners, and resources on timeout or memory issues * Race condition fixes for subflow resume and user interaction jobs [​](https://www.activepieces.com/docs/about/changelog#march-2026-2) March 2026 Platform Admin ### [​](https://www.activepieces.com/docs/about/changelog#platform-admin-%E2%80%94-full-ui-redesign) Platform Admin — full UI redesign A comprehensive visual refresh across all Platform Admin and Project pages with a cleaner, more consistent interface.**Platform Admin** * **Projects** — filter chips, inline edit icons, and cleaner sidebar without branding * **Users** — new Role and Last Active columns, dedicated Invite button, and per-row action menus * **Project Roles** — switched from table to card-based layout with permission viewing * **Audit Logs** — fully enabled with Action, Performed By, Project, and Date Range filters, plus detail slide-over panels with a full JSON payload viewer * **Secret Managers** — card-based layout with Hashicorp Vault, AWS Secrets Manager, Cyberark Conjur, and 1Password * **Branding** — refreshed page layout **Project pages** * **Automations** — renamed from “Flows”, with Type and Owner filters, search, step icon details, status toggles, and favorites * **Connections** — Pieces and Owner filters, flow usage count, inline edit and refresh actions * **Runs** — updated tab navigation and consistent styling **General improvements** * Unified tab navigation across Automations, Runs, and Connections * Platform Admin link added to the bottom of the project sidebar * Slide-over panels for detail views instead of full-page navigation * Previous / Next pagination style throughout * Sidebar header replaced with a “Back to app” link [​](https://www.activepieces.com/docs/about/changelog#march-2026-3) March 2026 Staging Environment & Release Process ### [​](https://www.activepieces.com/docs/about/changelog#dedicated-staging-environment-&-improved-release-process) Dedicated staging environment & improved release process All changes now go through a dedicated staging environment before reaching production. Every update is validated internally for a minimum of 16 hours before being promoted, ensuring higher reliability and fewer disruptions for our users. * **Staging-first deployment** — every change is tested in a production-like environment before going live * **Daily production promotions** — only validated, stable builds are promoted to production * **Weekly self-hosted releases** — predictable, stable releases published every week for self-hosted customers * **Emergency hotfix path** — critical fixes can still be fast-tracked to production when needed [Read more about our release cycle](https://www.activepieces.com/docs/handbook/engineering/onboarding/release-cycle) For previous releases, see the [GitHub Releases](https://github.com/activepieces/activepieces/releases) page. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/about/changelog.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/about/changelog) [i18n Translations](https://www.activepieces.com/docs/about/i18n) [License](https://www.activepieces.com/docs/about/license) ⌘I --- # SCIM with Okta - Activepieces [Skip to main content](https://www.activepieces.com/docs/admin-guide/guides/scim/providers/okta#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation SCIM SCIM with Okta [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Prerequisites](https://www.activepieces.com/docs/admin-guide/guides/scim/providers/okta#prerequisites) * [Configure SCIM Connection in Okta](https://www.activepieces.com/docs/admin-guide/guides/scim/providers/okta#configure-scim-connection-in-okta) * [Configure Attribute Mapping](https://www.activepieces.com/docs/admin-guide/guides/scim/providers/okta#configure-attribute-mapping) * [Platform role mapping](https://www.activepieces.com/docs/admin-guide/guides/scim/providers/okta#platform-role-mapping) * [Provision and Deprovision Users](https://www.activepieces.com/docs/admin-guide/guides/scim/providers/okta#provision-and-deprovision-users) * [Provision](https://www.activepieces.com/docs/admin-guide/guides/scim/providers/okta#provision) * [Deprovision](https://www.activepieces.com/docs/admin-guide/guides/scim/providers/okta#deprovision) * [Troubleshooting](https://www.activepieces.com/docs/admin-guide/guides/scim/providers/okta#troubleshooting) This feature is available in our paid editions. Contact us [here](https://www.activepieces.com/sales) , and we'll be delighted to assist you! [​](https://www.activepieces.com/docs/admin-guide/guides/scim/providers/okta#prerequisites) Prerequisites ------------------------------------------------------------------------------------------------------------ Before you start, make sure you have: * **Admin access** to your Activepieces platform * **Admin access** to your Okta tenant * SSO already configured (recommended): [SAML with Okta](https://www.activepieces.com/docs/admin-guide/guides/sso#saml-with-okta) * Generated an API key from `/platform/security/api-keys` route in the Activepieces app [​](https://www.activepieces.com/docs/admin-guide/guides/scim/providers/okta#configure-scim-connection-in-okta) Configure SCIM Connection in Okta ---------------------------------------------------------------------------------------------------------------------------------------------------- 1 [](https://www.activepieces.com/docs/admin-guide/guides/scim/providers/okta#) Open your Okta app In Okta Admin Console, open your Activepieces application (created in [SSO step](https://www.activepieces.com/docs/admin-guide/guides/sso#saml-with-okta) ). 2 [](https://www.activepieces.com/docs/admin-guide/guides/scim/providers/okta#) Enable provisioning In the app’s **General** tab, enable **SCIM Provisioning**.![Okta User Provisioning Placeholder](https://mintcdn.com/activepieces/Jz9nlyeTn6NzuJkR/resources/screenshots/scim/okta/enable-provisioning.png?w=2500&fit=max&auto=format&n=Jz9nlyeTn6NzuJkR&q=85&s=c6c302936ea67358787ebeb2f0085efb) 3 [](https://www.activepieces.com/docs/admin-guide/guides/scim/providers/okta#) Add SCIM connection details **Provisioning** will be visible, go to it and set: * **SCIM base URL** to `https://your-activepieces-domain/api/v1/scim/v2` * **Unique identifier field** to `userName` * **Authentication mode** to `HTTP Header` * **Authorization** to `Bearer ` In Supported provisioning actions we support all **Push** actions 4 [](https://www.activepieces.com/docs/admin-guide/guides/scim/providers/okta#) Test the connector Click **Test Connector Configuration** and confirm the test passes. ![Okta SCIM Connection Image](https://mintcdn.com/activepieces/Jz9nlyeTn6NzuJkR/resources/screenshots/scim/okta/provisioning.png?w=2500&fit=max&auto=format&n=Jz9nlyeTn6NzuJkR&q=85&s=d5cc1fed46984f574c1de511b88dcdd4) [​](https://www.activepieces.com/docs/admin-guide/guides/scim/providers/okta#configure-attribute-mapping) Configure Attribute Mapping ---------------------------------------------------------------------------------------------------------------------------------------- In **Provisioning -> To App -> Attribute Mappings**, map these fields: | Activepieces (SCIM) | Okta Value | | --- | --- | | `userName` | `user.email` | | `givenName` | `user.firstName` | | `familyName` | `user.lastName` | | `email` | `user.email` | | `displayName` | `user.displayName` | [​](https://www.activepieces.com/docs/admin-guide/guides/scim/providers/okta#platform-role-mapping) Platform role mapping ---------------------------------------------------------------------------------------------------------------------------- By default, provisioned users will have `Member` role in the platform. In order to specify roles for users in Okta, follow these steps: 1 [](https://www.activepieces.com/docs/admin-guide/guides/scim/providers/okta#) In Okta admin console, navigate to **Directory -> Profile Editor -> Your-Application User**. 2 [](https://www.activepieces.com/docs/admin-guide/guides/scim/providers/okta#) Click **Add Attribute** and fill form with: | Field | Value | | --- | --- | | `Display name` | `platformRole` | | `Variable name` | `platformRole` | | `External name` | `platformRole` | | `External namespace` | `urn:ietf:params:scim:schemas:activepieces:1.0:CustomUserAttributes` | | `Enum` | `enabled` | For **Attribute members**, add: | Display name | Value | | --- | --- | | `ADMIN` | `ADMIN` | | `MEMBER` | `MEMBER` | | `OPERATOR` | `OPERATOR` | ![Okta add attribute image](https://mintcdn.com/activepieces/Jz9nlyeTn6NzuJkR/resources/screenshots/scim/okta/add-attribute.png?w=2500&fit=max&auto=format&n=Jz9nlyeTn6NzuJkR&q=85&s=d80e100c6c21ddca7b1abc4e71b4bcb6)Finally click save. 3 [](https://www.activepieces.com/docs/admin-guide/guides/scim/providers/okta#) This step assumes that you already have a field in the Okta user profile that you can map to platformRole in your Activepieces user profile. If you don’t have one, you can create a new field in **Directory -> Profile Editor -> User (default)**. * Back to your Activepieces application page in **Provisioning -> To App -> Attribute Mappings** * Scroll down and click **Show Unmapped Attributes** * Edit `platformRole` field * Here you need to map the attribute value from your Okta user profile. If you already have a role field in the Okta user profile that matches exactly with a platformRole value (`ADMIN`, `MEMBER`, `OPERATOR`) then you can select it directly with `Map from Okta Profile` option, otherwise you can use an [Expression](https://developer.okta.com/docs/reference/okta-expression-language/) to return one of the 3 roles based on other fields in the Okta user profile. Here is an example of an expression:![Okta role expression example](https://mintcdn.com/activepieces/Jz9nlyeTn6NzuJkR/resources/screenshots/scim/okta/role-expression.png?w=2500&fit=max&auto=format&n=Jz9nlyeTn6NzuJkR&q=85&s=c18b87bea8c5785d5d555df3727726b7) Please make sure the return value to always be one of `ADMIN`, `MEMBER` or `OPERATOR` [​](https://www.activepieces.com/docs/admin-guide/guides/scim/providers/okta#provision-and-deprovision-users) Provision and Deprovision Users ------------------------------------------------------------------------------------------------------------------------------------------------ ### [​](https://www.activepieces.com/docs/admin-guide/guides/scim/providers/okta#provision) Provision In the Activepieces application page, go to **Provisioning -> To App** and enable the actions you want to be applied to Activepieces when changes occur in Okta. ![Okta role expression example](https://mintcdn.com/activepieces/Jz9nlyeTn6NzuJkR/resources/screenshots/scim/okta/provision-actions.png?w=2500&fit=max&auto=format&n=Jz9nlyeTn6NzuJkR&q=85&s=a87b3654367a5488ebf9c1df21a4fb1e) Now in the **Assignments** tab you can: * Choose to provision individual users or groups. Note that groups in Okta will be projects in Activepieces. * In case you don’t have groups and you want to provision your Okta users at once, you can assign the `Everyone` group. * When editing/creating users in an assigned group (including `Everyone`), they should be updated in Activepieces. * To push groups to Activepieces, go to the **Push groups** tab and click on the push button, find the group and save. Default role for users in projects will be `Editor` role, right now there is no way to link the project role with Okta ![Okta role expression example](https://mintcdn.com/activepieces/Jz9nlyeTn6NzuJkR/resources/screenshots/scim/okta/push-group.png?w=2500&fit=max&auto=format&n=Jz9nlyeTn6NzuJkR&q=85&s=103f6e00e03fc97a777549789c1f69f3) Created users in Activepieces will receive a welcome email. When clicked, they will be redirected to sign in with `SAML`. ### [​](https://www.activepieces.com/docs/admin-guide/guides/scim/providers/okta#deprovision) Deprovision Users’ state switches to `INACTIVE` in Activepieces only when they are deactivated in Okta. Suspension or deletion in Okta does not reflect in Activepieces because of Okta’s design. For groups you can delete them in **Push groups** tab -> click on button in **Push Status** column -> Unlink pushed group -> Delete the group in target Deleting a group will delete the whole project in Activepieces with its flows and connections. Users linked to that group won’t be affected. [​](https://www.activepieces.com/docs/admin-guide/guides/scim/providers/okta#troubleshooting) Troubleshooting ---------------------------------------------------------------------------------------------------------------- Connector test fails in Okta * Confirm SCIM base URL is correct. * Ensure the `Authorization` header uses `Bearer` format. Users are not provisioned * Ensure users are assigned to the Okta app. * Confirm provisioning actions are enabled in Okta. Attributes are not updating * Recheck mappings in **Provisioning -> To App**. * Ensure `userName` uses a stable unique value (usually email). [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/admin-guide/guides/scim/providers/okta.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/admin-guide/guides/scim/providers/okta) [SCIM Overview](https://www.activepieces.com/docs/admin-guide/guides/scim/overview) [Override OAuth2 Apps](https://www.activepieces.com/docs/admin-guide/guides/manage-oauth2) ⌘I --- # Project Releases - Activepieces [Skip to main content](https://www.activepieces.com/docs/admin-guide/guides/project-releases#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Guides Project Releases [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Overview](https://www.activepieces.com/docs/admin-guide/guides/project-releases#overview) * [Prerequisites](https://www.activepieces.com/docs/admin-guide/guides/project-releases#prerequisites) * [Enabling Environments](https://www.activepieces.com/docs/admin-guide/guides/project-releases#enabling-environments) * [Getting Started](https://www.activepieces.com/docs/admin-guide/guides/project-releases#getting-started) * [Connecting Git (Optional)](https://www.activepieces.com/docs/admin-guide/guides/project-releases#connecting-git-optional) * [Creating a Release](https://www.activepieces.com/docs/admin-guide/guides/project-releases#creating-a-release) * [From Project](https://www.activepieces.com/docs/admin-guide/guides/project-releases#from-project) * [From Git](https://www.activepieces.com/docs/admin-guide/guides/project-releases#from-git) * [Push Everything to Git](https://www.activepieces.com/docs/admin-guide/guides/project-releases#push-everything-to-git) * [Pushing Individual Flows or Tables](https://www.activepieces.com/docs/admin-guide/guides/project-releases#pushing-individual-flows-or-tables) * [Rolling Back a Release](https://www.activepieces.com/docs/admin-guide/guides/project-releases#rolling-back-a-release) * [Release Details](https://www.activepieces.com/docs/admin-guide/guides/project-releases#release-details) * [Understanding the Changes Preview](https://www.activepieces.com/docs/admin-guide/guides/project-releases#understanding-the-changes-preview) * [Flow Changes](https://www.activepieces.com/docs/admin-guide/guides/project-releases#flow-changes) * [Connection Changes](https://www.activepieces.com/docs/admin-guide/guides/project-releases#connection-changes) * [Table Changes](https://www.activepieces.com/docs/admin-guide/guides/project-releases#table-changes) * [Best Practices](https://www.activepieces.com/docs/admin-guide/guides/project-releases#best-practices) * [Permissions](https://www.activepieces.com/docs/admin-guide/guides/project-releases#permissions) * [Troubleshooting](https://www.activepieces.com/docs/admin-guide/guides/project-releases#troubleshooting) Project Releases allow you to sync flows, connections, and tables between different projects—essential for teams that want to develop in one environment and deploy to another with confidence. **Example:** Build and test your automations in a **Staging** project, then seamlessly promote them to **Production** when ready. Simply navigate to your Production project → **Releases** → create a release from Staging, and all your changes will be applied instantly. [​](https://www.activepieces.com/docs/admin-guide/guides/project-releases#overview) Overview ----------------------------------------------------------------------------------------------- There are three ways to create a release: | Source | Description | | --- | --- | | **Git** | Pull changes from a connected Git repository | | **Project** | Copy flows from another project in your instance | | **Rollback** | Restore a previous release state | [​](https://www.activepieces.com/docs/admin-guide/guides/project-releases#prerequisites) Prerequisites --------------------------------------------------------------------------------------------------------- ### [​](https://www.activepieces.com/docs/admin-guide/guides/project-releases#enabling-environments) Enabling Environments In your project dashboard, go to settings then to Environments and hit the enable button. ![Enable Environments](https://mintcdn.com/activepieces/HfEX6NmvKT3DcQHg/resources/screenshots/enable-environments-1.png?w=2500&fit=max&auto=format&n=HfEX6NmvKT3DcQHg&q=85&s=c2a759e07462c9e7ea01af1176987b96) ![Enable Environments](https://mintcdn.com/activepieces/HfEX6NmvKT3DcQHg/resources/screenshots/enable-environments-2.png?w=2500&fit=max&auto=format&n=HfEX6NmvKT3DcQHg&q=85&s=11806d38af71f64d29c9f27ad3f12837) [​](https://www.activepieces.com/docs/admin-guide/guides/project-releases#getting-started) Getting Started ------------------------------------------------------------------------------------------------------------- Navigate to the **Releases** page from your project sidebar to view all releases and create new ones. ![Project Releases Page](https://mintcdn.com/activepieces/HfEX6NmvKT3DcQHg/resources/screenshots/project-releases-page.png?w=2500&fit=max&auto=format&n=HfEX6NmvKT3DcQHg&q=85&s=97f1f19656a9a1f3923c60d28c062568) [​](https://www.activepieces.com/docs/admin-guide/guides/project-releases#connecting-git-optional) Connecting Git (Optional) ------------------------------------------------------------------------------------------------------------------------------- If you want to use Git to track your changes, you’ll need to connect a Git repository first. This requires the Environments feature to be enabled. [​](https://www.activepieces.com/docs/admin-guide/guides/project-releases#creating-a-release) Creating a Release ------------------------------------------------------------------------------------------------------------------- ### [​](https://www.activepieces.com/docs/admin-guide/guides/project-releases#from-project) From Project Apply changes from flows, connections and tables in one project to another. 1 [](https://www.activepieces.com/docs/admin-guide/guides/project-releases#) Open Create Release Menu Click the **Create Release** dropdown button. 2 [](https://www.activepieces.com/docs/admin-guide/guides/project-releases#) Select From Project Choose **From Project** from the dropdown menu. 3 [](https://www.activepieces.com/docs/admin-guide/guides/project-releases#) Select Source Project Choose the project you want to copy flows, connections and tables from. 4 [](https://www.activepieces.com/docs/admin-guide/guides/project-releases#) Review and Apply Review the changes, and click **Apply Changes**. ![Create Release from Project](https://mintcdn.com/activepieces/43FONS7ax8WC7q2h/resources/screenshots/create-release-from-project-1.png?w=2500&fit=max&auto=format&n=43FONS7ax8WC7q2h&q=85&s=de30f0867b1a202127ae6925f90c99c2) ![Create Release from Project](https://mintcdn.com/activepieces/43FONS7ax8WC7q2h/resources/screenshots/create-release-from-project-2.png?w=2500&fit=max&auto=format&n=43FONS7ax8WC7q2h&q=85&s=9e6444bda5b19835f2b4608531e3be13) New connections created during a release are placeholders and need to be reconnected with valid credentials after the release is applied. ### [​](https://www.activepieces.com/docs/admin-guide/guides/project-releases#from-git) From Git 1 [](https://www.activepieces.com/docs/admin-guide/guides/project-releases#) Open Create Release Menu Click the **Create Release** dropdown button. 2 [](https://www.activepieces.com/docs/admin-guide/guides/project-releases#) Select From Git Choose **From Git** from the dropdown menu. 3 [](https://www.activepieces.com/docs/admin-guide/guides/project-releases#) Review Changes A dialog will appear showing all the changes that will be applied: * **Flows Changes**: New, updated, or deleted flows * **Connections Changes**: New or renamed connections * **Tables Changes**: New, updated, or deleted tables 4 [](https://www.activepieces.com/docs/admin-guide/guides/project-releases#) Select Changes Check or uncheck the flows you want to include in this release. 5 [](https://www.activepieces.com/docs/admin-guide/guides/project-releases#) Add Release Details Enter a **Name** and optional **Description** for your release. 6 [](https://www.activepieces.com/docs/admin-guide/guides/project-releases#) Apply Changes Click **Apply Changes** to create the release. ![Create Release from Git](https://mintcdn.com/activepieces/43FONS7ax8WC7q2h/resources/screenshots/create-git-release.png?w=2500&fit=max&auto=format&n=43FONS7ax8WC7q2h&q=85&s=94ae5aecdf6f380294af77f1f2eab362) [​](https://www.activepieces.com/docs/admin-guide/guides/project-releases#push-everything-to-git) Push Everything to Git --------------------------------------------------------------------------------------------------------------------------- If your project is connected to a Git repository, you can push all your flows, connections, and tables to Git. 1 [](https://www.activepieces.com/docs/admin-guide/guides/project-releases#) Click Push Everything Click the **Push Everything** button on the releases page. 2 [](https://www.activepieces.com/docs/admin-guide/guides/project-releases#) Enter Commit Message Write a descriptive commit message explaining your changes. 3 [](https://www.activepieces.com/docs/admin-guide/guides/project-releases#) Push Click **Push** to send all published flows to the Git repository. ![Push Everything to Git Dialog](https://mintcdn.com/activepieces/HfEX6NmvKT3DcQHg/resources/screenshots/push-everything-to-git.png?w=2500&fit=max&auto=format&n=HfEX6NmvKT3DcQHg&q=85&s=6968bf1e81d51b3b77ab74e0593d8642) [​](https://www.activepieces.com/docs/admin-guide/guides/project-releases#pushing-individual-flows-or-tables) Pushing Individual Flows or Tables --------------------------------------------------------------------------------------------------------------------------------------------------- You can also push specific flows or tables to Git without pushing everything. You can only push published flows to git 1 [](https://www.activepieces.com/docs/admin-guide/guides/project-releases#) Select Items Navigate to your flows or tables and select the items you want to push. 2 [](https://www.activepieces.com/docs/admin-guide/guides/project-releases#) Open Push Dialog Click the **Push to Git** option. 3 [](https://www.activepieces.com/docs/admin-guide/guides/project-releases#) Enter Commit Message Provide a commit message describing what you’re pushing. 4 [](https://www.activepieces.com/docs/admin-guide/guides/project-releases#) Push Click **Push** to send the selected items to Git. ![Push to Git Dialog](https://mintcdn.com/activepieces/HfEX6NmvKT3DcQHg/resources/screenshots/push-flows-to-git-1.png?w=2500&fit=max&auto=format&n=HfEX6NmvKT3DcQHg&q=85&s=4a8d86ac88f19fd22950fca77304226b) ![Push to Git Dialog](https://mintcdn.com/activepieces/HfEX6NmvKT3DcQHg/resources/screenshots/push-flows-to-git-2.png?w=2500&fit=max&auto=format&n=HfEX6NmvKT3DcQHg&q=85&s=91eddf7b759457b51720a3123dbb0dec) [​](https://www.activepieces.com/docs/admin-guide/guides/project-releases#rolling-back-a-release) Rolling Back a Release --------------------------------------------------------------------------------------------------------------------------- If something goes wrong after applying a release, you can easily rollback to a previous state. 1 [](https://www.activepieces.com/docs/admin-guide/guides/project-releases#) Find the Release Locate the release you want to rollback to in the releases list. 2 [](https://www.activepieces.com/docs/admin-guide/guides/project-releases#) Click Rollback Click the rollback icon (↩) next to the release. 3 [](https://www.activepieces.com/docs/admin-guide/guides/project-releases#) Review Changes Review the changes that will be applied to restore that release state. 4 [](https://www.activepieces.com/docs/admin-guide/guides/project-releases#) Apply Rollback Select the changes to include and click **Apply Changes**. ![Rollback Release](https://mintcdn.com/activepieces/HfEX6NmvKT3DcQHg/resources/screenshots/rollback-release.png?w=2500&fit=max&auto=format&n=HfEX6NmvKT3DcQHg&q=85&s=83adc856e4f067ddaf32733313001ccb) [​](https://www.activepieces.com/docs/admin-guide/guides/project-releases#release-details) Release Details ------------------------------------------------------------------------------------------------------------- Each release in the list shows: | Column | Description | | --- | --- | | **Name** | The name you gave the release | | **Source** | Where the release came from (Git, Project, or Rollback) | | **Imported At** | When the release was created | | **Imported By** | The user who created the release | Click on any release to view its full details. ![Release Details](https://mintcdn.com/activepieces/HfEX6NmvKT3DcQHg/resources/screenshots/release-details.png?w=2500&fit=max&auto=format&n=HfEX6NmvKT3DcQHg&q=85&s=4ea39e90eac163d569b7d18623fc7213) [​](https://www.activepieces.com/docs/admin-guide/guides/project-releases#understanding-the-changes-preview) Understanding the Changes Preview ------------------------------------------------------------------------------------------------------------------------------------------------- When creating a release, you’ll see a preview of all changes: ### [​](https://www.activepieces.com/docs/admin-guide/guides/project-releases#flow-changes) Flow Changes * New flows that will be created * Existing flows that will be updated * Flows that will be deleted ### [​](https://www.activepieces.com/docs/admin-guide/guides/project-releases#connection-changes) Connection Changes * New connections are placeholders and must be reconnected after the release * Renamed connections ### [​](https://www.activepieces.com/docs/admin-guide/guides/project-releases#table-changes) Table Changes * New, updated, and deleted tables are shown with their respective indicators [​](https://www.activepieces.com/docs/admin-guide/guides/project-releases#best-practices) Best Practices ----------------------------------------------------------------------------------------------------------- Use Descriptive Names --------------------- Give your releases meaningful names like “v1.2.0 - Added email notifications” to easily identify them later. Review Before Applying ---------------------- Always review the changes preview carefully before applying a release to avoid unexpected modifications. Test in Development ------------------- If using Git sync, test changes in a development project before deploying to production. Document Changes ---------------- Use the description field to document what changed and why for future reference. [​](https://www.activepieces.com/docs/admin-guide/guides/project-releases#permissions) Permissions ----------------------------------------------------------------------------------------------------- To create and manage releases, you need the **Write Project Release** permission. Contact your instance administrator if you don’t have access to the releases feature. [​](https://www.activepieces.com/docs/admin-guide/guides/project-releases#troubleshooting) Troubleshooting ------------------------------------------------------------------------------------------------------------- Environment settings are locked The Environments feature must be enabled on your instance plan to use Git sync. Contact your instance administrator to upgrade your plan or enable this feature. Git connection fails * Verify your SSH private key is correctly formatted (ends with an endline), and make sure it has an empty phrase. * Ensure the remote URL is in SSH format (not HTTPS) * Check that the branch exists in the repository No changes detected If no changes appear when creating a release, it means your current project is already in sync with the source. Connection placeholders After applying a release with new connections, navigate to the Connections page and reconnect them with valid credentials. Push Everything button not visible Make sure you configured your git settings and if you are selecting flows, make sure they are published. Cannot find Environment settings Navigate to **Project Settings** from the sidebar, then click on **Environment**. If you don’t see this option, the Environments feature may not be enabled for your instance. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/admin-guide/guides/project-releases.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/admin-guide/guides/project-releases) [Event Streaming](https://www.activepieces.com/docs/admin-guide/guides/event-streaming) [Security & Data Practices](https://www.activepieces.com/docs/admin-guide/security/practices) ⌘I --- # AWS Secrets Manager - Activepieces [Skip to main content](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/aws#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Secret Managers AWS Secrets Manager [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Prerequisites](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/aws#prerequisites) * [Step 1 — Create an IAM policy for Secrets Manager access](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/aws#step-1-%E2%80%94-create-an-iam-policy-for-secrets-manager-access) * [Step 2 — Create an IAM user and attach the policy](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/aws#step-2-%E2%80%94-create-an-iam-user-and-attach-the-policy) * [Step 3 — Connect in Activepieces](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/aws#step-3-%E2%80%94-connect-in-activepieces) * [Using AWS Secrets Manager in connections](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/aws#using-aws-secrets-manager-in-connections) AWS Secrets Manager helps you protect access to your applications, services, and IT resources. This integration uses **IAM user credentials** (Access Key + Secret Key) to authenticate directly with AWS Secrets Manager. [​](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/aws#prerequisites) Prerequisites ------------------------------------------------------------------------------------------------------------ * An AWS account with permissions to create IAM users and policies * Permissions to create and manage secrets in AWS Secrets Manager [​](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/aws#step-1-%E2%80%94-create-an-iam-policy-for-secrets-manager-access) Step 1 — Create an IAM policy for Secrets Manager access ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Create an IAM policy that grants read access to the secrets Activepieces will retrieve. 1. Open the [IAM console → Policies → Create policy](https://console.aws.amazon.com/iam/home#/policies$new?step=edit) . 2. Switch to the **JSON** tab and paste: { "Version": "2012-10-17", "Statement": [\ {\ "Effect": "Allow",\ "Action": [\ "secretsmanager:GetSecretValue",\ "secretsmanager:ListSecrets",\ "secretsmanager:DescribeSecret"\ ],\ "Resource": "*"\ }\ ] } For production, scope `Resource` to the specific secret ARNs Activepieces needs instead of using `"*"`. 3. Click **Next**, name the policy (e.g. `ActivepiecesSecretsReadOnly`), and create it. [​](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/aws#step-2-%E2%80%94-create-an-iam-user-and-attach-the-policy) Step 2 — Create an IAM user and attach the policy -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 1. Open the [IAM console → Users → Create user](https://console.aws.amazon.com/iam/home#/users$new) . 2. Enter a username (e.g. `activepieces-secrets-user`) and click **Next**. 3. Select **Attach policies directly**, find and attach the policy created in Step 1, then click **Next** and **Create user**. 4. Open the newly created user, go to the **Security credentials** tab, and click **Create access key**. 5. Select **Application running outside AWS**, click **Next**, then **Create access key**. 6. Copy the **Access Key** and **Secret Key** — you will need both in the next step. [​](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/aws#step-3-%E2%80%94-connect-in-activepieces) Step 3 — Connect in Activepieces ---------------------------------------------------------------------------------------------------------------------------------------------------------- 1. Go to **Platform Admin → Security → Secret Managers**. 2. Select **AWS Secrets Manager** from the provider list. 3. Enter the connection details: * **Access Key** — the Access Key ID from Step 2 (e.g. `AKIAIOSFODNN7EXAMPLE`). * **Secret Key** — the Secret Access Key from Step 2. * **Region** — the AWS region where your secrets are stored (e.g. `us-east-1`). 4. Click **Connect** to test and save the connection. [​](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/aws#using-aws-secrets-manager-in-connections) Using AWS Secrets Manager in connections ------------------------------------------------------------------------------------------------------------------------------------------------------------------ When configuring a global connection that requires credentials: 1. Click the **key icon** (🔑) next to the credential field. 2. Select **AWS Secrets Manager** as the secret manager. 3. Fill in: * **Secret Name** — the friendly name of the secret in AWS Secrets Manager. * **Secret Json key** — Key of row for the stored secret. Activepieces will use the configured credentials to retrieve the secret value and inject it into the connection at runtime. If you update existing secrets and you can’t see the update reflected . refer to [caching](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/overview#caching) [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/admin-guide/guides/secret-managers/aws.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/admin-guide/guides/secret-managers/aws) [Overview](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/overview) [HashiCorp Vault](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/hashicorp) ⌘I --- # HashiCorp Vault - Activepieces [Skip to main content](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/hashicorp#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Secret Managers HashiCorp Vault [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Prerequisites](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/hashicorp#prerequisites) * [Policies](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/hashicorp#policies) * [Connecting to Activepieces](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/hashicorp#connecting-to-activepieces) * [Using HashiCorp Vault Secrets](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/hashicorp#using-hashicorp-vault-secrets) HashiCorp Vault is an enterprise-grade secrets management system that provides secure storage and access to secrets, API keys, passwords, and other sensitive data. [​](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/hashicorp#prerequisites) Prerequisites ------------------------------------------------------------------------------------------------------------------ Before connecting HashiCorp Vault to Activepieces, ensure you have: * **HashiCorp Vault Key-value (KV) secrets engine** version 2 * **AppRole auth method** [enabled](https://developer.hashicorp.com/vault/docs/auth/approle) * **One or more AppRoles** [configured](https://developer.hashicorp.com/vault/docs/auth/approle) with appropriate policies [​](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/hashicorp#policies) Policies -------------------------------------------------------------------------------------------------------- Enable The created AppRole to access your secrets engine(s) by adding the following to your policy path "sys/mounts" { capabilities = [ "read" ] } path "/data/" { capabilities = [ "read" ] } or path "sys/mounts" { capabilities = [ "read" ] } path "/data/*" { capabilities = [ "read" ] } [​](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/hashicorp#connecting-to-activepieces) Connecting to Activepieces -------------------------------------------------------------------------------------------------------------------------------------------- 1. Go to **Platform Admin → Security → Secret Managers** 2. Click **New Connection** and select **HashiCorp Vault** 3. Enter a **Name** for the connection 4. Choose a **Scope** — **Platform** to make it available to all projects, or **Project** to restrict it to specific projects 5. Fill in the connection details: * **URL**: Your Vault server URL (e.g., `http://localhost:8200`) * **Role ID**: The Role ID from your AppRole configuration * **Secret ID**: The Secret ID from your AppRole configuration * **Namespace** (optional): Vault namespace if using Vault Enterprise namespaces 6. Click **Save** to test and save the connection [​](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/hashicorp#using-hashicorp-vault-secrets) Using HashiCorp Vault Secrets -------------------------------------------------------------------------------------------------------------------------------------------------- Once the connection is saved, you can reference Vault secrets inside any piece connection dialog — in global connections (Platform Admin) or directly in the flow builder. 1. Open a connection dialog and click the **key icon** (🔑) next to a credential field 2. Select your HashiCorp Vault connection from the dropdown 3. Enter the secret path in the format: `mount/data/path/to/secret/key` For example, if you stored a secret with: vault kv put -mount=secret mysec api_key='supersecret' The path to enter would be: secret/data/mysec/api_key ![Manage Oauth2 apps](https://mintcdn.com/activepieces/yqMjtHswhi3w4D2R/resources/screenshots/secret-manager.png?w=2500&fit=max&auto=format&n=yqMjtHswhi3w4D2R&q=85&s=608015daeff79c8368a12c5fa2d488e0) The connection will automatically retrieve the secret from Vault when the flow runs. If you update a secret in Vault and the change isn’t reflected in your flows, the cached value may still be active. Use the **refresh icon** next to the connection in the Secret Managers page to clear its cache immediately, or wait up to 1 hour for it to expire automatically. See [Caching](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/overview#caching) for details. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/admin-guide/guides/secret-managers/hashicorp.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/admin-guide/guides/secret-managers/hashicorp) [AWS Secrets Manager](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/aws) [CyberArk Conjur](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/cyberark-conjur) ⌘I --- # How to Structure Projects - Activepieces [Skip to main content](https://www.activepieces.com/docs/admin-guide/guides/structure-projects#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Guides How to Structure Projects [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) This feature is available in our paid editions. Contact us [here](https://www.activepieces.com/sales) , and we'll be delighted to assist you! Projects in Activepieces are the main units for organizing your automations and resources within your organization. Every project contains its own flows, connections, and tables. Access to these resources is shared among everyone who has access to that project. There are two types of projects: * **Personal Projects**: Each user invited to your organization automatically receives a personal project. This is a private space where only that user can create and manage flows, connections, and tables. * **Team Projects**: Team projects are shared spaces that can be created and managed from this page. Multiple users can be invited to a team project, allowing them to collaborate, share access to flows, connections, and tables, and work together. When organizing your work, create team projects for group collaboration and utilize personal projects for individual or private tasks. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/admin-guide/guides/structure-projects.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/admin-guide/guides/structure-projects) [How to Manage Pieces](https://www.activepieces.com/docs/admin-guide/guides/manage-pieces) ⌘I --- # CyberArk Conjur - Activepieces [Skip to main content](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/cyberark-conjur#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Secret Managers CyberArk Conjur [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Prerequisites](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/cyberark-conjur#prerequisites) * [Conjur host configuration for Activepieces](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/cyberark-conjur#conjur-host-configuration-for-activepieces) * [Example policy (Activepieces)](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/cyberark-conjur#example-policy-activepieces) * [Policy steps (summary)](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/cyberark-conjur#policy-steps-summary) * [Server URL and organization](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/cyberark-conjur#server-url-and-organization) * [Connecting to Activepieces](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/cyberark-conjur#connecting-to-activepieces) * [Using CyberArk Conjur secrets in connections](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/cyberark-conjur#using-cyberark-conjur-secrets-in-connections) CyberArk Conjur is a secrets management solution that provides secure storage and access to credentials. Integration with Activepieces uses **host/API key authentication**: Activepieces authenticates as a Conjur host, receives a short-lived token, and uses it to retrieve secrets for which that host has `read` and `execute` permissions. Conjur policies are defined in `.yml` files. For recommended structure and patterns, see [Policy best practices](https://docs.cyberark.com/conjur-enterprise/13.0/en/Content/Operations/Policy/policy-best-practices.htm) in the CyberArk Conjur documentation. For policy syntax and operators, see the [Policy syntax](https://docs.cyberark.com/conjur-open-source/Latest/en/Content/Operations/Policy/policy-syntax.htm) reference. [​](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/cyberark-conjur#prerequisites) Prerequisites ------------------------------------------------------------------------------------------------------------------------ * A Conjur server (Conjur Cloud, Conjur Enterprise, or Conjur Open Source) * A Conjur policy that defines a host for Activepieces and grants it access to the variables you want to use [​](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/cyberark-conjur#conjur-host-configuration-for-activepieces) Conjur host configuration for Activepieces ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- To allow Activepieces to read secrets, configure a Conjur policy that declares a group, variables, a host, a layer, and the right permissions. The steps below describe how to create that policy file. ### [​](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/cyberark-conjur#example-policy-activepieces) Example policy (Activepieces) The following policy defines a policy `activepieces` with a group, two variables, a host, a layer, and the grants so the host can read the variables. - !policy id: activepieces body: - !group activepieces-secrets - &variables - !variable id: key-1 kind: password - !variable id: key-2 kind: password - !permit role: !group /activepieces/activepieces-secrets privileges: [read, update, execute] resources: *variables - !host activepieces - !layer activepieces - !grant role: !layer activepieces members: - !host activepieces - !grant role: !group activepieces-secrets member: !layer activepieces ### [​](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/cyberark-conjur#policy-steps-summary) Policy steps (summary) 1. **Declare a group** at the root of the policy (e.g. `activepieces-secrets`). This group will be allowed to read (and optionally execute) the variables. 2. **Declare variables** and give the group `read` and `execute` on them (so the host can fetch secret values): - &variables - !variable id: my-secret kind: password - !permit role: !group /your-policy/your-group privileges: [read, execute] resources: *variables 3. **Declare the host** that Activepieces will use (e.g. `activepieces`) and a **layer** (e.g. `activepieces`), and add the host to the layer: - !host activepieces - !layer activepieces - !grant role: !layer activepieces members: - !host activepieces 4. **Grant the layer membership in the group** that has access to the variables: - !grant role: !group activepieces-secrets member: !layer activepieces 5. **Load the policy** into Conjur. Conjur will create the host and return an **API key** for that host. You will use this API key and the host identity when connecting Activepieces. After loading the policy, Conjur returns something like: { "created_roles": { "conjur:host:activepieces/activepieces": { "id": "conjur:host:activepieces/activepieces", "api_key": "" } }, "version": 1 } Store the **api\_key** securely; you will enter it in Activepieces as the **API Key**. [​](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/cyberark-conjur#server-url-and-organization) Server URL and organization ---------------------------------------------------------------------------------------------------------------------------------------------------- * **Conjur Cloud**: Use a URL of the form `https://.secretsmgr.cyberark.cloud/api/` and set **Organization account name** to `conjur` unless your Cloud tenant uses a different account. * **On-prem / Enterprise**: Use your Conjur server base URL (e.g. `https://conjur.example.com`) and your organization account name. [​](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/cyberark-conjur#connecting-to-activepieces) Connecting to Activepieces -------------------------------------------------------------------------------------------------------------------------------------------------- 1. Go to **Platform Admin → Security → Secret Managers**. 2. Select **CyberArk Conjur** from the provider list. 3. Enter the connection details: * **URL**: Conjur server URL (e.g. `https://conjur.example.com` or Conjur Cloud URL above). Do not add a trailing slash. * **Organization account name**: Your Conjur account (e.g. `conjur` for Conjur Cloud). * **Login ID**: For host authentication this must be the Conjur host ID with a `host/` prefix, e.g. `host/activepieces/activepieces` (policy id and host name as in your policy). * **API Key**: The host API key returned when the host was created (see policy load response above). 4. Click **Connect** to test and save the connection. [​](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/cyberark-conjur#using-cyberark-conjur-secrets-in-connections) Using CyberArk Conjur secrets in connections -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- When configuring a connection that uses a secret: 1. Click the **key icon** (🔑) next to the credential field. 2. Select a **CyberArk Conjur** connection from the list. 3. Enter the **Secret key**: the Conjur variable path in the form `policy_id/variable_id`. For the example policy above, use: * `activepieces/key-1` * `activepieces/key-2` Activepieces will authenticate as the configured host and retrieve the secret from Conjur when the flow runs. If you update existing secrets and you can’t see the update reflected . refer to [caching](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/overview#caching) [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/admin-guide/guides/secret-managers/cyberark-conjur.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/admin-guide/guides/secret-managers/cyberark-conjur) [HashiCorp Vault](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/hashicorp) [1Password](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/onepassword) ⌘I --- # 1Password - Activepieces [Skip to main content](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/onepassword#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Secret Managers 1Password [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Prerequisites](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/onepassword#prerequisites) * [Step 1 — Create a service account](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/onepassword#step-1-%E2%80%94-create-a-service-account) * [Step 2 — Connect in Activepieces](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/onepassword#step-2-%E2%80%94-connect-in-activepieces) * [Using 1Password in connections](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/onepassword#using-1password-in-connections) * [Example secret references](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/onepassword#example-secret-references) 1Password Secrets Automation lets you securely store and retrieve credentials from 1Password vaults. This integration uses a **service account token** to authenticate with the 1Password SDK. [​](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/onepassword#prerequisites) Prerequisites -------------------------------------------------------------------------------------------------------------------- * A 1Password account with the **Teams** or **Business** plan (service accounts require a paid plan) * Permission to create service accounts in your 1Password account [​](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/onepassword#step-1-%E2%80%94-create-a-service-account) Step 1 — Create a service account -------------------------------------------------------------------------------------------------------------------------------------------------------------------- 1. Sign in to [1password.com](https://1password.com/) and go to **Developer Tools → Service Accounts**. 2. Click **Create a service account**. 3. Give it a name (e.g. `Activepieces`). 4. Grant it **Read Items** access on the vaults Activepieces needs to access. 5. Click **Create service account** and copy the token — it starts with `ops_` and is shown only once. Store the token securely. Once you leave the page, 1Password will not show it again. [​](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/onepassword#step-2-%E2%80%94-connect-in-activepieces) Step 2 — Connect in Activepieces ------------------------------------------------------------------------------------------------------------------------------------------------------------------ 1. Go to **Platform Admin → Security → Secret Managers**. 2. Select **1Password** from the provider list. 3. Paste the **Service Account Token** from Step 1. 4. Click **Connect** to test and save the connection. [​](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/onepassword#using-1password-in-connections) Using 1Password in connections ------------------------------------------------------------------------------------------------------------------------------------------------------ When configuring a global connection that requires credentials: 1. Click the **key icon** (🔑) next to the credential field. 2. Select a **1Password** connection from the list. 3. Enter the **Secret Reference** in the format: op://vault/item/field * **vault** — the vault name or ID (e.g. `Production`) * **item** — the item title or ID (e.g. `Stripe`) * **field** — the field label within the item (e.g. `password`, `api key`) Activepieces will retrieve the secret value from 1Password and inject it into the connection at runtime. [​](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/onepassword#example-secret-references) Example secret references -------------------------------------------------------------------------------------------------------------------------------------------- | 1Password location | Reference | | --- | --- | | Vault `Production` → Item `Stripe` → Field `Secret Key` | `op://Production/Stripe/Secret Key` | | Vault `Shared` → Item `Database` → Field `password` | `op://Shared/Database/password` | If you update existing secrets and you can’t see the update reflected, refer to [caching](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/overview#caching) . [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/admin-guide/guides/secret-managers/onepassword.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/admin-guide/guides/secret-managers/onepassword) [CyberArk Conjur](https://www.activepieces.com/docs/admin-guide/guides/secret-managers/cyberark-conjur) [Manage User Roles](https://www.activepieces.com/docs/admin-guide/guides/permissions) ⌘I --- # Flow Created - Activepieces [Skip to main content](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-created#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Audit Logs Flow Created [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) Example { "id": "", "created": "", "updated": "", "platformId": "", "action": "flow.created", "data": { "flow": { "id": "", "created": "", "updated": "" } }, "projectId": "", "projectDisplayName": "", "userId": "", "userEmail": "", "ip": "" } [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-created#schema-id) id string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-created#schema-created) created string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-created#schema-updated) updated string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-created#schema-platform-id) platformId string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-created#schema-action) action enum required Available options: `flow.created` [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-created#schema-data) data object required Show child attributes [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-created#schema-project-id) projectId string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-created#schema-project-display-name) projectDisplayName string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-created#schema-user-id) userId string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-created#schema-user-email) userEmail string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-created#schema-ip) ip string [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/admin-guide/security/audit-logs/flow-created.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/admin-guide/security/audit-logs/flow-created) [Overview](https://www.activepieces.com/docs/admin-guide/security/audit-logs/overview) [Flow Updated](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-updated) ⌘I --- # List Connections - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/connections/list#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Connections List Connections [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) cURL cURL curl --request GET \ --url https://cloud.activepieces.com/api/v1/app-connections \ --header 'Authorization: Bearer ' 200 { "data": [\ {\ "id": "",\ "created": "",\ "updated": "",\ "externalId": "",\ "displayName": "",\ "type": "OAUTH2",\ "pieceName": "",\ "projectIds": [\ ""\ ],\ "scope": "PROJECT",\ "status": "ACTIVE",\ "pieceVersion": "",\ "platformId": "",\ "ownerId": "",\ "owner": {\ "id": "",\ "email": "",\ "firstName": "",\ "status": "ACTIVE",\ "platformRole": "ADMIN",\ "lastName": "",\ "created": "",\ "updated": "",\ "externalId": "",\ "platformId": "",\ "lastActiveDate": "",\ "imageUrl": ""\ },\ "metadata": {},\ "flowIds": [\ ""\ ]\ }\ ], "next": "", "previous": "" } GET / v1 / app-connections Try it cURL cURL curl --request GET \ --url https://cloud.activepieces.com/api/v1/app-connections \ --header 'Authorization: Bearer ' 200 { "data": [\ {\ "id": "",\ "created": "",\ "updated": "",\ "externalId": "",\ "displayName": "",\ "type": "OAUTH2",\ "pieceName": "",\ "projectIds": [\ ""\ ],\ "scope": "PROJECT",\ "status": "ACTIVE",\ "pieceVersion": "",\ "platformId": "",\ "ownerId": "",\ "owner": {\ "id": "",\ "email": "",\ "firstName": "",\ "status": "ACTIVE",\ "platformRole": "ADMIN",\ "lastName": "",\ "created": "",\ "updated": "",\ "externalId": "",\ "platformId": "",\ "lastActiveDate": "",\ "imageUrl": ""\ },\ "metadata": {},\ "flowIds": [\ ""\ ]\ }\ ], "next": "", "previous": "" } #### Authorizations [​](https://www.activepieces.com/docs/endpoints/connections/list#authorization-authorization) Authorization string header required Use your api key generated from the admin console #### Query Parameters [​](https://www.activepieces.com/docs/endpoints/connections/list#parameter-cursor) cursor string [​](https://www.activepieces.com/docs/endpoints/connections/list#parameter-project-id) projectId string required [​](https://www.activepieces.com/docs/endpoints/connections/list#parameter-one-of-0) scope Option 1 · enumOption 2 · enumOption 1 · enumOption 2 · enum Available options: `PROJECT` [​](https://www.activepieces.com/docs/endpoints/connections/list#parameter-piece-name) pieceName string [​](https://www.activepieces.com/docs/endpoints/connections/list#parameter-display-name) displayName string [​](https://www.activepieces.com/docs/endpoints/connections/list#parameter-status) status enum\[\] Available options: `ACTIVE` [​](https://www.activepieces.com/docs/endpoints/connections/list#parameter-limit) limit number #### Response 200 - application/json Default Response [​](https://www.activepieces.com/docs/endpoints/connections/list#response-data) data object\[\] required Show child attributes [​](https://www.activepieces.com/docs/endpoints/connections/list#response-next-one-of-0) next string | null Cursor to the next page [​](https://www.activepieces.com/docs/endpoints/connections/list#response-previous-one-of-0) previous string | null Cursor to the previous page [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/connections/list.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/connections/list) [Upsert Connection](https://www.activepieces.com/docs/endpoints/connections/upsert) [Delete Connection](https://www.activepieces.com/docs/endpoints/connections/delete) ⌘I --- # Connection Schema - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/connections/schema#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Connections Connection Schema [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) Example { "id": "", "created": "", "updated": "", "externalId": "", "displayName": "", "type": "OAUTH2", "pieceName": "", "projectIds": [\ ""\ ], "scope": "PROJECT", "status": "ACTIVE", "pieceVersion": "", "platformId": "", "ownerId": "", "owner": { "id": "", "email": "", "firstName": "", "status": "ACTIVE", "platformRole": "ADMIN", "lastName": "", "created": "", "updated": "", "externalId": "", "platformId": "", "lastActiveDate": "", "imageUrl": "" }, "metadata": {}, "flowIds": [\ ""\ ] } App connection is a connection to an external app. [​](https://www.activepieces.com/docs/endpoints/connections/schema#schema-id) id string required [​](https://www.activepieces.com/docs/endpoints/connections/schema#schema-created) created string required [​](https://www.activepieces.com/docs/endpoints/connections/schema#schema-updated) updated string required [​](https://www.activepieces.com/docs/endpoints/connections/schema#schema-external-id) externalId string required [​](https://www.activepieces.com/docs/endpoints/connections/schema#schema-display-name) displayName string required [​](https://www.activepieces.com/docs/endpoints/connections/schema#schema-type-one-of-0) type Option 1 · enumOption 2 · enumOption 3 · enumOption 4 · enumOption 5 · enumOption 6 · enumOption 7 · enumOption 1 · enumOption 2 · enumOption 3 · enumOption 4 · enumOption 5 · enumOption 6 · enumOption 7 · enum required Available options: `OAUTH2` [​](https://www.activepieces.com/docs/endpoints/connections/schema#schema-piece-name) pieceName string required [​](https://www.activepieces.com/docs/endpoints/connections/schema#schema-project-ids) projectIds string\[\] required Pattern: `^[0-9a-zA-Z]{21}$` [​](https://www.activepieces.com/docs/endpoints/connections/schema#schema-scope-one-of-0) scope Option 1 · enumOption 2 · enumOption 1 · enumOption 2 · enum required Available options: `PROJECT` [​](https://www.activepieces.com/docs/endpoints/connections/schema#schema-status-one-of-0) status Option 1 · enumOption 2 · enumOption 3 · enumOption 1 · enumOption 2 · enumOption 3 · enum required Available options: `ACTIVE` [​](https://www.activepieces.com/docs/endpoints/connections/schema#schema-piece-version) pieceVersion string required [​](https://www.activepieces.com/docs/endpoints/connections/schema#schema-platform-id-one-of-0) platformId string | null [​](https://www.activepieces.com/docs/endpoints/connections/schema#schema-owner-id-one-of-0) ownerId string | null [​](https://www.activepieces.com/docs/endpoints/connections/schema#schema-owner-one-of-0) owner object Show child attributes [​](https://www.activepieces.com/docs/endpoints/connections/schema#schema-metadata-one-of-0) metadata object Show child attributes [​](https://www.activepieces.com/docs/endpoints/connections/schema#schema-flow-ids-one-of-0) flowIds string\[\] | null Pattern: `^[0-9a-zA-Z]{21}$` [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/connections/schema.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/connections/schema) [Delete Project Member](https://www.activepieces.com/docs/endpoints/project-members/delete) [Upsert Connection](https://www.activepieces.com/docs/endpoints/connections/upsert) ⌘I --- # Upsert Connection - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/connections/upsert#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Connections Upsert Connection [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) cURL cURL curl --request POST \ --url https://cloud.activepieces.com/api/v1/app-connections \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "externalId": "", "displayName": "", "pieceName": "", "projectId": "", "type": "SECRET_TEXT", "value": { "type": "SECRET_TEXT", "secret_text": "" }, "metadata": {}, "pieceVersion": "" } ' POST / v1 / app-connections Try it cURL cURL curl --request POST \ --url https://cloud.activepieces.com/api/v1/app-connections \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "externalId": "", "displayName": "", "pieceName": "", "projectId": "", "type": "SECRET_TEXT", "value": { "type": "SECRET_TEXT", "secret_text": "" }, "metadata": {}, "pieceVersion": "" } ' #### Authorizations [​](https://www.activepieces.com/docs/endpoints/connections/upsert#authorization-authorization) Authorization string header required Use your api key generated from the admin console #### Body application/json * Secret Text * OAuth2 * Cloud OAuth2 * Platform OAuth2 * Basic Auth * Custom Auth * No Auth Secret Text [​](https://www.activepieces.com/docs/endpoints/connections/upsert#body-one-of-0-external-id) externalId string required [​](https://www.activepieces.com/docs/endpoints/connections/upsert#body-one-of-0-display-name) displayName string required [​](https://www.activepieces.com/docs/endpoints/connections/upsert#body-one-of-0-piece-name) pieceName string required [​](https://www.activepieces.com/docs/endpoints/connections/upsert#body-one-of-0-project-id) projectId string required [​](https://www.activepieces.com/docs/endpoints/connections/upsert#body-one-of-0-type) type enum required Available options: `SECRET_TEXT` [​](https://www.activepieces.com/docs/endpoints/connections/upsert#body-one-of-0-value) value object required Show child attributes [​](https://www.activepieces.com/docs/endpoints/connections/upsert#body-one-of-0-metadata) metadata object Show child attributes [​](https://www.activepieces.com/docs/endpoints/connections/upsert#body-one-of-0-piece-version) pieceVersion string #### Response 200 Default Response [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/connections/upsert.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/connections/upsert) [Connection Schema](https://www.activepieces.com/docs/endpoints/connections/schema) [List Connections](https://www.activepieces.com/docs/endpoints/connections/list) ⌘I --- # Get Flow Run - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/flow-runs/get#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Flow Runs Get Flow Run [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) cURL cURL curl --request GET \ --url https://cloud.activepieces.com/api/v1/flow-runs/{id} \ --header 'Authorization: Bearer ' 200 { "id": "", "created": "", "updated": "", "projectId": "", "flowId": "", "failParentOnFailure": true, "flowVersionId": "", "status": "FAILED", "environment": "PRODUCTION", "parentRunId": "", "triggeredBy": "", "tags": [\ ""\ ], "flowVersion": { "displayName": "" }, "logsFileId": "", "startTime": "", "finishTime": "", "steps": {}, "failedStep": { "name": "", "displayName": "" }, "stepNameToTest": "", "archivedAt": null, "stepsCount": 123 } GET / v1 / flow-runs / {id} Try it cURL cURL curl --request GET \ --url https://cloud.activepieces.com/api/v1/flow-runs/{id} \ --header 'Authorization: Bearer ' 200 { "id": "", "created": "", "updated": "", "projectId": "", "flowId": "", "failParentOnFailure": true, "flowVersionId": "", "status": "FAILED", "environment": "PRODUCTION", "parentRunId": "", "triggeredBy": "", "tags": [\ ""\ ], "flowVersion": { "displayName": "" }, "logsFileId": "", "startTime": "", "finishTime": "", "steps": {}, "failedStep": { "name": "", "displayName": "" }, "stepNameToTest": "", "archivedAt": null, "stepsCount": 123 } #### Authorizations [​](https://www.activepieces.com/docs/endpoints/flow-runs/get#authorization-authorization) Authorization string header required Use your api key generated from the admin console #### Path Parameters [​](https://www.activepieces.com/docs/endpoints/flow-runs/get#parameter-id) id string required Pattern: `^[0-9a-zA-Z]{21}$` #### Response 200 - application/json Default Response [​](https://www.activepieces.com/docs/endpoints/flow-runs/get#response-id) id string required [​](https://www.activepieces.com/docs/endpoints/flow-runs/get#response-created) created string required [​](https://www.activepieces.com/docs/endpoints/flow-runs/get#response-updated) updated string required [​](https://www.activepieces.com/docs/endpoints/flow-runs/get#response-project-id) projectId string required [​](https://www.activepieces.com/docs/endpoints/flow-runs/get#response-flow-id) flowId string required [​](https://www.activepieces.com/docs/endpoints/flow-runs/get#response-fail-parent-on-failure) failParentOnFailure boolean required [​](https://www.activepieces.com/docs/endpoints/flow-runs/get#response-flow-version-id) flowVersionId string required [​](https://www.activepieces.com/docs/endpoints/flow-runs/get#response-status-one-of-0) status Option 1 · enumOption 2 · enumOption 3 · enumOption 4 · enumOption 5 · enumOption 6 · enumOption 7 · enumOption 8 · enumOption 9 · enumOption 10 · enumOption 1 · enumOption 2 · enumOption 3 · enumOption 4 · enumOption 5 · enumOption 6 · enumOption 7 · enumOption 8 · enumOption 9 · enumOption 10 · enum required Available options: `FAILED` [​](https://www.activepieces.com/docs/endpoints/flow-runs/get#response-environment-one-of-0) environment Option 1 · enumOption 2 · enumOption 1 · enumOption 2 · enum required Available options: `PRODUCTION` [​](https://www.activepieces.com/docs/endpoints/flow-runs/get#response-parent-run-id) parentRunId string [​](https://www.activepieces.com/docs/endpoints/flow-runs/get#response-triggered-by) triggeredBy string [​](https://www.activepieces.com/docs/endpoints/flow-runs/get#response-tags) tags string\[\] [​](https://www.activepieces.com/docs/endpoints/flow-runs/get#response-flow-version) flowVersion object Show child attributes [​](https://www.activepieces.com/docs/endpoints/flow-runs/get#response-logs-file-id-one-of-0) logsFileId string | null [​](https://www.activepieces.com/docs/endpoints/flow-runs/get#response-start-time) startTime string [​](https://www.activepieces.com/docs/endpoints/flow-runs/get#response-finish-time) finishTime string [​](https://www.activepieces.com/docs/endpoints/flow-runs/get#response-steps-one-of-0) steps object Show child attributes [​](https://www.activepieces.com/docs/endpoints/flow-runs/get#response-failed-step) failedStep object Show child attributes [​](https://www.activepieces.com/docs/endpoints/flow-runs/get#response-step-name-to-test) stepNameToTest string [​](https://www.activepieces.com/docs/endpoints/flow-runs/get#response-archived-at-one-of-0) archivedAt string | null [​](https://www.activepieces.com/docs/endpoints/flow-runs/get#response-steps-count) stepsCount number [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/flow-runs/get.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/flow-runs/get) [Flow Run Schema](https://www.activepieces.com/docs/endpoints/flow-runs/schema) [List Flows Runs](https://www.activepieces.com/docs/endpoints/flow-runs/list) ⌘I --- # Security & Data Practices - Activepieces [Skip to main content](https://www.activepieces.com/docs/admin-guide/security/practices#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Security Security & Data Practices [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [External Systems Credentials](https://www.activepieces.com/docs/admin-guide/security/practices#external-systems-credentials) * [Vulnerability Disclosure](https://www.activepieces.com/docs/admin-guide/security/practices#vulnerability-disclosure) * [Access and Authentication](https://www.activepieces.com/docs/admin-guide/security/practices#access-and-authentication) * [Privacy & Data](https://www.activepieces.com/docs/admin-guide/security/practices#privacy-%26-data) [​](https://www.activepieces.com/docs/admin-guide/security/practices#external-systems-credentials) External Systems Credentials ---------------------------------------------------------------------------------------------------------------------------------- **Storing Credentials** All credentials are stored with 256-bit encryption keys, and there is no API to retrieve them for the user. They are sent only during processing, after which access is revoked from the engine. **Data Masking** We implement a robust data masking mechanism where third-party credentials or any sensitive information are systematically censored within the logs, guaranteeing that sensitive information is never stored or documented. **OAuth2** Integrations with third parties are always done using OAuth2, with a limited number of scopes when third-party support allows. [​](https://www.activepieces.com/docs/admin-guide/security/practices#vulnerability-disclosure) Vulnerability Disclosure -------------------------------------------------------------------------------------------------------------------------- Activepieces is an open-source project that welcomes contributors to test and report security issues. For detailed information about our security policy, please refer to our GitHub Security Policy at: [https://github.com/activepieces/activepieces/security/policy](https://github.com/activepieces/activepieces/security/policy) [​](https://www.activepieces.com/docs/admin-guide/security/practices#access-and-authentication) Access and Authentication ---------------------------------------------------------------------------------------------------------------------------- **Role-Based Access Control (RBAC)** To manage user access, we utilize Role-Based Access Control (RBAC). Team admins assign roles to users, granting them specific permissions to access and interact with projects, folders, and resources. RBAC allows for fine-grained control, enabling administrators to define and enforce access policies based on user roles. **Single Sign-On (SSO)** Implementing Single Sign-On (SSO) serves as a pivotal component of our security strategy. SSO streamlines user authentication by allowing them to access Activepieces with a single set of credentials. This not only enhances user convenience but also strengthens security by reducing the potential attack surface associated with managing multiple login credentials. **Audit Logs** We maintain comprehensive audit logs to track and monitor all access activities within Activepieces. This includes user interactions, system changes, and other relevant events. Our meticulous logging helps identify security threats and ensures transparency and accountability in our security measures. **Password Policy Enforcement** Users log in to Activepieces using a password known only to them. Activepieces enforces password length and complexity standards. Passwords are not stored; instead, only a secure hash of the password is stored in the database. For more information. [​](https://www.activepieces.com/docs/admin-guide/security/practices#privacy-&-data) Privacy & Data ------------------------------------------------------------------------------------------------------ **Supported Cloud Regions** Presently, our cloud services are available in Germany as the supported data region. We have plans to expand to additional regions in the near future. If you opt for **self-hosting**, the available regions will depend on where you choose to host. **Policy** To better understand how we handle your data and prioritize your privacy, please take a moment to review our [Privacy Policy](https://www.activepieces.com/privacy) . This document outlines in detail the measures we take to safeguard your information and the principles guiding our approach to privacy and data protection. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/admin-guide/security/practices.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/admin-guide/security/practices) [Project Releases](https://www.activepieces.com/docs/admin-guide/guides/project-releases) [Overview](https://www.activepieces.com/docs/admin-guide/security/audit-logs/overview) ⌘I --- # Queue Metrics - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/worker-machines/queue-metrics#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Worker Machines Queue Metrics [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/worker-machines/queue-metrics.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/worker-machines/queue-metrics) [List Templates](https://www.activepieces.com/docs/endpoints/templates/list) ⌘I --- # List Project Member - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/project-members/list#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Project Members List Project Member [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) cURL cURL curl --request GET \ --url https://cloud.activepieces.com/api/v1/project-members \ --header 'Authorization: Bearer ' 200 { "data": [\ {\ "id": "",\ "created": "",\ "updated": "",\ "platformId": "",\ "userId": "",\ "projectId": "",\ "projectRoleId": "",\ "user": {\ "id": "",\ "email": "",\ "firstName": "",\ "status": "ACTIVE",\ "platformRole": "ADMIN",\ "lastName": "",\ "created": "",\ "updated": "",\ "externalId": "",\ "platformId": "",\ "lastActiveDate": "",\ "imageUrl": ""\ },\ "projectRole": {\ "id": "",\ "created": "",\ "updated": "",\ "name": "",\ "permissions": [\ ""\ ],\ "type": "",\ "platformId": "",\ "userCount": 123\ },\ "project": {\ "id": "",\ "displayName": ""\ }\ }\ ], "next": "", "previous": "" } GET / v1 / project-members Try it cURL cURL curl --request GET \ --url https://cloud.activepieces.com/api/v1/project-members \ --header 'Authorization: Bearer ' 200 { "data": [\ {\ "id": "",\ "created": "",\ "updated": "",\ "platformId": "",\ "userId": "",\ "projectId": "",\ "projectRoleId": "",\ "user": {\ "id": "",\ "email": "",\ "firstName": "",\ "status": "ACTIVE",\ "platformRole": "ADMIN",\ "lastName": "",\ "created": "",\ "updated": "",\ "externalId": "",\ "platformId": "",\ "lastActiveDate": "",\ "imageUrl": ""\ },\ "projectRole": {\ "id": "",\ "created": "",\ "updated": "",\ "name": "",\ "permissions": [\ ""\ ],\ "type": "",\ "platformId": "",\ "userCount": 123\ },\ "project": {\ "id": "",\ "displayName": ""\ }\ }\ ], "next": "", "previous": "" } #### Authorizations [​](https://www.activepieces.com/docs/endpoints/project-members/list#authorization-authorization) Authorization string header required Use your api key generated from the admin console #### Query Parameters [​](https://www.activepieces.com/docs/endpoints/project-members/list#parameter-project-id) projectId string required [​](https://www.activepieces.com/docs/endpoints/project-members/list#parameter-project-role-id) projectRoleId string [​](https://www.activepieces.com/docs/endpoints/project-members/list#parameter-cursor) cursor string [​](https://www.activepieces.com/docs/endpoints/project-members/list#parameter-limit) limit number #### Response 200 - application/json Default Response [​](https://www.activepieces.com/docs/endpoints/project-members/list#response-data) data object\[\] required Show child attributes [​](https://www.activepieces.com/docs/endpoints/project-members/list#response-next-one-of-0) next string | null Cursor to the next page [​](https://www.activepieces.com/docs/endpoints/project-members/list#response-previous-one-of-0) previous string | null Cursor to the previous page [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/project-members/list.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/project-members/list) [Project Member Schema](https://www.activepieces.com/docs/endpoints/project-members/schema) [Delete Project Member](https://www.activepieces.com/docs/endpoints/project-members/delete) ⌘I --- # Create/Update Connections - Activepieces [Skip to main content](https://www.activepieces.com/docs/embedding/embed-connections#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Misc Create/Update Connections [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) **Requirements:** * Activepieces version 0.34.5 or higher * SDK version 0.3.2 or higher If you would like your users to use your own OAuth2 apps, we recommend you check [this](https://www.activepieces.com/docs/admin-console/manage-oauth2) . “connectionName” is the externalId of the connection (you can get it by hovering the connection name in the connections table). We kept the same parameter name for backward compatibility, anyone upgrading their instance from < 0.35.1, will not face issues in that regard. **Breaking Change:** If your Activepieces instance version is < 0.45.0 and (you are using the connect method from the embed sdk, and need the connection externalId to be returned after the user creates it OR if you want to reconnect a specific connection with an externalId), you must upgrade your instance to >= 0.45.0 * You can use the embedded SDK in your SaaS to allow your users to create connections and store them in Activepieces. 1 [](https://www.activepieces.com/docs/embedding/embed-connections#) Initialize the SDK Follow the instructions in the [Embed Builder](https://www.activepieces.com/docs/embedding/embed-builder) . 2 [](https://www.activepieces.com/docs/embedding/embed-connections#) Call Connect Method After initializing the SDK, you will have access to a property called `activepieces` inside your `window` object. Call its `connect` method to open a new connection dialog as follows. **Connect Parameters:** | Parameter Name | Required | Type | Description | | --- | --- | --- | --- | | pieceName | ✅ | string | The name of the piece you want to create a connection for. | | connectionName | ❌ | string | The external Id of the connection (you can get it by hovering the connection name in the connections table), when provided the connection created/upserted will use this as the external Id and display name. | | newWindow | ❌ | { width?: number, height?: number, top?: number, left?: number } | If set the connection dialog will be opened in a new window instead of an iframe taking the full page. | **Connect Result**The `connect` method returns a `promise` that resolves to the following: { connection?: { id: string, name: string } } `name` is the externalId of the connection. `connection` is undefined if the user closes the dialog and doesn’t create a connection. You can use the `connections` piece in the builder to retrieve the created connection using its name.![Connections in Builder](https://mintcdn.com/activepieces/ki8mFooo8mAmhMdP/resources/screenshots/connections-piece.png?w=2500&fit=max&auto=format&n=ki8mFooo8mAmhMdP&q=85&s=78986f41685be71b8983da0980e56554)![Connections in Builder](https://mintcdn.com/activepieces/ki8mFooo8mAmhMdP/resources/screenshots/connections-piece-usage.png?w=2500&fit=max&auto=format&n=ki8mFooo8mAmhMdP&q=85&s=5f4f2ee7c3338ae41ac03ca8f734d8b7) [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/embedding/embed-connections.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/embedding/embed-connections) [Show/Hide Pieces](https://www.activepieces.com/docs/embedding/customize-pieces) [Navigation](https://www.activepieces.com/docs/embedding/navigation) ⌘I --- # Update Global Connection - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/global-connections/update#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Global Connections Update Global Connection [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) cURL cURL curl --request POST \ --url https://cloud.activepieces.com/api/v1/global-connections/{id} \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "displayName": "", "projectIds": [\ ""\ ], "metadata": {} } ' POST / v1 / global-connections / {id} Try it cURL cURL curl --request POST \ --url https://cloud.activepieces.com/api/v1/global-connections/{id} \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "displayName": "", "projectIds": [\ ""\ ], "metadata": {} } ' #### Authorizations [​](https://www.activepieces.com/docs/endpoints/global-connections/update#authorization-authorization) Authorization string header required Use your api key generated from the admin console #### Path Parameters [​](https://www.activepieces.com/docs/endpoints/global-connections/update#parameter-id) id string required Pattern: `^[0-9a-zA-Z]{21}$` #### Body application/json [​](https://www.activepieces.com/docs/endpoints/global-connections/update#body-display-name) displayName string required Minimum string length: `1` [​](https://www.activepieces.com/docs/endpoints/global-connections/update#body-project-ids) projectIds string\[\] [​](https://www.activepieces.com/docs/endpoints/global-connections/update#body-metadata) metadata object Show child attributes #### Response 200 Default Response [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/global-connections/update.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/global-connections/update) [Upsert Global Connection](https://www.activepieces.com/docs/endpoints/global-connections/upsert) [List Global Connections](https://www.activepieces.com/docs/endpoints/global-connections/list) ⌘I --- # Flow Run Started - Activepieces [Skip to main content](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-run-started#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Audit Logs Flow Run Started [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) Example { "id": "", "created": "", "updated": "", "platformId": "", "action": "flow.run.started", "data": { "flowRun": { "id": "", "environment": "PRODUCTION", "flowId": "", "flowVersionId": "", "status": "FAILED", "startTime": "", "finishTime": "", "triggeredBy": "", "stepNameToTest": "" } }, "projectId": "", "projectDisplayName": "", "userId": "", "userEmail": "", "ip": "" } [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-run-started#schema-id) id string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-run-started#schema-created) created string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-run-started#schema-updated) updated string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-run-started#schema-platform-id) platformId string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-run-started#schema-action-one-of-0) action Option 1 · enumOption 2 · enumOption 3 · enumOption 1 · enumOption 2 · enumOption 3 · enum required Available options: `flow.run.started` [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-run-started#schema-data) data object required Show child attributes [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-run-started#schema-project-id) projectId string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-run-started#schema-project-display-name) projectDisplayName string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-run-started#schema-user-id) userId string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-run-started#schema-user-email) userEmail string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-run-started#schema-ip) ip string [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/admin-guide/security/audit-logs/flow-run-started.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/admin-guide/security/audit-logs/flow-run-started) [Connection Deleted](https://www.activepieces.com/docs/admin-guide/security/audit-logs/connection-deleted) [Flow Run Finished](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-run-finished) ⌘I --- # Flow Deleted - Activepieces [Skip to main content](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-deleted#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Audit Logs Flow Deleted [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) Example { "id": "", "created": "", "updated": "", "platformId": "", "action": "flow.deleted", "data": { "flow": { "id": "", "created": "", "updated": "" }, "flowVersion": { "id": "", "displayName": "", "flowId": "", "created": "", "updated": "" } }, "projectId": "", "projectDisplayName": "", "userId": "", "userEmail": "", "ip": "" } [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-deleted#schema-id) id string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-deleted#schema-created) created string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-deleted#schema-updated) updated string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-deleted#schema-platform-id) platformId string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-deleted#schema-action) action enum required Available options: `flow.deleted` [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-deleted#schema-data) data object required Show child attributes [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-deleted#schema-project-id) projectId string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-deleted#schema-project-display-name) projectDisplayName string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-deleted#schema-user-id) userId string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-deleted#schema-user-email) userEmail string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-deleted#schema-ip) ip string [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/admin-guide/security/audit-logs/flow-deleted.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/admin-guide/security/audit-logs/flow-deleted) [Flow Updated](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-updated) [Connection Upserted](https://www.activepieces.com/docs/admin-guide/security/audit-logs/connection-upserted) ⌘I --- # Connection Upserted - Activepieces [Skip to main content](https://www.activepieces.com/docs/admin-guide/security/audit-logs/connection-upserted#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Audit Logs Connection Upserted [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) Example { "id": "", "created": "", "updated": "", "platformId": "", "action": "connection.deleted", "data": { "connection": { "displayName": "", "externalId": "", "pieceName": "", "status": "ACTIVE", "type": "OAUTH2", "id": "", "created": "", "updated": "" } }, "projectId": "", "projectDisplayName": "", "userId": "", "userEmail": "", "ip": "" } [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/connection-upserted#schema-id) id string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/connection-upserted#schema-created) created string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/connection-upserted#schema-updated) updated string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/connection-upserted#schema-platform-id) platformId string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/connection-upserted#schema-action-one-of-0) action Option 1 · enumOption 2 · enumOption 1 · enumOption 2 · enum required Available options: `connection.deleted` [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/connection-upserted#schema-data) data object required Show child attributes [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/connection-upserted#schema-project-id) projectId string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/connection-upserted#schema-project-display-name) projectDisplayName string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/connection-upserted#schema-user-id) userId string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/connection-upserted#schema-user-email) userEmail string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/connection-upserted#schema-ip) ip string [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/admin-guide/security/audit-logs/connection-upserted.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/admin-guide/security/audit-logs/connection-upserted) [Flow Deleted](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-deleted) [Connection Deleted](https://www.activepieces.com/docs/admin-guide/security/audit-logs/connection-deleted) ⌘I --- # Delete User Invitation - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/user-invitations/delete#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation User Invitations Delete User Invitation [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) cURL cURL curl --request DELETE \ --url https://cloud.activepieces.com/api/v1/user-invitations/{id} \ --header 'Authorization: Bearer ' DELETE / v1 / user-invitations / {id} Try it cURL cURL curl --request DELETE \ --url https://cloud.activepieces.com/api/v1/user-invitations/{id} \ --header 'Authorization: Bearer ' #### Authorizations [​](https://www.activepieces.com/docs/endpoints/user-invitations/delete#authorization-authorization) Authorization string header required Use your api key generated from the admin console #### Path Parameters [​](https://www.activepieces.com/docs/endpoints/user-invitations/delete#parameter-id) id string required #### Response 204 - application/json Default Response [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/user-invitations/delete.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/user-invitations/delete) [List User Invitations](https://www.activepieces.com/docs/endpoints/user-invitations/list) [Project Member Schema](https://www.activepieces.com/docs/endpoints/project-members/schema) ⌘I --- # Overview - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/overview#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Get Started Overview [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Authentication:](https://www.activepieces.com/docs/endpoints/overview#authentication) * [Pagination](https://www.activepieces.com/docs/endpoints/overview#pagination) API keys are generated under the platform dashboard at this moment to manage multiple projects, which is only available in the Platform and Enterprise editions, Please contact [\[email protected\]](https://www.activepieces.com/cdn-cgi/l/email-protection#82f1e3eee7f1c2e3e1f6ebf4e7f2ebe7e1e7f1ace1edef) for more information. ### [​](https://www.activepieces.com/docs/endpoints/overview#authentication) Authentication: The API uses “API keys” to authenticate requests. You can view and manage your API keys from the Platform Dashboard. After creating your API key, you can pass the API key as a Bearer token in the header. Example: `Authorization: Bearer {API_KEY}` ### [​](https://www.activepieces.com/docs/endpoints/overview#pagination) Pagination All endpoints use seek pagination, to paginate through the results, you can provide the `limit` and `cursor` as query parameters. The API response will have the following structure: { "data": [], "next": "string", "previous": "string" } * **`data`**: Holds the requested results or data. * **`next`**: Provides a starting cursor for the next set of results, if available. * **`previous`**: Provides a starting cursor for the previous set of results, if applicable. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/overview.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/overview) [Project Schema](https://www.activepieces.com/docs/endpoints/projects/schema) ⌘I --- # Overview - Activepieces [Skip to main content](https://www.activepieces.com/docs/embedding/overview#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Essentials Overview [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) This feature is available in our paid editions. Contact us [here](https://www.activepieces.com/sales) , and we'll be delighted to assist you! This section provides an overview of how to embed the Activepieces builder in your application and automatically provision the user. The embedding process involves the following steps: 1 [](https://www.activepieces.com/docs/embedding/overview#) Provision Users Generate a JSON Web Token (JWT) to identify your customer and pass it to the SDK, read more [here](https://www.activepieces.com/docs/embedding/provision-users) . 2 [](https://www.activepieces.com/docs/embedding/overview#) Embed Builder You can use the SDK to embed and customize Activepieces in your SaaS, read more [here](https://www.activepieces.com/docs/embedding/embed-builder) . Here is an example of how it looks like in one of the SaaS that embed Activepieces: ![Embedding Example](https://mintcdn.com/activepieces/uHZ35vXyxX7goNO-/resources/screenshots/embedding-example.png?w=2500&fit=max&auto=format&n=uHZ35vXyxX7goNO-&q=85&s=5c4ee73a251a6dc600344361ba8e0e3c) In case, you need to gather connections from your users in your SaaS. You can do this with the SDK. Find more info [here](https://www.activepieces.com/docs/embedding/embed-connections) . If you are looking for a way to communicate between Activpieces and the SaaS embedding it through a piece, we recommend you check the [custom property doc](https://www.activepieces.com/docs/build-pieces/piece-reference/properties#custom-property-beta) [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/embedding/overview.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/embedding/overview) [Provision Users](https://www.activepieces.com/docs/embedding/provision-users) ⌘I --- # Delete Global Connection - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/global-connections/delete#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Global Connections Delete Global Connection [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) cURL cURL curl --request DELETE \ --url https://cloud.activepieces.com/api/v1/global-connections/{id} \ --header 'Authorization: Bearer ' DELETE / v1 / global-connections / {id} Try it cURL cURL curl --request DELETE \ --url https://cloud.activepieces.com/api/v1/global-connections/{id} \ --header 'Authorization: Bearer ' #### Authorizations [​](https://www.activepieces.com/docs/endpoints/global-connections/delete#authorization-authorization) Authorization string header required Use your api key generated from the admin console #### Path Parameters [​](https://www.activepieces.com/docs/endpoints/global-connections/delete#parameter-id) id string required Pattern: `^[0-9a-zA-Z]{21}$` #### Response 204 - application/json Default Response [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/global-connections/delete.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/global-connections/delete) [List Global Connections](https://www.activepieces.com/docs/endpoints/global-connections/list) [Git Repos Schema](https://www.activepieces.com/docs/endpoints/git-repos/schema) ⌘I --- # Flow Run Finished - Activepieces [Skip to main content](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-run-finished#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Audit Logs Flow Run Finished [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) Example { "id": "", "created": "", "updated": "", "platformId": "", "action": "flow.run.started", "data": { "flowRun": { "id": "", "environment": "PRODUCTION", "flowId": "", "flowVersionId": "", "status": "FAILED", "startTime": "", "finishTime": "", "triggeredBy": "", "stepNameToTest": "" } }, "projectId": "", "projectDisplayName": "", "userId": "", "userEmail": "", "ip": "" } [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-run-finished#schema-id) id string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-run-finished#schema-created) created string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-run-finished#schema-updated) updated string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-run-finished#schema-platform-id) platformId string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-run-finished#schema-action-one-of-0) action Option 1 · enumOption 2 · enumOption 3 · enumOption 1 · enumOption 2 · enumOption 3 · enum required Available options: `flow.run.started` [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-run-finished#schema-data) data object required Show child attributes [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-run-finished#schema-project-id) projectId string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-run-finished#schema-project-display-name) projectDisplayName string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-run-finished#schema-user-id) userId string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-run-finished#schema-user-email) userEmail string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-run-finished#schema-ip) ip string [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/admin-guide/security/audit-logs/flow-run-finished.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/admin-guide/security/audit-logs/flow-run-finished) [Flow Run Started](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-run-started) [Folder Created](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-created) ⌘I --- # List Projects - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/projects/list#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Projects List Projects [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) cURL cURL curl --request GET \ --url https://cloud.activepieces.com/api/v1/projects \ --header 'Authorization: Bearer ' 200 { "data": [\ {\ "id": "",\ "created": "",\ "updated": "",\ "ownerId": "",\ "displayName": "",\ "platformId": "",\ "type": "TEAM",\ "icon": {\ "color": "RED"\ },\ "releasesEnabled": true,\ "plan": {\ "id": "",\ "created": "",\ "updated": "",\ "projectId": "",\ "locked": false,\ "name": "",\ "piecesFilterType": "NONE",\ "pieces": [\ ""\ ]\ },\ "analytics": {\ "totalUsers": 123,\ "activeUsers": 123,\ "totalFlows": 123,\ "activeFlows": 123\ },\ "maxConcurrentJobs": 123,\ "externalId": "",\ "metadata": {}\ }\ ], "next": "", "previous": "" } GET / v1 / projects Try it cURL cURL curl --request GET \ --url https://cloud.activepieces.com/api/v1/projects \ --header 'Authorization: Bearer ' 200 { "data": [\ {\ "id": "",\ "created": "",\ "updated": "",\ "ownerId": "",\ "displayName": "",\ "platformId": "",\ "type": "TEAM",\ "icon": {\ "color": "RED"\ },\ "releasesEnabled": true,\ "plan": {\ "id": "",\ "created": "",\ "updated": "",\ "projectId": "",\ "locked": false,\ "name": "",\ "piecesFilterType": "NONE",\ "pieces": [\ ""\ ]\ },\ "analytics": {\ "totalUsers": 123,\ "activeUsers": 123,\ "totalFlows": 123,\ "activeFlows": 123\ },\ "maxConcurrentJobs": 123,\ "externalId": "",\ "metadata": {}\ }\ ], "next": "", "previous": "" } #### Authorizations [​](https://www.activepieces.com/docs/endpoints/projects/list#authorization-authorization) Authorization string header required Use your api key generated from the admin console #### Query Parameters [​](https://www.activepieces.com/docs/endpoints/projects/list#parameter-external-id) externalId string [​](https://www.activepieces.com/docs/endpoints/projects/list#parameter-limit) limit number [​](https://www.activepieces.com/docs/endpoints/projects/list#parameter-cursor) cursor string [​](https://www.activepieces.com/docs/endpoints/projects/list#parameter-display-name) displayName string [​](https://www.activepieces.com/docs/endpoints/projects/list#parameter-types) types enum\[\] Available options: `TEAM` #### Response 200 - application/json Default Response [​](https://www.activepieces.com/docs/endpoints/projects/list#response-data) data object\[\] required Show child attributes [​](https://www.activepieces.com/docs/endpoints/projects/list#response-next-one-of-0) next string | null Cursor to the next page [​](https://www.activepieces.com/docs/endpoints/projects/list#response-previous-one-of-0) previous string | null Cursor to the previous page [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/projects/list.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/projects/list) [Update Project](https://www.activepieces.com/docs/endpoints/projects/update) [Delete Project](https://www.activepieces.com/docs/endpoints/projects/delete) ⌘I --- # Folder Created - Activepieces [Skip to main content](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-created#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Audit Logs Folder Created [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) Example { "id": "", "created": "", "updated": "", "platformId": "", "action": "folder.updated", "data": { "folder": { "id": "", "displayName": "", "created": "", "updated": "" } }, "projectId": "", "projectDisplayName": "", "userId": "", "userEmail": "", "ip": "" } [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-created#schema-id) id string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-created#schema-created) created string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-created#schema-updated) updated string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-created#schema-platform-id) platformId string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-created#schema-action-one-of-0) action Option 1 · enumOption 2 · enumOption 3 · enumOption 1 · enumOption 2 · enumOption 3 · enum required Available options: `folder.updated` [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-created#schema-data) data object required Show child attributes [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-created#schema-project-id) projectId string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-created#schema-project-display-name) projectDisplayName string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-created#schema-user-id) userId string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-created#schema-user-email) userEmail string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-created#schema-ip) ip string [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/admin-guide/security/audit-logs/folder-created.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/admin-guide/security/audit-logs/folder-created) [Flow Run Finished](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-run-finished) [Folder Updated](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-updated) ⌘I --- # Get Folder - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/folders/get#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Folders Get Folder [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) cURL cURL curl --request GET \ --url https://cloud.activepieces.com/api/v1/folders/{id} \ --header 'Authorization: Bearer ' GET / v1 / folders / {id} Try it cURL cURL curl --request GET \ --url https://cloud.activepieces.com/api/v1/folders/{id} \ --header 'Authorization: Bearer ' #### Authorizations [​](https://www.activepieces.com/docs/endpoints/folders/get#authorization-authorization) Authorization string header required Use your api key generated from the admin console #### Path Parameters [​](https://www.activepieces.com/docs/endpoints/folders/get#parameter-id) id string required #### Response 200 Default Response [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/folders/get.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/folders/get) [Update Folder](https://www.activepieces.com/docs/endpoints/folders/update) [List Folders](https://www.activepieces.com/docs/endpoints/folders/list) ⌘I --- # List Templates - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/templates/list#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Templates List Templates [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) cURL cURL curl --request GET \ --url https://cloud.activepieces.com/api/v1/templates \ --header 'Authorization: Bearer ' GET / v1 / templates Try it cURL cURL curl --request GET \ --url https://cloud.activepieces.com/api/v1/templates \ --header 'Authorization: Bearer ' #### Authorizations [​](https://www.activepieces.com/docs/endpoints/templates/list#authorization-authorization) Authorization string header required Use your api key generated from the admin console #### Query Parameters [​](https://www.activepieces.com/docs/endpoints/templates/list#parameter-one-of-0) type Option 1 · enumOption 2 · enumOption 3 · enumOption 1 · enumOption 2 · enumOption 3 · enum Available options: `OFFICIAL` [​](https://www.activepieces.com/docs/endpoints/templates/list#parameter-pieces) pieces string\[\] [​](https://www.activepieces.com/docs/endpoints/templates/list#parameter-tags) tags string\[\] [​](https://www.activepieces.com/docs/endpoints/templates/list#parameter-search) search string [​](https://www.activepieces.com/docs/endpoints/templates/list#parameter-category) category string #### Response 200 Default Response [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/templates/list.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/templates/list) [Get Template](https://www.activepieces.com/docs/endpoints/templates/get) [Queue Metrics](https://www.activepieces.com/docs/endpoints/worker-machines/queue-metrics) ⌘I --- # Delete Connection - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/connections/delete#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Connections Delete Connection [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) cURL cURL curl --request DELETE \ --url https://cloud.activepieces.com/api/v1/app-connections/{id} \ --header 'Authorization: Bearer ' DELETE / v1 / app-connections / {id} Try it cURL cURL curl --request DELETE \ --url https://cloud.activepieces.com/api/v1/app-connections/{id} \ --header 'Authorization: Bearer ' #### Authorizations [​](https://www.activepieces.com/docs/endpoints/connections/delete#authorization-authorization) Authorization string header required Use your api key generated from the admin console #### Path Parameters [​](https://www.activepieces.com/docs/endpoints/connections/delete#parameter-id) id string required Pattern: `^[0-9a-zA-Z]{21}$` #### Response 204 - application/json Default Response [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/connections/delete.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/connections/delete) [List Connections](https://www.activepieces.com/docs/endpoints/connections/list) [Flow Schema](https://www.activepieces.com/docs/endpoints/flows/schema) ⌘I --- # User Invitation Schema - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/user-invitations/schema#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation User Invitations User Invitation Schema [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) Example { "id": "", "created": "", "updated": "", "email": "", "status": "PENDING", "type": "PLATFORM", "platformId": "", "platformRole": "ADMIN", "projectId": "", "projectRoleId": "", "projectRole": { "id": "", "created": "", "updated": "", "name": "", "permissions": [\ ""\ ], "type": "", "platformId": "", "userCount": 123 } } [​](https://www.activepieces.com/docs/endpoints/user-invitations/schema#schema-id) id string required [​](https://www.activepieces.com/docs/endpoints/user-invitations/schema#schema-created) created string required [​](https://www.activepieces.com/docs/endpoints/user-invitations/schema#schema-updated) updated string required [​](https://www.activepieces.com/docs/endpoints/user-invitations/schema#schema-email) email string required [​](https://www.activepieces.com/docs/endpoints/user-invitations/schema#schema-status-one-of-0) status Option 1 · enumOption 2 · enumOption 1 · enumOption 2 · enum required Available options: `PENDING` [​](https://www.activepieces.com/docs/endpoints/user-invitations/schema#schema-type-one-of-0) type Option 1 · enumOption 2 · enumOption 1 · enumOption 2 · enum required Available options: `PLATFORM` [​](https://www.activepieces.com/docs/endpoints/user-invitations/schema#schema-platform-id) platformId string required [​](https://www.activepieces.com/docs/endpoints/user-invitations/schema#schema-platform-role-one-of-0) platformRole enum | null Available options: `ADMIN`, `MEMBER`, `OPERATOR` [​](https://www.activepieces.com/docs/endpoints/user-invitations/schema#schema-project-id-one-of-0) projectId string | null [​](https://www.activepieces.com/docs/endpoints/user-invitations/schema#schema-project-role-id-one-of-0) projectRoleId string | null [​](https://www.activepieces.com/docs/endpoints/user-invitations/schema#schema-project-role-one-of-0) projectRole object Show child attributes [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/user-invitations/schema.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/user-invitations/schema) [Delete User](https://www.activepieces.com/docs/endpoints/users/delete) [Send User Invitation (Upsert)](https://www.activepieces.com/docs/endpoints/user-invitations/upsert) ⌘I --- # Show/Hide Pieces - Activepieces [Skip to main content](https://www.activepieces.com/docs/embedding/customize-pieces#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Misc Show/Hide Pieces [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) This feature is available in our paid editions. Contact us [here](https://www.activepieces.com/sales) , and we'll be delighted to assist you! If you would like your users to use your own OAuth2 apps, we recommend you check [this](https://www.activepieces.com/docs/admin-console/manage-oauth2) . If you would like to only show specific pieces to your embedding users, we recommend you do the following: 1 [](https://www.activepieces.com/docs/embedding/customize-pieces#) Tag Pieces Tag the pieces you would like to show to your user by going to **Platform Admin -> Setup -> Pieces**, selecting the pieces you would like to tag and hit **Apply Tags**![Bulk Tag](https://mintcdn.com/activepieces/uHZ35vXyxX7goNO-/resources/screenshots/tag-pieces.png?w=2500&fit=max&auto=format&n=uHZ35vXyxX7goNO-&q=85&s=3a225095e3c85e8aaac53f6c0fad62ff) 2 [](https://www.activepieces.com/docs/embedding/customize-pieces#) Add Tags to Provision Token You need to specify the tags of pieces in the token, check how to generate token in [provisioning users](https://www.activepieces.com/docs/embedding/provision-users) .You should specify the `pieces` claim like this: { /// Other claims "piecesFilterType": "ALLOWED", "piecesTags": [ "free" ] } Each time the token is used by the embedding SDK, it will sync all pieces with these tags to the token’s project. The project will only contain the pieces that contain these tags. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/embedding/customize-pieces.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/embedding/customize-pieces) [Embed Builder](https://www.activepieces.com/docs/embedding/embed-builder) [Create/Update Connections](https://www.activepieces.com/docs/embedding/embed-connections) ⌘I --- # Create Folder - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/folders/create#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Folders Create Folder [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) cURL cURL curl --request POST \ --url https://cloud.activepieces.com/api/v1/folders \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "displayName": "", "projectId": "" } ' POST / v1 / folders Try it cURL cURL curl --request POST \ --url https://cloud.activepieces.com/api/v1/folders \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "displayName": "", "projectId": "" } ' #### Authorizations [​](https://www.activepieces.com/docs/endpoints/folders/create#authorization-authorization) Authorization string header required Use your api key generated from the admin console #### Body application/json [​](https://www.activepieces.com/docs/endpoints/folders/create#body-display-name) displayName string required [​](https://www.activepieces.com/docs/endpoints/folders/create#body-project-id) projectId string required #### Response 200 Default Response [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/folders/create.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/folders/create) [Folder Schema](https://www.activepieces.com/docs/endpoints/folders/schema) [Update Folder](https://www.activepieces.com/docs/endpoints/folders/update) ⌘I --- # Git Repos Schema - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/git-repos/schema#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Git Sync Git Repos Schema [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) Example { "id": "", "created": "", "updated": "", "remoteUrl": "", "branch": "", "branchType": "PRODUCTION", "projectId": "", "slug": "" } [​](https://www.activepieces.com/docs/endpoints/git-repos/schema#schema-id) id string required [​](https://www.activepieces.com/docs/endpoints/git-repos/schema#schema-created) created string required [​](https://www.activepieces.com/docs/endpoints/git-repos/schema#schema-updated) updated string required [​](https://www.activepieces.com/docs/endpoints/git-repos/schema#schema-remote-url) remoteUrl string required [​](https://www.activepieces.com/docs/endpoints/git-repos/schema#schema-branch) branch string required [​](https://www.activepieces.com/docs/endpoints/git-repos/schema#schema-branch-type-one-of-0) branchType Option 1 · enumOption 2 · enumOption 1 · enumOption 2 · enum required Available options: `PRODUCTION` [​](https://www.activepieces.com/docs/endpoints/git-repos/schema#schema-project-id) projectId string required [​](https://www.activepieces.com/docs/endpoints/git-repos/schema#schema-slug) slug string required [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/git-repos/schema.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/git-repos/schema) [Delete Global Connection](https://www.activepieces.com/docs/endpoints/global-connections/delete) [Configure](https://www.activepieces.com/docs/endpoints/git-repos/configure) ⌘I --- # Overview - Activepieces [Skip to main content](https://www.activepieces.com/docs/admin-guide/security/audit-logs/overview#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Audit Logs Overview [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) This feature is available in our paid editions. Contact us [here](https://www.activepieces.com/sales) , and we'll be delighted to assist you! This table in admin console contains all application events. We are constantly adding new events, so there is no better place to see the events defined in the code than [here](https://github.com/activepieces/activepieces/blob/main/packages/shared/src/lib/ee/audit-events/index.ts) . ![Audit Logs](https://mintcdn.com/activepieces/ki8mFooo8mAmhMdP/resources/screenshots/audit-logs.png?w=2500&fit=max&auto=format&n=ki8mFooo8mAmhMdP&q=85&s=5392d4a87630473b22e9523acd597e15) [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/admin-guide/security/audit-logs/overview.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/admin-guide/security/audit-logs/overview) [Security & Data Practices](https://www.activepieces.com/docs/admin-guide/security/practices) [Flow Created](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-created) ⌘I --- # Install Piece - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/pieces/install#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Pieces Install Piece [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) Add a piece to a platform cURL curl --request POST \ --url https://cloud.activepieces.com/api/v1/pieces \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "packageType": "ARCHIVE", "scope": "PLATFORM", "pieceName": "", "pieceVersion": "", "pieceArchive": { "filename": "", "data": "", "type": "file", "mimetype": "" } } ' 201 {} POST / v1 / pieces Try it Add a piece to a platform cURL curl --request POST \ --url https://cloud.activepieces.com/api/v1/pieces \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "packageType": "ARCHIVE", "scope": "PLATFORM", "pieceName": "", "pieceVersion": "", "pieceArchive": { "filename": "", "data": "", "type": "file", "mimetype": "" } } ' 201 {} #### Authorizations [​](https://www.activepieces.com/docs/endpoints/pieces/install#authorization-authorization) Authorization string header required Use your api key generated from the admin console #### Body application/json * Private Piece * NPM Piece [​](https://www.activepieces.com/docs/endpoints/pieces/install#body-one-of-0-package-type) packageType enum required Available options: `ARCHIVE` [​](https://www.activepieces.com/docs/endpoints/pieces/install#body-one-of-0-scope) scope enum required Available options: `PLATFORM` [​](https://www.activepieces.com/docs/endpoints/pieces/install#body-one-of-0-piece-name) pieceName string required Minimum string length: `1` [​](https://www.activepieces.com/docs/endpoints/pieces/install#body-one-of-0-piece-version) pieceVersion string required Pattern: `^[0-9]+\.[0-9]+\.[0-9]+$` [​](https://www.activepieces.com/docs/endpoints/pieces/install#body-one-of-0-piece-archive) pieceArchive object required Show child attributes #### Response 201 - application/json Default Response The response is of type `object`. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/pieces/install.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/pieces/install) [Piece Schema](https://www.activepieces.com/docs/endpoints/pieces/schema) [Project Release Schema](https://www.activepieces.com/docs/endpoints/project-releases/schema) ⌘I --- # Delete Folder - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/folders/delete#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Folders Delete Folder [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) cURL cURL curl --request DELETE \ --url https://cloud.activepieces.com/api/v1/folders/{id} \ --header 'Authorization: Bearer ' DELETE / v1 / folders / {id} Try it cURL cURL curl --request DELETE \ --url https://cloud.activepieces.com/api/v1/folders/{id} \ --header 'Authorization: Bearer ' #### Authorizations [​](https://www.activepieces.com/docs/endpoints/folders/delete#authorization-authorization) Authorization string header required Use your api key generated from the admin console #### Path Parameters [​](https://www.activepieces.com/docs/endpoints/folders/delete#parameter-id) id string required #### Response 200 Default Response [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/folders/delete.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/folders/delete) [List Folders](https://www.activepieces.com/docs/endpoints/folders/list) [Template Schema](https://www.activepieces.com/docs/endpoints/templates/schema) ⌘I --- # List Folders - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/folders/list#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Folders List Folders [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) cURL cURL curl --request GET \ --url https://cloud.activepieces.com/api/v1/folders \ --header 'Authorization: Bearer ' GET / v1 / folders Try it cURL cURL curl --request GET \ --url https://cloud.activepieces.com/api/v1/folders \ --header 'Authorization: Bearer ' #### Authorizations [​](https://www.activepieces.com/docs/endpoints/folders/list#authorization-authorization) Authorization string header required Use your api key generated from the admin console #### Query Parameters [​](https://www.activepieces.com/docs/endpoints/folders/list#parameter-limit) limit number [​](https://www.activepieces.com/docs/endpoints/folders/list#parameter-cursor) cursor string [​](https://www.activepieces.com/docs/endpoints/folders/list#parameter-project-id) projectId string required #### Response 200 Default Response [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/folders/list.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/folders/list) [Get Folder](https://www.activepieces.com/docs/endpoints/folders/get) [Delete Folder](https://www.activepieces.com/docs/endpoints/folders/delete) ⌘I --- # Predefined Connection - Activepieces [Skip to main content](https://www.activepieces.com/docs/embedding/predefined-connection#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Misc Predefined Connection [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Prerequisites](https://www.activepieces.com/docs/embedding/predefined-connection#prerequisites) * [Create a Predefined Connection](https://www.activepieces.com/docs/embedding/predefined-connection#create-a-predefined-connection) * [Hide the Connections Dropdown (Optional)](https://www.activepieces.com/docs/embedding/predefined-connection#hide-the-connections-dropdown-optional) Use predefined connections to allow users to access your piece in the embedded app without re-entering authentication credentials. The high-level steps are: * Create a global connection for a project using the API in the platform admin. Only platform admins can edit or delete global connections. * (Optional) Hide the connections dropdown in the piece settings. ### [​](https://www.activepieces.com/docs/embedding/predefined-connection#prerequisites) Prerequisites * [Run the Enterprise Edition](https://www.activepieces.com/docs/handbook/engineering/playbooks/run-ee) * [Create your piece](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) . Later we will customize the piece logic to use predefined connections. ### [​](https://www.activepieces.com/docs/embedding/predefined-connection#create-a-predefined-connection) Create a Predefined Connection 1 [](https://www.activepieces.com/docs/embedding/predefined-connection#) Create an API Key Go to **Platform Admin → Security → API Keys** and create an API key. Save it for use in the next step.![Create API Key](https://mintcdn.com/activepieces/ki8mFooo8mAmhMdP/resources/screenshots/create-api-key.png?w=2500&fit=max&auto=format&n=ki8mFooo8mAmhMdP&q=85&s=423bb1176e0d1efdce61745c08be43e5) 2 [](https://www.activepieces.com/docs/embedding/predefined-connection#) Create a Global Connection via API Add the following snippet to your backend to create a global connection each time you generate the **JWT token**.The snippet does the following: * Create Project If it doesn’t exist. * Create a global connection for the project with certain naming convention. const apiKey = 'YOUR_API_KEY'; const instanceUrl = 'https://cloud.activepieces.com'; // The name of the user / organization in your SAAS const externalProjectId = 'org_1234'; const pieceName = '@activepieces/piece-gelato'; // This will depend on what your piece auth type is, can be one of this ['PLATFORM_OAUTH2','SECRET_TEXT','BASIC_AUTH','CUSTOM_AUTH'] const pieceAuthType = "CUSTOM_AUTH" const connectionProps = { // Fill in the props required by your piece's auth } const { id: projectId, externalId } = await getOrCreateProject({ projectExternalId: externalProjectId, apiKey, instanceUrl, }); await createGlobalConnection({ projectId, externalProjectId, apiKey, instanceUrl, pieceName, props, pieceAuthType }); Implementation: async function getOrCreateProject({ projectExternalId, apiKey, instanceUrl, }: { projectExternalId: string, apiKey: string, instanceUrl: string }): Promise<{ id: string, externalId: string }> { const projects = await fetch(`${instanceUrl}/api/v1/projects?externalId=${projectExternalId}`, { method: 'GET', headers: { 'Authorization': `Bearer ${apiKey}`, 'Content-Type': 'application/json' }, }) .then(response => response.json()) .then(data => data.data) .catch(err => { console.error('Error fetching projects:', err); return []; }); if (projects.length > 0) { return { id: projects[0].id, externalId: projects[0].externalId }; } const newProject = await fetch(`${instanceUrl}/api/v1/projects`, { method: 'POST', headers: { 'Authorization': `Bearer ${apiKey}`, 'Content-Type': 'application/json' }, body: JSON.stringify({ displayName: projectExternalId, metadata: {}, externalId: projectExternalId }) }) .then(response => response.json()) .catch(err => { console.error('Error creating project:', err); throw err; }); return { id: newProject.id, externalId: newProject.externalId }; } async function createGlobalConnection({ projectId, externalProjectId, apiKey, instanceUrl, pieceName, props, pieceAuthType }: { projectId: string, externalProjectId: string, apiKey: string, instanceUrl: string, pieceName: string, props: Record, pieceAuthType }) { const displayName = 'Gelato Connection'; const connectionExternalId = 'gelato_' + externalProjectId; return fetch(`${instanceUrl}/api/v1/global-connections`, { method: 'POST', headers: { 'Authorization': `Bearer ${apiKey}`, 'Content-Type': 'application/json' }, body: JSON.stringify({ displayName, pieceName, metadata: {}, type: pieceAuthType, value: { type: pieceAuthType, props }, scope: 'PLATFORM', projectIds: [projectId], externalId: connectionExternalId }) }); } ### [​](https://www.activepieces.com/docs/embedding/predefined-connection#hide-the-connections-dropdown-optional) Hide the Connections Dropdown (Optional) 1 [](https://www.activepieces.com/docs/embedding/predefined-connection#) Modify Trigger / Action Definition Wherever you call `createTrigger` or `createAction` set `requireAuth` to `false`, this will hide the connections dropdown in the piece settings in the builder, next we need to fetch it based on a naming convention. 2 [](https://www.activepieces.com/docs/embedding/predefined-connection#) Fetch the connection Here is example how you can fetch the connection value based on naming convention, make sure this naming convention is followed when creating a global connection. import { ConnectionsManager, Property, TriggerStrategy } from "@activepieces/pieces-framework"; import { createTrigger } from "@activepieces/pieces-framework"; import { isNil } from "@activepieces/shared"; // Add this import from the index.ts file, where it contains the definition of the auth object. import { auth } from '../..'; const fetchConnection = async ( connections: ConnectionsManager, projectExternalId: string | undefined, ): Promise> => { if (isNil(projectExternalId)) { throw new Error('This project is missing an external id'); } // the naming convention here is gelato_projectExternalId const connection = await connections.get(`gelato_${projectExternalId}`); if (isNil(connection)) { throw new Error(`Connection not found for project ${projectExternalId}`); } return connection as PiecePropValueSchema; }; export const newFlavorCreated = createTrigger({ requireAuth: false, name: 'newFlavorCreated', displayName: 'new flavor created', description: 'triggers when a new icecream flavor is created.', props: { dropdown: Property.Dropdown({ displayName: 'Dropdown', required: true, refreshers: [], options: async (_, { connections, project }) => { const connection = await fetchConnection(connections, (await project.externalId())); // your logic return { options: [{\ label: 'test',\ value: 'test'\ }] } } }) }, sampleData: {}, type: TriggerStrategy.POLLING, async test({connections,project}) { const connection = await fetchConnection(connections, (await project.externalId())); // use the connection with your own logic return [] }, async onEnable({connections,project}) { const connection = await fetchConnection(connections, (await project.externalId())); // use the connection with your own logic }, async onDisable({connections,project}) { const connection = await fetchConnection(connections, (await project.externalId())); // use the connection with your own logic }, async run({connections,project}) { const connection = await fetchConnection(connections, (await project.externalId())); // use the connection with your own logic return [] }, }); [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/embedding/predefined-connection.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/embedding/predefined-connection) [Navigation](https://www.activepieces.com/docs/embedding/navigation) [SDK Changelog](https://www.activepieces.com/docs/embedding/sdk-changelog) ⌘I --- # Delete Project Member - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/project-members/delete#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Project Members Delete Project Member [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) cURL cURL curl --request DELETE \ --url https://cloud.activepieces.com/api/v1/project-members/{id} \ --header 'Authorization: Bearer ' DELETE / v1 / project-members / {id} Try it cURL cURL curl --request DELETE \ --url https://cloud.activepieces.com/api/v1/project-members/{id} \ --header 'Authorization: Bearer ' #### Authorizations [​](https://www.activepieces.com/docs/endpoints/project-members/delete#authorization-authorization) Authorization string header required Use your api key generated from the admin console #### Path Parameters [​](https://www.activepieces.com/docs/endpoints/project-members/delete#parameter-id) id string required #### Response 204 - application/json Default Response [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/project-members/delete.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/project-members/delete) [List Project Member](https://www.activepieces.com/docs/endpoints/project-members/list) [Connection Schema](https://www.activepieces.com/docs/endpoints/connections/schema) ⌘I --- # Project Release Schema - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/project-releases/schema#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Project Releases Project Release Schema [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) Example { "id": "", "created": "", "updated": "", "projectId": "", "name": "", "fileId": "", "type": "GIT", "description": "", "importedBy": "" } [​](https://www.activepieces.com/docs/endpoints/project-releases/schema#schema-id) id string required [​](https://www.activepieces.com/docs/endpoints/project-releases/schema#schema-created) created string required [​](https://www.activepieces.com/docs/endpoints/project-releases/schema#schema-updated) updated string required [​](https://www.activepieces.com/docs/endpoints/project-releases/schema#schema-project-id) projectId string required [​](https://www.activepieces.com/docs/endpoints/project-releases/schema#schema-name) name string required [​](https://www.activepieces.com/docs/endpoints/project-releases/schema#schema-file-id) fileId string required [​](https://www.activepieces.com/docs/endpoints/project-releases/schema#schema-type-one-of-0) type Option 1 · enumOption 2 · enumOption 3 · enumOption 1 · enumOption 2 · enumOption 3 · enum required Available options: `GIT` [​](https://www.activepieces.com/docs/endpoints/project-releases/schema#schema-description-one-of-0) description string | null [​](https://www.activepieces.com/docs/endpoints/project-releases/schema#schema-imported-by-one-of-0) importedBy string | null [​](https://www.activepieces.com/docs/endpoints/project-releases/schema#schema-imported-by-user) importedByUser object Show child attributes [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/project-releases/schema.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/project-releases/schema) [Install Piece](https://www.activepieces.com/docs/endpoints/pieces/install) [Create Project Release](https://www.activepieces.com/docs/endpoints/project-releases/create) ⌘I --- # Template Schema - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/templates/schema#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Templates Template Schema [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) Example { "id": "", "created": "", "updated": "", "name": "", "type": "OFFICIAL", "summary": "", "description": "", "tags": [\ {\ "title": "",\ "color": "",\ "icon": ""\ }\ ], "author": "", "categories": [\ ""\ ], "pieces": [\ ""\ ], "status": "PUBLISHED", "blogUrl": "", "metadata": {}, "platformId": "", "flows": [\ {\ "displayName": "",\ "trigger": {\ "name": "",\ "valid": true,\ "displayName": "",\ "type": "PIECE_TRIGGER",\ "settings": {\ "propertySettings": {},\ "pieceName": "",\ "pieceVersion": "",\ "input": {},\ "sampleData": {\ "sampleDataFileId": "",\ "sampleDataInputFileId": "",\ "lastTestDate": ""\ },\ "customLogoUrl": "",\ "triggerName": ""\ },\ "nextAction": ""\ },\ "valid": true,\ "schemaVersion": "",\ "description": "",\ "notes": [\ {\ "id": "",\ "content": "",\ "color": "orange",\ "position": {\ "x": 123,\ "y": 123\ },\ "size": {\ "width": 123,\ "height": 123\ },\ "createdAt": "",\ "updatedAt": "",\ "ownerId": ""\ }\ ]\ }\ ], "tables": [\ {\ "name": "",\ "externalId": "",\ "fields": [\ {\ "name": "",\ "type": "",\ "externalId": "",\ "data": {\ "options": [\ {\ "value": ""\ }\ ]\ }\ }\ ],\ "status": "ENABLED",\ "trigger": "ON_NEW_RECORD",\ "data": {\ "type": "CSV",\ "rows": [\ [\ {\ "fieldId": "",\ "value": ""\ }\ ]\ ]\ }\ }\ ] } [​](https://www.activepieces.com/docs/endpoints/templates/schema#schema-id) id string required [​](https://www.activepieces.com/docs/endpoints/templates/schema#schema-created) created string required [​](https://www.activepieces.com/docs/endpoints/templates/schema#schema-updated) updated string required [​](https://www.activepieces.com/docs/endpoints/templates/schema#schema-name) name string required [​](https://www.activepieces.com/docs/endpoints/templates/schema#schema-type-one-of-0) type Option 1 · enumOption 2 · enumOption 3 · enumOption 1 · enumOption 2 · enumOption 3 · enum required Available options: `OFFICIAL` [​](https://www.activepieces.com/docs/endpoints/templates/schema#schema-summary) summary string required [​](https://www.activepieces.com/docs/endpoints/templates/schema#schema-description) description string required [​](https://www.activepieces.com/docs/endpoints/templates/schema#schema-tags) tags object\[\] required Show child attributes [​](https://www.activepieces.com/docs/endpoints/templates/schema#schema-author) author string required [​](https://www.activepieces.com/docs/endpoints/templates/schema#schema-categories) categories string\[\] required [​](https://www.activepieces.com/docs/endpoints/templates/schema#schema-pieces) pieces string\[\] required [​](https://www.activepieces.com/docs/endpoints/templates/schema#schema-status-one-of-0) status Option 1 · enumOption 2 · enumOption 1 · enumOption 2 · enum required Available options: `PUBLISHED` [​](https://www.activepieces.com/docs/endpoints/templates/schema#schema-blog-url-one-of-0) blogUrl string | null [​](https://www.activepieces.com/docs/endpoints/templates/schema#schema-metadata-one-of-0) metadata object Show child attributes [​](https://www.activepieces.com/docs/endpoints/templates/schema#schema-platform-id-one-of-0) platformId string | null [​](https://www.activepieces.com/docs/endpoints/templates/schema#schema-flows) flows object\[\] Show child attributes [​](https://www.activepieces.com/docs/endpoints/templates/schema#schema-tables) tables object\[\] Show child attributes [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/templates/schema.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/templates/schema) [Delete Folder](https://www.activepieces.com/docs/endpoints/folders/delete) [Create Template](https://www.activepieces.com/docs/endpoints/templates/create) ⌘I --- # Flow Run Schema - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/flow-runs/schema#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Flow Runs Flow Run Schema [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) Example { "id": "", "created": "", "updated": "", "projectId": "", "flowId": "", "failParentOnFailure": true, "flowVersionId": "", "status": "FAILED", "environment": "PRODUCTION", "parentRunId": "", "triggeredBy": "", "tags": [\ ""\ ], "flowVersion": { "displayName": "" }, "logsFileId": "", "startTime": "", "finishTime": "", "pauseMetadata": { "type": "DELAY", "resumeDateTime": "", "requestIdToReply": "", "handlerId": "", "progressUpdateType": "WEBHOOK_RESPONSE" }, "steps": {}, "stepNameToTest": "", "archivedAt": null, "stepsCount": 123 } [​](https://www.activepieces.com/docs/endpoints/flow-runs/schema#schema-id) id string required [​](https://www.activepieces.com/docs/endpoints/flow-runs/schema#schema-created) created string required [​](https://www.activepieces.com/docs/endpoints/flow-runs/schema#schema-updated) updated string required [​](https://www.activepieces.com/docs/endpoints/flow-runs/schema#schema-project-id) projectId string required [​](https://www.activepieces.com/docs/endpoints/flow-runs/schema#schema-flow-id) flowId string required [​](https://www.activepieces.com/docs/endpoints/flow-runs/schema#schema-fail-parent-on-failure) failParentOnFailure boolean required [​](https://www.activepieces.com/docs/endpoints/flow-runs/schema#schema-flow-version-id) flowVersionId string required [​](https://www.activepieces.com/docs/endpoints/flow-runs/schema#schema-status-one-of-0) status Option 1 · enumOption 2 · enumOption 3 · enumOption 4 · enumOption 5 · enumOption 6 · enumOption 7 · enumOption 8 · enumOption 9 · enumOption 10 · enumOption 1 · enumOption 2 · enumOption 3 · enumOption 4 · enumOption 5 · enumOption 6 · enumOption 7 · enumOption 8 · enumOption 9 · enumOption 10 · enum required Available options: `FAILED` [​](https://www.activepieces.com/docs/endpoints/flow-runs/schema#schema-environment-one-of-0) environment Option 1 · enumOption 2 · enumOption 1 · enumOption 2 · enum required Available options: `PRODUCTION` [​](https://www.activepieces.com/docs/endpoints/flow-runs/schema#schema-parent-run-id) parentRunId string [​](https://www.activepieces.com/docs/endpoints/flow-runs/schema#schema-triggered-by) triggeredBy string [​](https://www.activepieces.com/docs/endpoints/flow-runs/schema#schema-tags) tags string\[\] [​](https://www.activepieces.com/docs/endpoints/flow-runs/schema#schema-flow-version) flowVersion object Show child attributes [​](https://www.activepieces.com/docs/endpoints/flow-runs/schema#schema-logs-file-id-one-of-0) logsFileId string | null [​](https://www.activepieces.com/docs/endpoints/flow-runs/schema#schema-start-time) startTime string [​](https://www.activepieces.com/docs/endpoints/flow-runs/schema#schema-finish-time) finishTime string [​](https://www.activepieces.com/docs/endpoints/flow-runs/schema#schema-pause-metadata) pauseMetadata object * Option 1 * Option 2 Show child attributes [​](https://www.activepieces.com/docs/endpoints/flow-runs/schema#schema-steps-one-of-0) steps object Show child attributes [​](https://www.activepieces.com/docs/endpoints/flow-runs/schema#schema-failed-step) failedStep object Show child attributes [​](https://www.activepieces.com/docs/endpoints/flow-runs/schema#schema-step-name-to-test) stepNameToTest string [​](https://www.activepieces.com/docs/endpoints/flow-runs/schema#schema-archived-at-one-of-0) archivedAt string | null [​](https://www.activepieces.com/docs/endpoints/flow-runs/schema#schema-steps-count) stepsCount number [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/flow-runs/schema.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/flow-runs/schema) [Delete Flow](https://www.activepieces.com/docs/endpoints/flows/delete) [Get Flow Run](https://www.activepieces.com/docs/endpoints/flow-runs/get) ⌘I --- # API Requests - Activepieces [Skip to main content](https://www.activepieces.com/docs/embedding/sdk-server-requests#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Misc API Requests [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) **Requirements:** * Activepieces version 0.34.5 or higher * SDK version 0.3.6 or higher You can use the embedded SDK to send requests to your instance and retrieve data. 1 [](https://www.activepieces.com/docs/embedding/sdk-server-requests#) Initialize the SDK Follow the instructions in the [Embed Builder](https://www.activepieces.com/docs/embedding/embed-builder) to initialize the SDK. 2 [](https://www.activepieces.com/docs/embedding/sdk-server-requests#) Call (request) Method **Request Parameters:** | Parameter Name | Required | Type | Description | | --- | --- | --- | --- | | path | ✅ | string | The path within your instance you want to hit (we prepend the path with your\_instance\_url/api/v1) | | method | ✅ | string | The http method to use ‘GET’, ‘POST’,‘PUT’, ‘DELETE’, ‘OPTIONS’, ‘PATCH’ and ‘HEAD | | body | ❌ | JSON object | The json body of your request | | queryParams | ❌ | Record | The query params to include in your request | [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/embedding/sdk-server-requests.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/embedding/sdk-server-requests) [SDK Changelog](https://www.activepieces.com/docs/embedding/sdk-changelog) ⌘I --- # Connection Deleted - Activepieces [Skip to main content](https://www.activepieces.com/docs/admin-guide/security/audit-logs/connection-deleted#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Audit Logs Connection Deleted [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) Example { "id": "", "created": "", "updated": "", "platformId": "", "action": "connection.deleted", "data": { "connection": { "displayName": "", "externalId": "", "pieceName": "", "status": "ACTIVE", "type": "OAUTH2", "id": "", "created": "", "updated": "" } }, "projectId": "", "projectDisplayName": "", "userId": "", "userEmail": "", "ip": "" } [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/connection-deleted#schema-id) id string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/connection-deleted#schema-created) created string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/connection-deleted#schema-updated) updated string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/connection-deleted#schema-platform-id) platformId string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/connection-deleted#schema-action-one-of-0) action Option 1 · enumOption 2 · enumOption 1 · enumOption 2 · enum required Available options: `connection.deleted` [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/connection-deleted#schema-data) data object required Show child attributes [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/connection-deleted#schema-project-id) projectId string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/connection-deleted#schema-project-display-name) projectDisplayName string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/connection-deleted#schema-user-id) userId string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/connection-deleted#schema-user-email) userEmail string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/connection-deleted#schema-ip) ip string [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/admin-guide/security/audit-logs/connection-deleted.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/admin-guide/security/audit-logs/connection-deleted) [Connection Upserted](https://www.activepieces.com/docs/admin-guide/security/audit-logs/connection-upserted) [Flow Run Started](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-run-started) ⌘I --- # Folder Updated - Activepieces [Skip to main content](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-updated#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Audit Logs Folder Updated [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) Example { "id": "", "created": "", "updated": "", "platformId": "", "action": "folder.updated", "data": { "folder": { "id": "", "displayName": "", "created": "", "updated": "" } }, "projectId": "", "projectDisplayName": "", "userId": "", "userEmail": "", "ip": "" } [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-updated#schema-id) id string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-updated#schema-created) created string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-updated#schema-updated) updated string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-updated#schema-platform-id) platformId string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-updated#schema-action-one-of-0) action Option 1 · enumOption 2 · enumOption 3 · enumOption 1 · enumOption 2 · enumOption 3 · enum required Available options: `folder.updated` [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-updated#schema-data) data object required Show child attributes [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-updated#schema-project-id) projectId string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-updated#schema-project-display-name) projectDisplayName string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-updated#schema-user-id) userId string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-updated#schema-user-email) userEmail string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-updated#schema-ip) ip string [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/admin-guide/security/audit-logs/folder-updated.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/admin-guide/security/audit-logs/folder-updated) [Folder Created](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-created) [Folder Deleted](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-deleted) ⌘I --- # List Flows Runs - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/flow-runs/list#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Flow Runs List Flows Runs [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) cURL cURL curl --request GET \ --url https://cloud.activepieces.com/api/v1/flow-runs \ --header 'Authorization: Bearer ' 200 { "data": [\ {\ "id": "",\ "created": "",\ "updated": "",\ "projectId": "",\ "flowId": "",\ "failParentOnFailure": true,\ "flowVersionId": "",\ "status": "FAILED",\ "environment": "PRODUCTION",\ "parentRunId": "",\ "triggeredBy": "",\ "tags": [\ ""\ ],\ "flowVersion": {\ "displayName": ""\ },\ "logsFileId": "",\ "startTime": "",\ "finishTime": "",\ "failedStep": {\ "name": "",\ "displayName": ""\ },\ "stepNameToTest": "",\ "archivedAt": null,\ "stepsCount": 123\ }\ ], "next": "", "previous": "" } GET / v1 / flow-runs Try it cURL cURL curl --request GET \ --url https://cloud.activepieces.com/api/v1/flow-runs \ --header 'Authorization: Bearer ' 200 { "data": [\ {\ "id": "",\ "created": "",\ "updated": "",\ "projectId": "",\ "flowId": "",\ "failParentOnFailure": true,\ "flowVersionId": "",\ "status": "FAILED",\ "environment": "PRODUCTION",\ "parentRunId": "",\ "triggeredBy": "",\ "tags": [\ ""\ ],\ "flowVersion": {\ "displayName": ""\ },\ "logsFileId": "",\ "startTime": "",\ "finishTime": "",\ "failedStep": {\ "name": "",\ "displayName": ""\ },\ "stepNameToTest": "",\ "archivedAt": null,\ "stepsCount": 123\ }\ ], "next": "", "previous": "" } #### Authorizations [​](https://www.activepieces.com/docs/endpoints/flow-runs/list#authorization-authorization) Authorization string header required Use your api key generated from the admin console #### Query Parameters [​](https://www.activepieces.com/docs/endpoints/flow-runs/list#parameter-flow-id) flowId string\[\] Pattern: `^[0-9a-zA-Z]{21}$` [​](https://www.activepieces.com/docs/endpoints/flow-runs/list#parameter-tags) tags string\[\] [​](https://www.activepieces.com/docs/endpoints/flow-runs/list#parameter-status) status enum\[\] Available options: `FAILED` [​](https://www.activepieces.com/docs/endpoints/flow-runs/list#parameter-limit) limit number [​](https://www.activepieces.com/docs/endpoints/flow-runs/list#parameter-cursor) cursor string [​](https://www.activepieces.com/docs/endpoints/flow-runs/list#parameter-created-after) createdAfter string [​](https://www.activepieces.com/docs/endpoints/flow-runs/list#parameter-created-before) createdBefore string [​](https://www.activepieces.com/docs/endpoints/flow-runs/list#parameter-project-id) projectId string required Pattern: `^[0-9a-zA-Z]{21}$` [​](https://www.activepieces.com/docs/endpoints/flow-runs/list#parameter-failed-step-name) failedStepName string [​](https://www.activepieces.com/docs/endpoints/flow-runs/list#parameter-flow-run-ids) flowRunIds string\[\] Pattern: `^[0-9a-zA-Z]{21}$` [​](https://www.activepieces.com/docs/endpoints/flow-runs/list#parameter-include-archived) includeArchived boolean #### Response 200 - application/json Default Response [​](https://www.activepieces.com/docs/endpoints/flow-runs/list#response-data) data object\[\] required Show child attributes [​](https://www.activepieces.com/docs/endpoints/flow-runs/list#response-next-one-of-0) next string | null Cursor to the next page [​](https://www.activepieces.com/docs/endpoints/flow-runs/list#response-previous-one-of-0) previous string | null Cursor to the previous page [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/flow-runs/list.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/flow-runs/list) [Get Flow Run](https://www.activepieces.com/docs/endpoints/flow-runs/get) [Get Sample Data](https://www.activepieces.com/docs/endpoints/sample-data/get) ⌘I --- # Overview - Activepieces [Skip to main content](https://www.activepieces.com/docs/build-pieces/building-pieces/overview#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Build a Piece Overview [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) Building pieces is fun and important; it allows you to customize Activepieces for your own needs. We love contributions! In fact, most of the pieces are contributed by the community. Feel free to open a pull request. **Friendly Tip:** For the fastest support, we recommend joining our Discord community. We are dedicated to addressing every question and concern raised there. Code with TypeScript -------------------- Build pieces using TypeScript for a more powerful and flexible development process. Hot Reloading ------------- See your changes in the browser within 7 seconds. Open Source ----------- Work within the open-source environment, explore, and contribute to other pieces. Community Support ----------------- Join our large community, where you can ask questions, share ideas, and develop alongside others. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/build-pieces/building-pieces/overview.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/build-pieces/building-pieces/overview) [Start Building](https://www.activepieces.com/docs/build-pieces/building-pieces/start-building) ⌘I --- # Signing Key Created - Activepieces [Skip to main content](https://www.activepieces.com/docs/admin-guide/security/audit-logs/signing-key-created#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Audit Logs Signing Key Created [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) Example { "id": "", "created": "", "updated": "", "platformId": "", "action": "signing.key.created", "data": { "signingKey": { "id": "", "created": "", "updated": "", "displayName": "" } }, "projectId": "", "projectDisplayName": "", "userId": "", "userEmail": "", "ip": "" } [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/signing-key-created#schema-id) id string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/signing-key-created#schema-created) created string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/signing-key-created#schema-updated) updated string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/signing-key-created#schema-platform-id) platformId string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/signing-key-created#schema-action) action enum required Available options: `signing.key.created` [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/signing-key-created#schema-data) data object required Show child attributes [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/signing-key-created#schema-project-id) projectId string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/signing-key-created#schema-project-display-name) projectDisplayName string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/signing-key-created#schema-user-id) userId string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/signing-key-created#schema-user-email) userEmail string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/signing-key-created#schema-ip) ip string [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/admin-guide/security/audit-logs/signing-key-created.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/admin-guide/security/audit-logs/signing-key-created) [User Password Reset](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-password-reset) ⌘I --- # SDK Changelog - Activepieces [Skip to main content](https://www.activepieces.com/docs/embedding/sdk-changelog#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Misc SDK Changelog [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [10/27/2025 (0.8.1)](https://www.activepieces.com/docs/embedding/sdk-changelog#10%2F27%2F2025-0-8-1) * [09/21/2025 (0.8.0)](https://www.activepieces.com/docs/embedding/sdk-changelog#09%2F21%2F2025-0-8-0) * [07/30/2025 (0.7.0)](https://www.activepieces.com/docs/embedding/sdk-changelog#07%2F30%2F2025-0-7-0) * [07/07/2025 (0.6.0)](https://www.activepieces.com/docs/embedding/sdk-changelog#07%2F07%2F2025-0-6-0) * [03/07/2025 (0.5.0)](https://www.activepieces.com/docs/embedding/sdk-changelog#03%2F07%2F2025-0-5-0) * [17/06/2025 (0.5.0-rc.1)](https://www.activepieces.com/docs/embedding/sdk-changelog#17%2F06%2F2025-0-5-0-rc-1) * [16/06/2025 (0.5.0-rc.0)](https://www.activepieces.com/docs/embedding/sdk-changelog#16%2F06%2F2025-0-5-0-rc-0) * [26/05/2025 (0.4.1)](https://www.activepieces.com/docs/embedding/sdk-changelog#26%2F05%2F2025-0-4-1) * [20/05/2025 (0.4.0)](https://www.activepieces.com/docs/embedding/sdk-changelog#20%2F05%2F2025-0-4-0) * [17/04/2025 (0.3.7)](https://www.activepieces.com/docs/embedding/sdk-changelog#17%2F04%2F2025-0-3-7) * [16/04/2025 (0.3.6)](https://www.activepieces.com/docs/embedding/sdk-changelog#16%2F04%2F2025-0-3-6) * [24/2/2025 (0.3.5)](https://www.activepieces.com/docs/embedding/sdk-changelog#24%2F2%2F2025-0-3-5) * [04/02/2025 (0.3.4)](https://www.activepieces.com/docs/embedding/sdk-changelog#04%2F02%2F2025-0-3-4) * [26/01/2025 (0.3.3)](https://www.activepieces.com/docs/embedding/sdk-changelog#26%2F01%2F2025-0-3-3) * [04/12/2024 (0.3.0)](https://www.activepieces.com/docs/embedding/sdk-changelog#04%2F12%2F2024-0-3-0) **Breaking Change:** If your Activepieces image version is < 0.45.0 and (you are using the connect method from the embed SDk, and need the connection externalId to be returned after the user creates it OR if you want to reconnect a specific connection with an externalId), you must upgrade your Activepieces image to >= 0.45.0 Between Acitvepieces image version 0.32.1 and 0.46.4 the navigation handler was including the project id in the path, this might have broken implementation logic for people using the navigation handler, this has been fixed from 0.46.5 and onwards, the handler won’t show the project id prepended to routes. Change log format: MM/DD/YYYY (version) ### [​](https://www.activepieces.com/docs/embedding/sdk-changelog#10/27/2025-0-8-1) 10/27/2025 (0.8.1) * SDK URL: [https://cdn.activepieces.com/sdk/embed/0.8.1.js](https://cdn.activepieces.com/sdk/embed/0.8.1.js) * Fixed a bug where if you didn’t start your navigation route with ’/’ it would redirect you to ‘/flows’ ### [​](https://www.activepieces.com/docs/embedding/sdk-changelog#09/21/2025-0-8-0) 09/21/2025 (0.8.0) * SDK URL: [https://cdn.activepieces.com/sdk/embed/0.8.0.js](https://cdn.activepieces.com/sdk/embed/0.8.0.js) * This version requires you to **upgrade Activepieces to [0.70.0](https://github.com/activepieces/activepieces/releases/tag/0.70.0) **. * Removed `embedding.dashboard.hideSettings`. * Added `embedding.dashboard.hidePageHeader` parameter to the [configure](https://www.activepieces.com/docs/embedding/embed-builder#configure-parameters) method **(value: true | false)**. ### [​](https://www.activepieces.com/docs/embedding/sdk-changelog#07/30/2025-0-7-0) 07/30/2025 (0.7.0) * SDK URL: [https://cdn.activepieces.com/sdk/embed/0.7.0.js](https://cdn.activepieces.com/sdk/embed/0.7.0.js) * This version requires you to **upgrade Activepieces to [0.66.7](https://github.com/activepieces/activepieces/releases/tag/0.66.7) ** * Added `embedding.dashboard.hideSettings` parameter to the [configure](https://www.activepieces.com/docs/embedding/embed-builder#configure-parameters) method **(value: true | false)**. ### [​](https://www.activepieces.com/docs/embedding/sdk-changelog#07/07/2025-0-6-0) 07/07/2025 (0.6.0) * SDK URL: [https://cdn.activepieces.com/sdk/embed/0.6.0.js](https://cdn.activepieces.com/sdk/embed/0.6.0.js) * This version requires you to **upgrade Activepieces to [0.66.1](https://github.com/activepieces/activepieces/releases/tag/0.66.1) ** * Added `embedding.dashboard.hideFlowsPageNavbar` parameter to the [configure](https://www.activepieces.com/docs/embedding/embed-builder#configure-parameters) method **(value: true | false)**. * **(Breaking Change)** `embedding.dashboard.hideSidebar` used to hide the navbar above the flows table in the dashboard now it relies on `embedding.dashboard.hideFlowsPageNavbar`. ### [​](https://www.activepieces.com/docs/embedding/sdk-changelog#03/07/2025-0-5-0) 03/07/2025 (0.5.0) * SDK URL: [https://cdn.activepieces.com/sdk/embed/0.5.0.js](https://cdn.activepieces.com/sdk/embed/0.5.0.js) * This version requires you to **upgrade Activepieces to [0.64.2](https://github.com/activepieces/activepieces/releases/tag/0.64.2) ** * Added `embedding.hideDuplicateFlow` parameter to the [configure](https://www.activepieces.com/docs/embedding/embed-builder#configure-parameters) method **(value: true | false)**. * Added `embedding.builder.homeButtonIcon` parameter to the [configure](https://www.activepieces.com/docs/embedding/embed-builder#configure-parameters) method **(value: ‘logo’ | ‘back’)**, if set to **‘back’** the tooltip shown on hovering the home button is removed. * Added `embedding.locale` parameter to the [configure](https://www.activepieces.com/docs/embedding/embed-builder#configure-parameters) method, it takes [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) locale codes, here are the ones supported: **(‘en’ | ‘nl’ | ‘it’ | ‘de’ | ‘fr’ | ‘bg’ | ‘uk’ | ‘hu’ | ‘es’ | ‘ja’ | ‘id’ | ‘vi’ | ‘zh’ | ‘pt’)** * Added `embedding.styling.mode` parameter to [configure](https://www.activepieces.com/docs/embedding/embed-builder#configure-parameters) method **(value: ‘light’ | ‘dark’)** * **(Breaking Change)** Removed `embedding.builder.hideLogo` parameter from the [configure](https://www.activepieces.com/docs/embedding/embed-builder#configure-parameters) method. * **(Breaking Change)** Removed MCP methods from sdk. ### [​](https://www.activepieces.com/docs/embedding/sdk-changelog#17/06/2025-0-5-0-rc-1) 17/06/2025 (0.5.0-rc.1) * SDK URL: [https://cdn.activepieces.com/sdk/embed/0.5.0-rc.1.js](https://cdn.activepieces.com/sdk/embed/0.5.0-rc.1.js) * This version requires you to **upgrade Activepieces to [0.64.0-rc.0](https://github.com/activepieces/activepieces/pkgs/container/activepieces/438888138?tag=0.64.0-rc.0) ** * Revert back the `prefix` parameter from the [configure](https://www.activepieces.com/docs/embedding/embed-builder#configure-parameters) method. ### [​](https://www.activepieces.com/docs/embedding/sdk-changelog#16/06/2025-0-5-0-rc-0) 16/06/2025 (0.5.0-rc.0) * SDK URL: [https://cdn.activepieces.com/sdk/embed/0.5.0-rc.0.js](https://cdn.activepieces.com/sdk/embed/0.5.0-rc.0.js) * This version requires you to **upgrade Activepieces to [0.64.0-rc.0](https://github.com/activepieces/activepieces/pkgs/container/activepieces/438888138?tag=0.64.0-rc.0) ** * Added `embedding.hideDuplicateFlow` parameter to the [configure](https://www.activepieces.com/docs/embedding/embed-builder#configure-parameters) method **(value: true | false)**. * Added `embedding.builder.homeButtonIcon` parameter to the [configure](https://www.activepieces.com/docs/embedding/embed-builder#configure-parameters) method **(value: ‘logo’ | ‘back’)**, if set to **‘back’** the tooltip shown on hovering the home button is removed. * Added `embedding.locale` parameter to the [configure](https://www.activepieces.com/docs/embedding/embed-builder#configure-parameters) method, it takes [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) locale codes, here are the ones supported: **(‘en’ | ‘nl’ | ‘it’ | ‘de’ | ‘fr’ | ‘bg’ | ‘uk’ | ‘hu’ | ‘es’ | ‘ja’ | ‘id’ | ‘vi’ | ‘zh’ | ‘pt’)** * Added `embedding.styling.mode` parameter to [configure](https://www.activepieces.com/docs/embedding/embed-builder#configure-parameters) method **(value: ‘light’ | ‘dark’)** * **(Breaking Change)** Removed `prefix` parameter from the [configure](https://www.activepieces.com/docs/embedding/embed-builder#configure-parameters) method. * **(Breaking Change)** Removed `embedding.builder.hideLogo` parameter from the [configure](https://www.activepieces.com/docs/embedding/embed-builder#configure-parameters) method. ### [​](https://www.activepieces.com/docs/embedding/sdk-changelog#26/05/2025-0-4-1) 26/05/2025 (0.4.1) * Fixed an issue where sometimes the embed HTML file was getting cached. ### [​](https://www.activepieces.com/docs/embedding/sdk-changelog#20/05/2025-0-4-0) 20/05/2025 (0.4.0) — Note: we didn’t consider adding optional new parameters as a breaking change so we were bumping the patch version, but that was wrong and we will begin bumping the minor version for those changes from now on, and patch version will only get bumped for bug fixes. * This version requires you to update Activepieces to 0.56.0 * Added `embedding.hideExportAndImportFlow` parameter to the [configure](https://www.activepieces.com/docs/embedding/embed-builder#configure-parameters) method. * Added new possible value to the configure method param `embed.builder.disableNavigation` which is “keep\_home\_button\_only” that keeps only the home button and hides the folder name with the delete flow action. * Added new param to the configure method `embed.builder.homeButtonClickedHandler`, that overrides the navigation behaviour on clicking the home button. ### [​](https://www.activepieces.com/docs/embedding/sdk-changelog#17/04/2025-0-3-7) 17/04/2025 (0.3.7) * Added MCP methods to update MCP configurations. ### [​](https://www.activepieces.com/docs/embedding/sdk-changelog#16/04/2025-0-3-6) 16/04/2025 (0.3.6) * Added the [request](https://www.activepieces.com/docs/embedding/sdk-server-requests) method which allows you to call our backend API. ### [​](https://www.activepieces.com/docs/embedding/sdk-changelog#24/2/2025-0-3-5) 24/2/2025 (0.3.5) * Added a new parameter to the connect method to make the connection dialog a popup instead of an iframe taking the full page. * Fixed a bug where the returned promise from the connect method was always resolved to {connection: undefined} * Now when you use the connect method with the “connectionName” parameter, the user will reconnect to the connection with the matching externalId instead of creating a new one. ### [​](https://www.activepieces.com/docs/embedding/sdk-changelog#04/02/2025-0-3-4) 04/02/2025 (0.3.4) * This version requires you to update Activepieces to 0.41.0 * Adds the ability to pass font family name and font url to the embed sdk ### [​](https://www.activepieces.com/docs/embedding/sdk-changelog#26/01/2025-0-3-3) 26/01/2025 (0.3.3) * This version requires you to update Activepieces to 0.39.8 * activepieces.configure method was being resolved before the user was authenticated, this is fixed now, so you can use activepieces.navigate method to navigate to your desired initial route. ### [​](https://www.activepieces.com/docs/embedding/sdk-changelog#04/12/2024-0-3-0) 04/12/2024 (0.3.0) * add custom navigation handler ([#4500](https://github.com/activepieces/activepieces/pull/4500) ) * allow passing a predefined name for connection in connect method ([#4485](https://github.com/activepieces/activepieces/pull/4485) ) * add changelog ([#4503](https://github.com/activepieces/activepieces/pull/4503) ) [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/embedding/sdk-changelog.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/embedding/sdk-changelog) [Predefined Connection](https://www.activepieces.com/docs/embedding/predefined-connection) [API Requests](https://www.activepieces.com/docs/embedding/sdk-server-requests) ⌘I --- # Embed Builder - Activepieces [Skip to main content](https://www.activepieces.com/docs/embedding/embed-builder#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Essentials Embed Builder [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Configure SDK](https://www.activepieces.com/docs/embedding/embed-builder#configure-sdk) This feature is available in our paid editions. Contact us [here](https://www.activepieces.com/sales) , and we'll be delighted to assist you! This documentation explains how to embed the Activepieces iframe inside your application and customize it. [​](https://www.activepieces.com/docs/embedding/embed-builder#configure-sdk) Configure SDK --------------------------------------------------------------------------------------------- Adding the embedding SDK script will initialize an object in your window called `activepieces`, which has a method called `configure` that you should call after the container has been rendered. The following scripts shouldn’t contain the `async` or `defer` attributes. These steps assume you have already generated a JWT token from the backend. If not, please check the [provision-users](https://www.activepieces.com/docs/embedding/provision-users) page. `configure` returns a promise which is resolved after authentication is done. Please check the [navigation](https://www.activepieces.com/docs/embedding/navigation) section, as it’s very important to understand how navigation works and how to supply an auto-sync experience. **Configure Parameters:** | Parameter Name | Required | Type | Description | | --- | --- | --- | --- | | instanceUrl | ✅ | string | The url of the instance hosting Activepieces, could be [https://cloud.activepieces.com](https://cloud.activepieces.com/)
if you are a cloud user. | | jwtToken | ✅ | string | The jwt token you generated to authenticate your users to Activepieces. | | prefix | ❌ | string | Some customers have an embedding prefix, like this `/`. For example if the prefix is `/automation` and the Activepieces url is `/flows` the full url would be `/automation/flows`. | | embedding.containerId | ❌ | string | The html element’s id that is going to be containing Activepieces’s iframe. | | embedding.builder.disableNavigation | ❌ | boolean \| `keep_home_button_only` | Hides the folder name, home button (if not set to [`keep_home_button_only`](https://www.activepieces.com/docs/embedding/sdk-changelog#20%2F05%2F2025-0-4-0)
) and delete option in the builder, by default it is false. | | embedding.builder.hideFlowName | ❌ | boolean | Hides the flow name and flow actions dropdown in the builder’s header, by default it is false. | | embedding.builder.homeButtonClickedHandler | ❌ | `()=>void` | Callback that stops home button from navigating to dashboard and overrides it with this handler (added in [0.4.0](https://www.activepieces.com/docs/embedding/sdk-changelog#20%2F05%2F2025-0-4-0)
) | | embedding.builder.homeButtonIcon | ❌ | `logo` \| `back` | if set to **`back`** the tooltip shown on hovering the home button is removed (added in [0.5.0](https://www.activepieces.com/docs/embedding/sdk-changelog#03%2F07%2F2025-0-5-0)
) | | embedding.dashboard.hideSidebar | ❌ | boolean | Controls the visibility of the sidebar in the dashboard, by default it is false. | | embedding.dashboard.hideFlowsPageNavbar | ❌ | boolean | Controls the visibility of the navbar showing flows,issues and runs above the flows table in the dashboard, by default it is false. (added in [0.6.0](https://www.activepieces.com/docs/embedding/sdk-changelog#07%2F07%2F2025-0-6-0)
) | | embedding.dashboard.hidePageHeader | ❌ | boolean | Hides the page header in the dashboard by default it is false. (added in [0.8.0](https://www.activepieces.com/docs/embedding/sdk-changelog#09%2F21%2F2025-0-8-0)
) | | embedding.hideFolders | ❌ | boolean | Hides all things related to folders in both the flows table and builder by default it is false. | | embedding.styling.fontUrl | ❌ | string | The url of the font to be used in the embedding, by default it is `https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500;700&display=swap`. | | embedding.styling.fontFamily | ❌ | string | The font family to be used in the embedding, by default it is `Roboto`. | | embedding.styling.mode | ❌ | `light` \| `dark` | Controls light/dark mode (added in [0.5.0](https://www.activepieces.com/docs/embedding/sdk-changelog#03%2F07%2F2025-0-5-0)
) | | embedding.hideExportAndImportFlow | ❌ | boolean | Hides the option to export or import flows (added in [0.4.0](https://www.activepieces.com/docs/embedding/sdk-changelog#20%2F05%2F2025-0-4-0)
) | | embedding.hideDuplicateFlow | ❌ | boolean | Hides the option to duplicate a flow (added in [0.5.0](https://www.activepieces.com/docs/embedding/sdk-changelog#03%2F07%2F2025-0-5-0)
) | | embedding.locale | ❌ | `en` \| `nl` \| `de` \| `fr` \| `es` \| `ja` \| `zh` \| `pt` \| `zh-TW` \| `ru` \| | it takes [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes)
locale codes (added in [0.5.0](https://www.activepieces.com/docs/embedding/sdk-changelog#03%2F07%2F2025-0-5-0)
) | | navigation.handler | ❌ | `({route:string}) => void` | This callback will be triggered each time a route in Activepieces changes, you can read more about it [here](https://www.activepieces.com/docs/embedding/navigation) | For the font to be loaded, you need to set both the `fontUrl` and `fontFamily` properties. If you only set one of them, the default font will be used. The default font is `Roboto`. The font weights we use are the default font-weights from [tailwind](https://tailwindcss.com/docs/font-weight) . [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/embedding/embed-builder.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/embedding/embed-builder) [Provision Users](https://www.activepieces.com/docs/embedding/provision-users) [Show/Hide Pieces](https://www.activepieces.com/docs/embedding/customize-pieces) ⌘I --- # Delete Flow - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/flows/delete#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Flows Delete Flow [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) cURL cURL curl --request DELETE \ --url https://cloud.activepieces.com/api/v1/flows/{id} \ --header 'Authorization: Bearer ' DELETE / v1 / flows / {id} Try it cURL cURL curl --request DELETE \ --url https://cloud.activepieces.com/api/v1/flows/{id} \ --header 'Authorization: Bearer ' #### Authorizations [​](https://www.activepieces.com/docs/endpoints/flows/delete#authorization-authorization) Authorization string header required Use your api key generated from the admin console #### Path Parameters [​](https://www.activepieces.com/docs/endpoints/flows/delete#parameter-id) id string required Pattern: `^[0-9a-zA-Z]{21}$` #### Response 204 - application/json Default Response [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/flows/delete.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/flows/delete) [List Flows](https://www.activepieces.com/docs/endpoints/flows/list) [Flow Run Schema](https://www.activepieces.com/docs/endpoints/flow-runs/schema) ⌘I --- # Folder Schema - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/folders/schema#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Folders Folder Schema [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) Example { "id": "", "created": "", "updated": "", "projectId": "", "displayName": "", "displayOrder": 123 } [​](https://www.activepieces.com/docs/endpoints/folders/schema#schema-id) id string required [​](https://www.activepieces.com/docs/endpoints/folders/schema#schema-created) created string required [​](https://www.activepieces.com/docs/endpoints/folders/schema#schema-updated) updated string required [​](https://www.activepieces.com/docs/endpoints/folders/schema#schema-project-id) projectId string required [​](https://www.activepieces.com/docs/endpoints/folders/schema#schema-display-name) displayName string required [​](https://www.activepieces.com/docs/endpoints/folders/schema#schema-display-order) displayOrder number required [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/folders/schema.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/folders/schema) [Configure](https://www.activepieces.com/docs/endpoints/git-repos/configure) [Create Folder](https://www.activepieces.com/docs/endpoints/folders/create) ⌘I --- # Folder Deleted - Activepieces [Skip to main content](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-deleted#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Audit Logs Folder Deleted [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) Example { "id": "", "created": "", "updated": "", "platformId": "", "action": "folder.updated", "data": { "folder": { "id": "", "displayName": "", "created": "", "updated": "" } }, "projectId": "", "projectDisplayName": "", "userId": "", "userEmail": "", "ip": "" } [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-deleted#schema-id) id string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-deleted#schema-created) created string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-deleted#schema-updated) updated string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-deleted#schema-platform-id) platformId string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-deleted#schema-action-one-of-0) action Option 1 · enumOption 2 · enumOption 3 · enumOption 1 · enumOption 2 · enumOption 3 · enum required Available options: `folder.updated` [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-deleted#schema-data) data object required Show child attributes [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-deleted#schema-project-id) projectId string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-deleted#schema-project-display-name) projectDisplayName string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-deleted#schema-user-id) userId string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-deleted#schema-user-email) userEmail string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-deleted#schema-ip) ip string [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/admin-guide/security/audit-logs/folder-deleted.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/admin-guide/security/audit-logs/folder-deleted) [Folder Updated](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-updated) [User Signed In](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-signed-in) ⌘I --- # Delete Template - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/templates/delete#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Templates Delete Template [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) cURL cURL curl --request DELETE \ --url https://cloud.activepieces.com/api/v1/templates/{id} \ --header 'Authorization: Bearer ' DELETE / v1 / templates / {id} Try it cURL cURL curl --request DELETE \ --url https://cloud.activepieces.com/api/v1/templates/{id} \ --header 'Authorization: Bearer ' #### Authorizations [​](https://www.activepieces.com/docs/endpoints/templates/delete#authorization-authorization) Authorization string header required Use your api key generated from the admin console #### Path Parameters [​](https://www.activepieces.com/docs/endpoints/templates/delete#parameter-id) id string required #### Response 200 Default Response [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/templates/delete.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/templates/delete) [Create Template](https://www.activepieces.com/docs/endpoints/templates/create) [Get Template](https://www.activepieces.com/docs/endpoints/templates/get) ⌘I --- # Navigation - Activepieces [Skip to main content](https://www.activepieces.com/docs/embedding/navigation#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Misc Navigation [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Automatically Sync URL](https://www.activepieces.com/docs/embedding/navigation#automatically-sync-url) * [Navigate Method](https://www.activepieces.com/docs/embedding/navigation#navigate-method) * [Navigate to Initial Route](https://www.activepieces.com/docs/embedding/navigation#navigate-to-initial-route) By default, navigating within your embedded instance of Activepieces doesn’t affect the client’s browser history or viewed URL. Activepieces only provide a **handler**, that trigger on every route change in the **iframe**. [​](https://www.activepieces.com/docs/embedding/navigation#automatically-sync-url) Automatically Sync URL ------------------------------------------------------------------------------------------------------------ You can use the following snippet when configuring the SDK, which will implement a handler that syncs the Activepieces iframe with your browser: The following snippet listens when the user clicks backward, so it syncs the route back to the iframe using `activepieces.navigate` and in the handler, it updates the URL of the browser. const instanceUrl = 'YOUR_INSTANCE_URL'; const jwtToken = 'YOUR_GENERATED_JWT_TOKEN'; const containerId = 'YOUR_CONTAINER_ID'; activepieces.configure({ instanceUrl, jwtToken, embedding: { containerId, builder: { disableNavigation: false, hideFlowName: false }, dashboard: { hideSidebar: false }, hideFolders: false, navigation: { handler: ({ route }) => { //route can include search params at the end of it if (!window.location.href.endsWith(route)) { window.history.pushState({}, "", window.location.origin + route); } } } }, }); window.addEventListener("popstate", () => { const route = activepieces.extractActivepiecesRouteFromUrl({ vendorUrl: window.location.href }); activepieces.navigate({ route }); }); [​](https://www.activepieces.com/docs/embedding/navigation#navigate-method) Navigate Method ---------------------------------------------------------------------------------------------- If you use `activepieces.navigate({ route: '/flows' })` this will tell the embedded sdk where to navigate to. Here is the list for routes the sdk can navigate to: | Route | Description | | --- | --- | | `/flows` | Flows table | | `/flows/{flowId}` | Opens up a flow in the builder | | `/runs` | Runs table | | `/runs/{runId}` | Opens up a run in the builder | | `/connections` | Connections table | | `/tables` | Tables table | | `/tables/{tableId}` | Opens up a table | | `todos` | Todos table | | `todos/{todoId}` | Opens up a todo | [​](https://www.activepieces.com/docs/embedding/navigation#navigate-to-initial-route) Navigate to Initial Route ------------------------------------------------------------------------------------------------------------------ You can call the `navigate` method after initializing the sdk using the `configure` sdk: const flowId = '1234'; const instanceUrl = 'YOUR_INSTANCE_URL'; const jwtToken = 'YOUR_GENERATED_JWT_TOKEN'; activepieces.configure({ instanceUrl, jwtToken, }).then(() => { activepieces.navigate({ route: `/flows/${flowId}` }) }); [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/embedding/navigation.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/embedding/navigation) [Create/Update Connections](https://www.activepieces.com/docs/embedding/embed-connections) [Predefined Connection](https://www.activepieces.com/docs/embedding/predefined-connection) ⌘I --- # Delete Project - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/projects/delete#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Projects Delete Project [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) cURL cURL curl --request DELETE \ --url https://cloud.activepieces.com/api/v1/projects/{id} \ --header 'Authorization: Bearer ' DELETE / v1 / projects / {id} Try it cURL cURL curl --request DELETE \ --url https://cloud.activepieces.com/api/v1/projects/{id} \ --header 'Authorization: Bearer ' #### Authorizations [​](https://www.activepieces.com/docs/endpoints/projects/delete#authorization-authorization) Authorization string header required Use your api key generated from the admin console #### Path Parameters [​](https://www.activepieces.com/docs/endpoints/projects/delete#parameter-id) id string required #### Response 200 Default Response [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/projects/delete.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/projects/delete) [List Projects](https://www.activepieces.com/docs/endpoints/projects/list) [User Schema](https://www.activepieces.com/docs/endpoints/users/schema) ⌘I --- # Project Member Schema - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/project-members/schema#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Project Members Project Member Schema [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) Example { "id": "", "created": "", "updated": "", "platformId": "", "userId": "", "projectId": "", "projectRoleId": "" } Project member is which user is assigned to a project. [​](https://www.activepieces.com/docs/endpoints/project-members/schema#schema-id) id string required [​](https://www.activepieces.com/docs/endpoints/project-members/schema#schema-created) created string required [​](https://www.activepieces.com/docs/endpoints/project-members/schema#schema-updated) updated string required [​](https://www.activepieces.com/docs/endpoints/project-members/schema#schema-platform-id) platformId string required Pattern: `^[0-9a-zA-Z]{21}$` [​](https://www.activepieces.com/docs/endpoints/project-members/schema#schema-user-id) userId string required Pattern: `^[0-9a-zA-Z]{21}$` [​](https://www.activepieces.com/docs/endpoints/project-members/schema#schema-project-id) projectId string required [​](https://www.activepieces.com/docs/endpoints/project-members/schema#schema-project-role-id) projectRoleId string required Pattern: `^[0-9a-zA-Z]{21}$` [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/project-members/schema.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/project-members/schema) [Delete User Invitation](https://www.activepieces.com/docs/endpoints/user-invitations/delete) [List Project Member](https://www.activepieces.com/docs/endpoints/project-members/list) ⌘I --- # Configure - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/git-repos/configure#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Git Sync Configure [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) cURL cURL curl --request POST \ --url https://cloud.activepieces.com/api/v1/git-repos \ --header 'Content-Type: application/json' \ --data ' { "projectId": "", "remoteUrl": "", "branch": "", "branchType": "PRODUCTION", "sshPrivateKey": "", "slug": "" } ' 201 { "id": "", "created": "", "updated": "", "remoteUrl": "", "branch": "", "branchType": "PRODUCTION", "projectId": "", "slug": "" } POST / v1 / git-repos Try it cURL cURL curl --request POST \ --url https://cloud.activepieces.com/api/v1/git-repos \ --header 'Content-Type: application/json' \ --data ' { "projectId": "", "remoteUrl": "", "branch": "", "branchType": "PRODUCTION", "sshPrivateKey": "", "slug": "" } ' 201 { "id": "", "created": "", "updated": "", "remoteUrl": "", "branch": "", "branchType": "PRODUCTION", "projectId": "", "slug": "" } #### Body application/json [​](https://www.activepieces.com/docs/endpoints/git-repos/configure#body-project-id) projectId string required Minimum string length: `1` [​](https://www.activepieces.com/docs/endpoints/git-repos/configure#body-remote-url) remoteUrl string required Pattern: `^git@` [​](https://www.activepieces.com/docs/endpoints/git-repos/configure#body-branch) branch string required Minimum string length: `1` [​](https://www.activepieces.com/docs/endpoints/git-repos/configure#body-branch-type-one-of-0) branchType Option 1 · enumOption 2 · enumOption 1 · enumOption 2 · enum required Available options: `PRODUCTION` [​](https://www.activepieces.com/docs/endpoints/git-repos/configure#body-ssh-private-key) sshPrivateKey string required Minimum string length: `1` [​](https://www.activepieces.com/docs/endpoints/git-repos/configure#body-slug) slug string required Minimum string length: `1` #### Response 201 - application/json Default Response [​](https://www.activepieces.com/docs/endpoints/git-repos/configure#response-id) id string required [​](https://www.activepieces.com/docs/endpoints/git-repos/configure#response-created) created string required [​](https://www.activepieces.com/docs/endpoints/git-repos/configure#response-updated) updated string required [​](https://www.activepieces.com/docs/endpoints/git-repos/configure#response-remote-url) remoteUrl string required [​](https://www.activepieces.com/docs/endpoints/git-repos/configure#response-branch) branch string required [​](https://www.activepieces.com/docs/endpoints/git-repos/configure#response-branch-type-one-of-0) branchType Option 1 · enumOption 2 · enumOption 1 · enumOption 2 · enum required Available options: `PRODUCTION` [​](https://www.activepieces.com/docs/endpoints/git-repos/configure#response-project-id) projectId string required [​](https://www.activepieces.com/docs/endpoints/git-repos/configure#response-slug) slug string required [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/git-repos/configure.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/git-repos/configure) [Git Repos Schema](https://www.activepieces.com/docs/endpoints/git-repos/schema) [Folder Schema](https://www.activepieces.com/docs/endpoints/folders/schema) ⌘I --- # Create Project Release - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/project-releases/create#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Project Releases Create Project Release [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) cURL cURL curl --request POST \ --url https://cloud.activepieces.com/api/v1/project-releases \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "type": "ROLLBACK", "name": "", "projectId": "", "projectReleaseId": "", "description": "", "selectedFlowsIds": [\ ""\ ] } ' 201 { "id": "", "created": "", "updated": "", "projectId": "", "name": "", "fileId": "", "type": "GIT", "description": "", "importedBy": "", "importedByUser": { "id": "", "email": "", "firstName": "", "status": "ACTIVE", "platformRole": "ADMIN", "lastName": "", "created": "", "updated": "", "externalId": "", "platformId": "", "lastActiveDate": "", "imageUrl": "" } } POST / v1 / project-releases Try it cURL cURL curl --request POST \ --url https://cloud.activepieces.com/api/v1/project-releases \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "type": "ROLLBACK", "name": "", "projectId": "", "projectReleaseId": "", "description": "", "selectedFlowsIds": [\ ""\ ] } ' 201 { "id": "", "created": "", "updated": "", "projectId": "", "name": "", "fileId": "", "type": "GIT", "description": "", "importedBy": "", "importedByUser": { "id": "", "email": "", "firstName": "", "status": "ACTIVE", "platformRole": "ADMIN", "lastName": "", "created": "", "updated": "", "externalId": "", "platformId": "", "lastActiveDate": "", "imageUrl": "" } } #### Authorizations [​](https://www.activepieces.com/docs/endpoints/project-releases/create#authorization-authorization) Authorization string header required Use your api key generated from the admin console #### Body application/json * Option 1 * Option 2 * Option 3 [​](https://www.activepieces.com/docs/endpoints/project-releases/create#body-one-of-0-type) type enum required Available options: `ROLLBACK` [​](https://www.activepieces.com/docs/endpoints/project-releases/create#body-one-of-0-name) name string required [​](https://www.activepieces.com/docs/endpoints/project-releases/create#body-one-of-0-project-id) projectId string required [​](https://www.activepieces.com/docs/endpoints/project-releases/create#body-one-of-0-project-release-id) projectReleaseId string required [​](https://www.activepieces.com/docs/endpoints/project-releases/create#body-one-of-0-description-one-of-0) description string | null [​](https://www.activepieces.com/docs/endpoints/project-releases/create#body-one-of-0-selected-flows-ids-one-of-0) selectedFlowsIds string\[\] | null #### Response 201 - application/json Default Response [​](https://www.activepieces.com/docs/endpoints/project-releases/create#response-id) id string required [​](https://www.activepieces.com/docs/endpoints/project-releases/create#response-created) created string required [​](https://www.activepieces.com/docs/endpoints/project-releases/create#response-updated) updated string required [​](https://www.activepieces.com/docs/endpoints/project-releases/create#response-project-id) projectId string required [​](https://www.activepieces.com/docs/endpoints/project-releases/create#response-name) name string required [​](https://www.activepieces.com/docs/endpoints/project-releases/create#response-file-id) fileId string required [​](https://www.activepieces.com/docs/endpoints/project-releases/create#response-type-one-of-0) type Option 1 · enumOption 2 · enumOption 3 · enumOption 1 · enumOption 2 · enumOption 3 · enum required Available options: `GIT` [​](https://www.activepieces.com/docs/endpoints/project-releases/create#response-description-one-of-0) description string | null [​](https://www.activepieces.com/docs/endpoints/project-releases/create#response-imported-by-one-of-0) importedBy string | null [​](https://www.activepieces.com/docs/endpoints/project-releases/create#response-imported-by-user) importedByUser object Show child attributes [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/project-releases/create.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/project-releases/create) [Project Release Schema](https://www.activepieces.com/docs/endpoints/project-releases/schema) [Global Connection Schema](https://www.activepieces.com/docs/endpoints/global-connections/schema) ⌘I --- # Get Flow - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/flows/get#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Flows Get Flow [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) cURL cURL curl --request GET \ --url https://cloud.activepieces.com/api/v1/flows/{id} \ --header 'Authorization: Bearer ' 200 { "id": "", "created": "", "updated": "", "projectId": "", "externalId": "", "status": "ENABLED", "operationStatus": "NONE", "version": { "id": "", "created": "", "updated": "", "flowId": "", "displayName": "", "trigger": { "name": "", "valid": true, "displayName": "", "type": "PIECE_TRIGGER", "settings": { "propertySettings": {}, "pieceName": "", "pieceVersion": "", "input": {}, "sampleData": { "sampleDataFileId": "", "sampleDataInputFileId": "", "lastTestDate": "" }, "customLogoUrl": "", "triggerName": "" }, "nextAction": "" }, "valid": true, "agentIds": [\ ""\ ], "state": "LOCKED", "connectionIds": [\ ""\ ], "notes": [\ {\ "id": "",\ "content": "",\ "color": "orange",\ "position": {\ "x": 123,\ "y": 123\ },\ "size": {\ "width": 123,\ "height": 123\ },\ "createdAt": "",\ "updatedAt": "",\ "ownerId": ""\ }\ ], "updatedBy": "", "schemaVersion": "", "backupFiles": {} }, "ownerId": "", "folderId": "", "publishedVersionId": "", "metadata": {}, "timeSavedPerRun": 123, "templateId": "", "triggerSource": { "schedule": { "type": "CRON_EXPRESSION", "cronExpression": "", "timezone": "" } } } GET / v1 / flows / {id} Try it cURL cURL curl --request GET \ --url https://cloud.activepieces.com/api/v1/flows/{id} \ --header 'Authorization: Bearer ' 200 { "id": "", "created": "", "updated": "", "projectId": "", "externalId": "", "status": "ENABLED", "operationStatus": "NONE", "version": { "id": "", "created": "", "updated": "", "flowId": "", "displayName": "", "trigger": { "name": "", "valid": true, "displayName": "", "type": "PIECE_TRIGGER", "settings": { "propertySettings": {}, "pieceName": "", "pieceVersion": "", "input": {}, "sampleData": { "sampleDataFileId": "", "sampleDataInputFileId": "", "lastTestDate": "" }, "customLogoUrl": "", "triggerName": "" }, "nextAction": "" }, "valid": true, "agentIds": [\ ""\ ], "state": "LOCKED", "connectionIds": [\ ""\ ], "notes": [\ {\ "id": "",\ "content": "",\ "color": "orange",\ "position": {\ "x": 123,\ "y": 123\ },\ "size": {\ "width": 123,\ "height": 123\ },\ "createdAt": "",\ "updatedAt": "",\ "ownerId": ""\ }\ ], "updatedBy": "", "schemaVersion": "", "backupFiles": {} }, "ownerId": "", "folderId": "", "publishedVersionId": "", "metadata": {}, "timeSavedPerRun": 123, "templateId": "", "triggerSource": { "schedule": { "type": "CRON_EXPRESSION", "cronExpression": "", "timezone": "" } } } #### Authorizations [​](https://www.activepieces.com/docs/endpoints/flows/get#authorization-authorization) Authorization string header required Use your api key generated from the admin console #### Path Parameters [​](https://www.activepieces.com/docs/endpoints/flows/get#parameter-id) id string required Pattern: `^[0-9a-zA-Z]{21}$` #### Query Parameters [​](https://www.activepieces.com/docs/endpoints/flows/get#parameter-version-id) versionId string #### Response 200 - application/json Default Response [​](https://www.activepieces.com/docs/endpoints/flows/get#response-id) id string required [​](https://www.activepieces.com/docs/endpoints/flows/get#response-created) created string required [​](https://www.activepieces.com/docs/endpoints/flows/get#response-updated) updated string required [​](https://www.activepieces.com/docs/endpoints/flows/get#response-project-id) projectId string required [​](https://www.activepieces.com/docs/endpoints/flows/get#response-external-id) externalId string required [​](https://www.activepieces.com/docs/endpoints/flows/get#response-status-one-of-0) status Option 1 · enumOption 2 · enumOption 1 · enumOption 2 · enum required Available options: `ENABLED` [​](https://www.activepieces.com/docs/endpoints/flows/get#response-operation-status-one-of-0) operationStatus Option 1 · enumOption 2 · enumOption 3 · enumOption 4 · enumOption 1 · enumOption 2 · enumOption 3 · enumOption 4 · enum required Available options: `NONE` [​](https://www.activepieces.com/docs/endpoints/flows/get#response-version) version object required Show child attributes [​](https://www.activepieces.com/docs/endpoints/flows/get#response-owner-id-one-of-0) ownerId string | null [​](https://www.activepieces.com/docs/endpoints/flows/get#response-folder-id-one-of-0) folderId string | null [​](https://www.activepieces.com/docs/endpoints/flows/get#response-published-version-id-one-of-0) publishedVersionId string | null [​](https://www.activepieces.com/docs/endpoints/flows/get#response-metadata-one-of-0) metadata object Show child attributes [​](https://www.activepieces.com/docs/endpoints/flows/get#response-time-saved-per-run-one-of-0) timeSavedPerRun number | null [​](https://www.activepieces.com/docs/endpoints/flows/get#response-template-id-one-of-0) templateId string | null [​](https://www.activepieces.com/docs/endpoints/flows/get#response-trigger-source) triggerSource object Show child attributes [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/flows/get.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/flows/get) [Apply Flow Operation](https://www.activepieces.com/docs/endpoints/flows/update) [List Flows](https://www.activepieces.com/docs/endpoints/flows/list) ⌘I --- # Get Template - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/templates/get#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Templates Get Template [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) cURL cURL curl --request GET \ --url https://cloud.activepieces.com/api/v1/templates/{id} \ --header 'Authorization: Bearer ' GET / v1 / templates / {id} Try it cURL cURL curl --request GET \ --url https://cloud.activepieces.com/api/v1/templates/{id} \ --header 'Authorization: Bearer ' #### Authorizations [​](https://www.activepieces.com/docs/endpoints/templates/get#authorization-authorization) Authorization string header required Use your api key generated from the admin console #### Path Parameters [​](https://www.activepieces.com/docs/endpoints/templates/get#parameter-id) id string required #### Response 200 Default Response [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/templates/get.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/templates/get) [Delete Template](https://www.activepieces.com/docs/endpoints/templates/delete) [List Templates](https://www.activepieces.com/docs/endpoints/templates/list) ⌘I --- # Get Sample Data - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/sample-data/get#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Sample Data Get Sample Data [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) cURL cURL curl --request GET \ --url https://cloud.activepieces.com/api/v1/sample-data \ --header 'Authorization: Bearer ' GET / v1 / sample-data Try it cURL cURL curl --request GET \ --url https://cloud.activepieces.com/api/v1/sample-data \ --header 'Authorization: Bearer ' #### Authorizations [​](https://www.activepieces.com/docs/endpoints/sample-data/get#authorization-authorization) Authorization string header required Use your api key generated from the admin console #### Query Parameters [​](https://www.activepieces.com/docs/endpoints/sample-data/get#parameter-flow-id) flowId string required [​](https://www.activepieces.com/docs/endpoints/sample-data/get#parameter-flow-version-id) flowVersionId string required [​](https://www.activepieces.com/docs/endpoints/sample-data/get#parameter-step-name) stepName string required [​](https://www.activepieces.com/docs/endpoints/sample-data/get#parameter-project-id) projectId string required [​](https://www.activepieces.com/docs/endpoints/sample-data/get#parameter-one-of-0) type Option 1 · enumOption 2 · enumOption 1 · enumOption 2 · enum required Available options: `INPUT` #### Response 200 Default Response [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/sample-data/get.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/sample-data/get) [List Flows Runs](https://www.activepieces.com/docs/endpoints/flow-runs/list) [Piece Schema](https://www.activepieces.com/docs/endpoints/pieces/schema) ⌘I --- # Building Flows - Activepieces [Skip to main content](https://www.activepieces.com/docs/flows/building-flows#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Flows Building Flows [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Trigger](https://www.activepieces.com/docs/flows/building-flows#trigger) * [Action](https://www.activepieces.com/docs/flows/building-flows#action) [​](https://www.activepieces.com/docs/flows/building-flows#trigger) Trigger ------------------------------------------------------------------------------ The flow’s starting point determines its frequency of execution. There are various types of triggers available, such as Schedule Trigger, Webhook Trigger, or Event Trigger based on specific service. [​](https://www.activepieces.com/docs/flows/building-flows#action) Action ---------------------------------------------------------------------------- Actions come after the flow and control what occurs when the flow is activated, like running code or communicating with other services. In real-life scenario: ![Flow Parts](https://mintcdn.com/activepieces/ki8mFooo8mAmhMdP/resources/flow-parts.png?w=2500&fit=max&auto=format&n=ki8mFooo8mAmhMdP&q=85&s=8cfbbe303a83429b453e40a0fa4af0af) [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/flows/building-flows.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/flows/building-flows) [Welcome](https://www.activepieces.com/docs/overview/welcome) [Passing Data](https://www.activepieces.com/docs/flows/passing-data) ⌘I --- # Flow Schema - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/flows/schema#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Flows Flow Schema [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) Example { "id": "", "created": "", "updated": "", "projectId": "", "externalId": "", "status": "ENABLED", "operationStatus": "NONE", "ownerId": "", "folderId": "", "publishedVersionId": "", "metadata": {}, "timeSavedPerRun": 123, "templateId": "" } [​](https://www.activepieces.com/docs/endpoints/flows/schema#schema-id) id string required [​](https://www.activepieces.com/docs/endpoints/flows/schema#schema-created) created string required [​](https://www.activepieces.com/docs/endpoints/flows/schema#schema-updated) updated string required [​](https://www.activepieces.com/docs/endpoints/flows/schema#schema-project-id) projectId string required [​](https://www.activepieces.com/docs/endpoints/flows/schema#schema-external-id) externalId string required [​](https://www.activepieces.com/docs/endpoints/flows/schema#schema-status-one-of-0) status Option 1 · enumOption 2 · enumOption 1 · enumOption 2 · enum required Available options: `ENABLED` [​](https://www.activepieces.com/docs/endpoints/flows/schema#schema-operation-status-one-of-0) operationStatus Option 1 · enumOption 2 · enumOption 3 · enumOption 4 · enumOption 1 · enumOption 2 · enumOption 3 · enumOption 4 · enum required Available options: `NONE` [​](https://www.activepieces.com/docs/endpoints/flows/schema#schema-owner-id-one-of-0) ownerId string | null [​](https://www.activepieces.com/docs/endpoints/flows/schema#schema-folder-id-one-of-0) folderId string | null [​](https://www.activepieces.com/docs/endpoints/flows/schema#schema-published-version-id-one-of-0) publishedVersionId string | null [​](https://www.activepieces.com/docs/endpoints/flows/schema#schema-metadata-one-of-0) metadata object Show child attributes [​](https://www.activepieces.com/docs/endpoints/flows/schema#schema-time-saved-per-run-one-of-0) timeSavedPerRun number | null [​](https://www.activepieces.com/docs/endpoints/flows/schema#schema-template-id-one-of-0) templateId string | null [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/flows/schema.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/flows/schema) [Delete Connection](https://www.activepieces.com/docs/endpoints/connections/delete) [Create Flow](https://www.activepieces.com/docs/endpoints/flows/create) ⌘I --- # Create Flow - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/flows/create#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Flows Create Flow [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) cURL cURL curl --request POST \ --url https://cloud.activepieces.com/api/v1/flows \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "displayName": "", "projectId": "", "folderId": "", "folderName": "", "templateId": "", "metadata": {} } ' 201 { "id": "", "created": "", "updated": "", "projectId": "", "externalId": "", "status": "ENABLED", "operationStatus": "NONE", "version": { "id": "", "created": "", "updated": "", "flowId": "", "displayName": "", "trigger": { "name": "", "valid": true, "displayName": "", "type": "PIECE_TRIGGER", "settings": { "propertySettings": {}, "pieceName": "", "pieceVersion": "", "input": {}, "sampleData": { "sampleDataFileId": "", "sampleDataInputFileId": "", "lastTestDate": "" }, "customLogoUrl": "", "triggerName": "" }, "nextAction": "" }, "valid": true, "agentIds": [\ ""\ ], "state": "LOCKED", "connectionIds": [\ ""\ ], "notes": [\ {\ "id": "",\ "content": "",\ "color": "orange",\ "position": {\ "x": 123,\ "y": 123\ },\ "size": {\ "width": 123,\ "height": 123\ },\ "createdAt": "",\ "updatedAt": "",\ "ownerId": ""\ }\ ], "updatedBy": "", "schemaVersion": "", "backupFiles": {} }, "ownerId": "", "folderId": "", "publishedVersionId": "", "metadata": {}, "timeSavedPerRun": 123, "templateId": "", "triggerSource": { "schedule": { "type": "CRON_EXPRESSION", "cronExpression": "", "timezone": "" } } } POST / v1 / flows Try it cURL cURL curl --request POST \ --url https://cloud.activepieces.com/api/v1/flows \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "displayName": "", "projectId": "", "folderId": "", "folderName": "", "templateId": "", "metadata": {} } ' 201 { "id": "", "created": "", "updated": "", "projectId": "", "externalId": "", "status": "ENABLED", "operationStatus": "NONE", "version": { "id": "", "created": "", "updated": "", "flowId": "", "displayName": "", "trigger": { "name": "", "valid": true, "displayName": "", "type": "PIECE_TRIGGER", "settings": { "propertySettings": {}, "pieceName": "", "pieceVersion": "", "input": {}, "sampleData": { "sampleDataFileId": "", "sampleDataInputFileId": "", "lastTestDate": "" }, "customLogoUrl": "", "triggerName": "" }, "nextAction": "" }, "valid": true, "agentIds": [\ ""\ ], "state": "LOCKED", "connectionIds": [\ ""\ ], "notes": [\ {\ "id": "",\ "content": "",\ "color": "orange",\ "position": {\ "x": 123,\ "y": 123\ },\ "size": {\ "width": 123,\ "height": 123\ },\ "createdAt": "",\ "updatedAt": "",\ "ownerId": ""\ }\ ], "updatedBy": "", "schemaVersion": "", "backupFiles": {} }, "ownerId": "", "folderId": "", "publishedVersionId": "", "metadata": {}, "timeSavedPerRun": 123, "templateId": "", "triggerSource": { "schedule": { "type": "CRON_EXPRESSION", "cronExpression": "", "timezone": "" } } } #### Authorizations [​](https://www.activepieces.com/docs/endpoints/flows/create#authorization-authorization) Authorization string header required Use your api key generated from the admin console #### Body application/json [​](https://www.activepieces.com/docs/endpoints/flows/create#body-display-name) displayName string required [​](https://www.activepieces.com/docs/endpoints/flows/create#body-project-id) projectId string required [​](https://www.activepieces.com/docs/endpoints/flows/create#body-folder-id) folderId string [​](https://www.activepieces.com/docs/endpoints/flows/create#body-folder-name) folderName string [​](https://www.activepieces.com/docs/endpoints/flows/create#body-template-id) templateId string [​](https://www.activepieces.com/docs/endpoints/flows/create#body-metadata) metadata object Show child attributes #### Response 201 - application/json Default Response [​](https://www.activepieces.com/docs/endpoints/flows/create#response-id) id string required [​](https://www.activepieces.com/docs/endpoints/flows/create#response-created) created string required [​](https://www.activepieces.com/docs/endpoints/flows/create#response-updated) updated string required [​](https://www.activepieces.com/docs/endpoints/flows/create#response-project-id) projectId string required [​](https://www.activepieces.com/docs/endpoints/flows/create#response-external-id) externalId string required [​](https://www.activepieces.com/docs/endpoints/flows/create#response-status-one-of-0) status Option 1 · enumOption 2 · enumOption 1 · enumOption 2 · enum required Available options: `ENABLED` [​](https://www.activepieces.com/docs/endpoints/flows/create#response-operation-status-one-of-0) operationStatus Option 1 · enumOption 2 · enumOption 3 · enumOption 4 · enumOption 1 · enumOption 2 · enumOption 3 · enumOption 4 · enum required Available options: `NONE` [​](https://www.activepieces.com/docs/endpoints/flows/create#response-version) version object required Show child attributes [​](https://www.activepieces.com/docs/endpoints/flows/create#response-owner-id-one-of-0) ownerId string | null [​](https://www.activepieces.com/docs/endpoints/flows/create#response-folder-id-one-of-0) folderId string | null [​](https://www.activepieces.com/docs/endpoints/flows/create#response-published-version-id-one-of-0) publishedVersionId string | null [​](https://www.activepieces.com/docs/endpoints/flows/create#response-metadata-one-of-0) metadata object Show child attributes [​](https://www.activepieces.com/docs/endpoints/flows/create#response-time-saved-per-run-one-of-0) timeSavedPerRun number | null [​](https://www.activepieces.com/docs/endpoints/flows/create#response-template-id-one-of-0) templateId string | null [​](https://www.activepieces.com/docs/endpoints/flows/create#response-trigger-source) triggerSource object Show child attributes [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/flows/create.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/flows/create) [Flow Schema](https://www.activepieces.com/docs/endpoints/flows/schema) [Apply Flow Operation](https://www.activepieces.com/docs/endpoints/flows/update) ⌘I --- # User Signed Up - Activepieces [Skip to main content](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-signed-up#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Audit Logs User Signed Up [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) Example { "id": "", "created": "", "updated": "", "platformId": "", "action": "user.signed.up", "data": { "source": "credentials" }, "projectId": "", "projectDisplayName": "", "userId": "", "userEmail": "", "ip": "" } [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-signed-up#schema-id) id string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-signed-up#schema-created) created string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-signed-up#schema-updated) updated string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-signed-up#schema-platform-id) platformId string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-signed-up#schema-action) action enum required Available options: `user.signed.up` [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-signed-up#schema-data) data object required Show child attributes [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-signed-up#schema-project-id) projectId string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-signed-up#schema-project-display-name) projectDisplayName string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-signed-up#schema-user-id) userId string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-signed-up#schema-user-email) userEmail string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-signed-up#schema-ip) ip string [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/admin-guide/security/audit-logs/user-signed-up.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/admin-guide/security/audit-logs/user-signed-up) [User Signed In](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-signed-in) [User Email Verified](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-email-verified) ⌘I --- # Global Connection Schema - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/global-connections/schema#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Global Connections Global Connection Schema [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) Example { "id": "", "created": "", "updated": "", "externalId": "", "displayName": "", "type": "OAUTH2", "pieceName": "", "projectIds": [\ ""\ ], "scope": "PROJECT", "status": "ACTIVE", "pieceVersion": "", "platformId": "", "ownerId": "", "owner": { "id": "", "email": "", "firstName": "", "status": "ACTIVE", "platformRole": "ADMIN", "lastName": "", "created": "", "updated": "", "externalId": "", "platformId": "", "lastActiveDate": "", "imageUrl": "" }, "metadata": {}, "flowIds": [\ ""\ ] } App connection is a connection to an external app. [​](https://www.activepieces.com/docs/endpoints/global-connections/schema#schema-id) id string required [​](https://www.activepieces.com/docs/endpoints/global-connections/schema#schema-created) created string required [​](https://www.activepieces.com/docs/endpoints/global-connections/schema#schema-updated) updated string required [​](https://www.activepieces.com/docs/endpoints/global-connections/schema#schema-external-id) externalId string required [​](https://www.activepieces.com/docs/endpoints/global-connections/schema#schema-display-name) displayName string required [​](https://www.activepieces.com/docs/endpoints/global-connections/schema#schema-type-one-of-0) type Option 1 · enumOption 2 · enumOption 3 · enumOption 4 · enumOption 5 · enumOption 6 · enumOption 7 · enumOption 1 · enumOption 2 · enumOption 3 · enumOption 4 · enumOption 5 · enumOption 6 · enumOption 7 · enum required Available options: `OAUTH2` [​](https://www.activepieces.com/docs/endpoints/global-connections/schema#schema-piece-name) pieceName string required [​](https://www.activepieces.com/docs/endpoints/global-connections/schema#schema-project-ids) projectIds string\[\] required Pattern: `^[0-9a-zA-Z]{21}$` [​](https://www.activepieces.com/docs/endpoints/global-connections/schema#schema-scope-one-of-0) scope Option 1 · enumOption 2 · enumOption 1 · enumOption 2 · enum required Available options: `PROJECT` [​](https://www.activepieces.com/docs/endpoints/global-connections/schema#schema-status-one-of-0) status Option 1 · enumOption 2 · enumOption 3 · enumOption 1 · enumOption 2 · enumOption 3 · enum required Available options: `ACTIVE` [​](https://www.activepieces.com/docs/endpoints/global-connections/schema#schema-piece-version) pieceVersion string required [​](https://www.activepieces.com/docs/endpoints/global-connections/schema#schema-platform-id-one-of-0) platformId string | null [​](https://www.activepieces.com/docs/endpoints/global-connections/schema#schema-owner-id-one-of-0) ownerId string | null [​](https://www.activepieces.com/docs/endpoints/global-connections/schema#schema-owner-one-of-0) owner object Show child attributes [​](https://www.activepieces.com/docs/endpoints/global-connections/schema#schema-metadata-one-of-0) metadata object Show child attributes [​](https://www.activepieces.com/docs/endpoints/global-connections/schema#schema-flow-ids-one-of-0) flowIds string\[\] | null Pattern: `^[0-9a-zA-Z]{21}$` [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/global-connections/schema.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/global-connections/schema) [Create Project Release](https://www.activepieces.com/docs/endpoints/project-releases/create) [Upsert Global Connection](https://www.activepieces.com/docs/endpoints/global-connections/upsert) ⌘I --- # Apply Flow Operation - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/flows/update#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Flows Apply Flow Operation [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) cURL cURL curl --request POST \ --url https://cloud.activepieces.com/api/v1/flows/{id} \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "type": "MOVE_ACTION", "request": { "name": "", "newParentStep": "", "stepLocationRelativeToNewParent": "AFTER", "branchIndex": 123 } } ' POST / v1 / flows / {id} Try it cURL cURL curl --request POST \ --url https://cloud.activepieces.com/api/v1/flows/{id} \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "type": "MOVE_ACTION", "request": { "name": "", "newParentStep": "", "stepLocationRelativeToNewParent": "AFTER", "branchIndex": 123 } } ' #### Authorizations [​](https://www.activepieces.com/docs/endpoints/flows/update#authorization-authorization) Authorization string header required Use your api key generated from the admin console #### Path Parameters [​](https://www.activepieces.com/docs/endpoints/flows/update#parameter-id) id string required Pattern: `^[0-9a-zA-Z]{21}$` #### Body application/json * Move Action * Change Status * Lock and Publish * Copy as Draft * Lock Flow * Import Flow * Change Name * Delete Action * Update Action * Add Action * Update Trigger * Change Folder * Duplicate Action * Delete Branch * Add Branch * Duplicate Branch * Skip Action * Update Metadata * Option 19 * Option 20 * Update Minutes Saved * Update Owner * Update Note * Delete Note * Add Note [​](https://www.activepieces.com/docs/endpoints/flows/update#body-one-of-0-type) type enum required Available options: `MOVE_ACTION` [​](https://www.activepieces.com/docs/endpoints/flows/update#body-one-of-0-request) request object required Show child attributes #### Response 200 Default Response [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/flows/update.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/flows/update) [Create Flow](https://www.activepieces.com/docs/endpoints/flows/create) [Get Flow](https://www.activepieces.com/docs/endpoints/flows/get) ⌘I --- # List Flows - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/flows/list#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Flows List Flows [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) cURL cURL curl --request GET \ --url https://cloud.activepieces.com/api/v1/flows \ --header 'Authorization: Bearer ' 200 { "data": [\ {\ "id": "",\ "created": "",\ "updated": "",\ "projectId": "",\ "externalId": "",\ "status": "ENABLED",\ "operationStatus": "NONE",\ "version": {\ "id": "",\ "created": "",\ "updated": "",\ "flowId": "",\ "displayName": "",\ "trigger": {\ "name": "",\ "valid": true,\ "displayName": "",\ "type": "PIECE_TRIGGER",\ "settings": {\ "propertySettings": {},\ "pieceName": "",\ "pieceVersion": "",\ "input": {},\ "sampleData": {\ "sampleDataFileId": "",\ "sampleDataInputFileId": "",\ "lastTestDate": ""\ },\ "customLogoUrl": "",\ "triggerName": ""\ },\ "nextAction": ""\ },\ "valid": true,\ "agentIds": [\ ""\ ],\ "state": "LOCKED",\ "connectionIds": [\ ""\ ],\ "notes": [\ {\ "id": "",\ "content": "",\ "color": "orange",\ "position": {\ "x": 123,\ "y": 123\ },\ "size": {\ "width": 123,\ "height": 123\ },\ "createdAt": "",\ "updatedAt": "",\ "ownerId": ""\ }\ ],\ "updatedBy": "",\ "schemaVersion": "",\ "backupFiles": {}\ },\ "ownerId": "",\ "folderId": "",\ "publishedVersionId": "",\ "metadata": {},\ "timeSavedPerRun": 123,\ "templateId": "",\ "triggerSource": {\ "schedule": {\ "type": "CRON_EXPRESSION",\ "cronExpression": "",\ "timezone": ""\ }\ }\ }\ ], "next": "", "previous": "" } GET / v1 / flows Try it cURL cURL curl --request GET \ --url https://cloud.activepieces.com/api/v1/flows \ --header 'Authorization: Bearer ' 200 { "data": [\ {\ "id": "",\ "created": "",\ "updated": "",\ "projectId": "",\ "externalId": "",\ "status": "ENABLED",\ "operationStatus": "NONE",\ "version": {\ "id": "",\ "created": "",\ "updated": "",\ "flowId": "",\ "displayName": "",\ "trigger": {\ "name": "",\ "valid": true,\ "displayName": "",\ "type": "PIECE_TRIGGER",\ "settings": {\ "propertySettings": {},\ "pieceName": "",\ "pieceVersion": "",\ "input": {},\ "sampleData": {\ "sampleDataFileId": "",\ "sampleDataInputFileId": "",\ "lastTestDate": ""\ },\ "customLogoUrl": "",\ "triggerName": ""\ },\ "nextAction": ""\ },\ "valid": true,\ "agentIds": [\ ""\ ],\ "state": "LOCKED",\ "connectionIds": [\ ""\ ],\ "notes": [\ {\ "id": "",\ "content": "",\ "color": "orange",\ "position": {\ "x": 123,\ "y": 123\ },\ "size": {\ "width": 123,\ "height": 123\ },\ "createdAt": "",\ "updatedAt": "",\ "ownerId": ""\ }\ ],\ "updatedBy": "",\ "schemaVersion": "",\ "backupFiles": {}\ },\ "ownerId": "",\ "folderId": "",\ "publishedVersionId": "",\ "metadata": {},\ "timeSavedPerRun": 123,\ "templateId": "",\ "triggerSource": {\ "schedule": {\ "type": "CRON_EXPRESSION",\ "cronExpression": "",\ "timezone": ""\ }\ }\ }\ ], "next": "", "previous": "" } #### Authorizations [​](https://www.activepieces.com/docs/endpoints/flows/list#authorization-authorization) Authorization string header required Use your api key generated from the admin console #### Query Parameters [​](https://www.activepieces.com/docs/endpoints/flows/list#parameter-folder-id) folderId string [​](https://www.activepieces.com/docs/endpoints/flows/list#parameter-limit) limit number [​](https://www.activepieces.com/docs/endpoints/flows/list#parameter-cursor) cursor string [​](https://www.activepieces.com/docs/endpoints/flows/list#parameter-status) status enum\[\] Available options: `ENABLED` [​](https://www.activepieces.com/docs/endpoints/flows/list#parameter-project-id) projectId string required [​](https://www.activepieces.com/docs/endpoints/flows/list#parameter-name) name string [​](https://www.activepieces.com/docs/endpoints/flows/list#parameter-agent-external-ids) agentExternalIds string\[\] [​](https://www.activepieces.com/docs/endpoints/flows/list#parameter-one-of-0) versionState Option 1 · enumOption 2 · enumOption 1 · enumOption 2 · enum Available options: `LOCKED` [​](https://www.activepieces.com/docs/endpoints/flows/list#parameter-connection-external-ids) connectionExternalIds string\[\] [​](https://www.activepieces.com/docs/endpoints/flows/list#parameter-external-ids) externalIds string\[\] #### Response 200 - application/json Default Response [​](https://www.activepieces.com/docs/endpoints/flows/list#response-data) data object\[\] required Show child attributes [​](https://www.activepieces.com/docs/endpoints/flows/list#response-next-one-of-0) next string | null Cursor to the next page [​](https://www.activepieces.com/docs/endpoints/flows/list#response-previous-one-of-0) previous string | null Cursor to the previous page [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/flows/list.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/flows/list) [Get Flow](https://www.activepieces.com/docs/endpoints/flows/get) [Delete Flow](https://www.activepieces.com/docs/endpoints/flows/delete) ⌘I --- # Delete User - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/users/delete#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Users Delete User [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) cURL cURL curl --request DELETE \ --url https://cloud.activepieces.com/api/v1/users/{id} \ --header 'Authorization: Bearer ' DELETE / v1 / users / {id} Try it cURL cURL curl --request DELETE \ --url https://cloud.activepieces.com/api/v1/users/{id} \ --header 'Authorization: Bearer ' #### Authorizations [​](https://www.activepieces.com/docs/endpoints/users/delete#authorization-authorization) Authorization string header required Use your api key generated from the admin console #### Path Parameters [​](https://www.activepieces.com/docs/endpoints/users/delete#parameter-id) id string required Pattern: `^[0-9a-zA-Z]{21}$` #### Response 204 - application/json Default Response [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/users/delete.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/users/delete) [List Users](https://www.activepieces.com/docs/endpoints/users/list) [User Invitation Schema](https://www.activepieces.com/docs/endpoints/user-invitations/schema) ⌘I --- # Project Schema - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/projects/schema#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Projects Project Schema [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) Example { "id": "", "created": "", "updated": "", "ownerId": "", "displayName": "", "platformId": "", "type": "TEAM", "icon": { "color": "RED" }, "releasesEnabled": true, "plan": { "id": "", "created": "", "updated": "", "projectId": "", "locked": false, "name": "", "piecesFilterType": "NONE", "pieces": [\ ""\ ] }, "analytics": { "totalUsers": 123, "activeUsers": 123, "totalFlows": 123, "activeFlows": 123 }, "maxConcurrentJobs": 123, "externalId": "", "metadata": {} } [​](https://www.activepieces.com/docs/endpoints/projects/schema#schema-id) id string required [​](https://www.activepieces.com/docs/endpoints/projects/schema#schema-created) created string required [​](https://www.activepieces.com/docs/endpoints/projects/schema#schema-updated) updated string required [​](https://www.activepieces.com/docs/endpoints/projects/schema#schema-owner-id) ownerId string required [​](https://www.activepieces.com/docs/endpoints/projects/schema#schema-display-name) displayName string required [​](https://www.activepieces.com/docs/endpoints/projects/schema#schema-platform-id) platformId string required Pattern: `^[0-9a-zA-Z]{21}$` [​](https://www.activepieces.com/docs/endpoints/projects/schema#schema-type-one-of-0) type Option 1 · enumOption 2 · enumOption 1 · enumOption 2 · enum required Available options: `TEAM` [​](https://www.activepieces.com/docs/endpoints/projects/schema#schema-icon) icon object required Show child attributes [​](https://www.activepieces.com/docs/endpoints/projects/schema#schema-releases-enabled) releasesEnabled boolean required [​](https://www.activepieces.com/docs/endpoints/projects/schema#schema-plan) plan object required Show child attributes [​](https://www.activepieces.com/docs/endpoints/projects/schema#schema-analytics) analytics object required Show child attributes [​](https://www.activepieces.com/docs/endpoints/projects/schema#schema-max-concurrent-jobs-one-of-0) maxConcurrentJobs number | null [​](https://www.activepieces.com/docs/endpoints/projects/schema#schema-external-id) externalId string [​](https://www.activepieces.com/docs/endpoints/projects/schema#schema-metadata-one-of-0) metadata object Show child attributes [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/projects/schema.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/projects/schema) [Overview](https://www.activepieces.com/docs/endpoints/overview) [Create Project](https://www.activepieces.com/docs/endpoints/projects/create) ⌘I --- # Create Template - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/templates/create#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Templates Create Template [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) cURL cURL curl --request POST \ --url https://cloud.activepieces.com/api/v1/templates \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "name": "", "summary": "", "description": "", "author": "", "categories": [\ ""\ ], "type": "OFFICIAL", "tags": [\ {\ "title": "",\ "color": "",\ "icon": ""\ }\ ], "blogUrl": "", "metadata": {}, "flows": [\ {\ "displayName": "",\ "trigger": {\ "name": "",\ "valid": true,\ "displayName": "",\ "type": "PIECE_TRIGGER",\ "settings": {\ "propertySettings": {},\ "pieceName": "",\ "pieceVersion": "",\ "input": {},\ "sampleData": {\ "sampleDataFileId": "",\ "sampleDataInputFileId": "",\ "lastTestDate": ""\ },\ "customLogoUrl": "",\ "triggerName": ""\ },\ "nextAction": ""\ },\ "valid": true,\ "schemaVersion": "",\ "description": "",\ "notes": [\ {\ "id": "",\ "content": "",\ "color": "orange",\ "position": {\ "x": 123,\ "y": 123\ },\ "size": {\ "width": 123,\ "height": 123\ },\ "createdAt": "",\ "updatedAt": "",\ "ownerId": ""\ }\ ]\ }\ ] } ' POST / v1 / templates Try it cURL cURL curl --request POST \ --url https://cloud.activepieces.com/api/v1/templates \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "name": "", "summary": "", "description": "", "author": "", "categories": [\ ""\ ], "type": "OFFICIAL", "tags": [\ {\ "title": "",\ "color": "",\ "icon": ""\ }\ ], "blogUrl": "", "metadata": {}, "flows": [\ {\ "displayName": "",\ "trigger": {\ "name": "",\ "valid": true,\ "displayName": "",\ "type": "PIECE_TRIGGER",\ "settings": {\ "propertySettings": {},\ "pieceName": "",\ "pieceVersion": "",\ "input": {},\ "sampleData": {\ "sampleDataFileId": "",\ "sampleDataInputFileId": "",\ "lastTestDate": ""\ },\ "customLogoUrl": "",\ "triggerName": ""\ },\ "nextAction": ""\ },\ "valid": true,\ "schemaVersion": "",\ "description": "",\ "notes": [\ {\ "id": "",\ "content": "",\ "color": "orange",\ "position": {\ "x": 123,\ "y": 123\ },\ "size": {\ "width": 123,\ "height": 123\ },\ "createdAt": "",\ "updatedAt": "",\ "ownerId": ""\ }\ ]\ }\ ] } ' #### Authorizations [​](https://www.activepieces.com/docs/endpoints/templates/create#authorization-authorization) Authorization string header required Use your api key generated from the admin console #### Body application/json [​](https://www.activepieces.com/docs/endpoints/templates/create#body-name) name string required [​](https://www.activepieces.com/docs/endpoints/templates/create#body-summary) summary string required [​](https://www.activepieces.com/docs/endpoints/templates/create#body-description) description string required [​](https://www.activepieces.com/docs/endpoints/templates/create#body-author) author string required [​](https://www.activepieces.com/docs/endpoints/templates/create#body-categories) categories string\[\] required [​](https://www.activepieces.com/docs/endpoints/templates/create#body-type-one-of-0) type Option 1 · enumOption 2 · enumOption 3 · enumOption 1 · enumOption 2 · enumOption 3 · enum required Available options: `OFFICIAL` [​](https://www.activepieces.com/docs/endpoints/templates/create#body-tags) tags object\[\] Show child attributes [​](https://www.activepieces.com/docs/endpoints/templates/create#body-blog-url) blogUrl string [​](https://www.activepieces.com/docs/endpoints/templates/create#body-metadata-one-of-0) metadata object Show child attributes [​](https://www.activepieces.com/docs/endpoints/templates/create#body-flows) flows object\[\] Show child attributes #### Response 200 Default Response [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/templates/create.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/templates/create) [Template Schema](https://www.activepieces.com/docs/endpoints/templates/schema) [Delete Template](https://www.activepieces.com/docs/endpoints/templates/delete) ⌘I --- # Flow Updated - Activepieces [Skip to main content](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-updated#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Audit Logs Flow Updated [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) Example { "id": "", "created": "", "updated": "", "platformId": "", "action": "flow.updated", "data": { "flowVersion": { "id": "", "displayName": "", "flowId": "", "created": "", "updated": "" }, "request": { "type": "MOVE_ACTION", "request": { "name": "", "newParentStep": "", "stepLocationRelativeToNewParent": "AFTER", "branchIndex": 123 } } }, "projectId": "", "projectDisplayName": "", "userId": "", "userEmail": "", "ip": "" } [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-updated#schema-id) id string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-updated#schema-created) created string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-updated#schema-updated) updated string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-updated#schema-platform-id) platformId string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-updated#schema-action) action enum required Available options: `flow.updated` [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-updated#schema-data) data object required Show child attributes [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-updated#schema-project-id) projectId string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-updated#schema-project-display-name) projectDisplayName string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-updated#schema-user-id) userId string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-updated#schema-user-email) userEmail string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-updated#schema-ip) ip string [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/admin-guide/security/audit-logs/flow-updated.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/admin-guide/security/audit-logs/flow-updated) [Flow Created](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-created) [Flow Deleted](https://www.activepieces.com/docs/admin-guide/security/audit-logs/flow-deleted) ⌘I --- # User Signed In - Activepieces [Skip to main content](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-signed-in#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Audit Logs User Signed In [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) Example { "id": "", "created": "", "updated": "", "platformId": "", "action": "user.signed.in", "data": {}, "projectId": "", "projectDisplayName": "", "userId": "", "userEmail": "", "ip": "" } [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-signed-in#schema-id) id string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-signed-in#schema-created) created string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-signed-in#schema-updated) updated string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-signed-in#schema-platform-id) platformId string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-signed-in#schema-action-one-of-0) action Option 1 · enumOption 2 · enumOption 3 · enumOption 1 · enumOption 2 · enumOption 3 · enum required Available options: `user.signed.in` [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-signed-in#schema-data) data object required Show child attributes [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-signed-in#schema-project-id) projectId string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-signed-in#schema-project-display-name) projectDisplayName string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-signed-in#schema-user-id) userId string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-signed-in#schema-user-email) userEmail string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-signed-in#schema-ip) ip string [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/admin-guide/security/audit-logs/user-signed-in.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/admin-guide/security/audit-logs/user-signed-in) [Folder Deleted](https://www.activepieces.com/docs/admin-guide/security/audit-logs/folder-deleted) [User Signed Up](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-signed-up) ⌘I --- # Debugging Runs - Activepieces [Skip to main content](https://www.activepieces.com/docs/flows/debugging-runs#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Flows Debugging Runs [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) You can monitor each run that results from an enabled flow: 1. Go to the Dashboard, click on **Runs**. 2. Find the run that you’re looking for, and click on it. 3. You will see the builder in a view-only mode, each step will show a ✅ or a ❌ to indicate its execution status. 4. Click on any of these steps, you will see the **input** and **output** in the **Run Details** panel. The debugging experience looks like this: ![Debugging Business Automations](https://mintcdn.com/activepieces/uHZ35vXyxX7goNO-/resources/screenshots/using-activepieces-debugging.png?w=2500&fit=max&auto=format&n=uHZ35vXyxX7goNO-&q=85&s=10c28d9178fdca26e71567b0278dff3d) [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/flows/debugging-runs.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/flows/debugging-runs) [Publishing Flows](https://www.activepieces.com/docs/flows/publishing-flows) [Version History](https://www.activepieces.com/docs/flows/versioning) ⌘I --- # Update Folder - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/folders/update#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Folders Update Folder [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) cURL cURL curl --request POST \ --url https://cloud.activepieces.com/api/v1/folders/{id} \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "displayName": "" } ' POST / v1 / folders / {id} Try it cURL cURL curl --request POST \ --url https://cloud.activepieces.com/api/v1/folders/{id} \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "displayName": "" } ' #### Authorizations [​](https://www.activepieces.com/docs/endpoints/folders/update#authorization-authorization) Authorization string header required Use your api key generated from the admin console #### Path Parameters [​](https://www.activepieces.com/docs/endpoints/folders/update#parameter-id) id string required #### Body application/json [​](https://www.activepieces.com/docs/endpoints/folders/update#body-display-name) displayName string required #### Response 200 Default Response [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/folders/update.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/folders/update) [Create Folder](https://www.activepieces.com/docs/endpoints/folders/create) [Get Folder](https://www.activepieces.com/docs/endpoints/folders/get) ⌘I --- # User Schema - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/users/schema#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Users User Schema [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) Example { "id": "", "email": "", "firstName": "", "status": "ACTIVE", "platformRole": "ADMIN", "lastName": "", "created": "", "updated": "", "externalId": "", "platformId": "", "lastActiveDate": "", "imageUrl": "" } [​](https://www.activepieces.com/docs/endpoints/users/schema#schema-id) id string required [​](https://www.activepieces.com/docs/endpoints/users/schema#schema-email) email string required [​](https://www.activepieces.com/docs/endpoints/users/schema#schema-first-name) firstName string required [​](https://www.activepieces.com/docs/endpoints/users/schema#schema-status-one-of-0) status Option 1 · enumOption 2 · enumOption 1 · enumOption 2 · enum required Available options: `ACTIVE` [​](https://www.activepieces.com/docs/endpoints/users/schema#schema-platform-role-one-of-0) platformRole Option 1 · enumOption 2 · enumOption 3 · enumOption 1 · enumOption 2 · enumOption 3 · enum required Available options: `ADMIN` [​](https://www.activepieces.com/docs/endpoints/users/schema#schema-last-name) lastName string required [​](https://www.activepieces.com/docs/endpoints/users/schema#schema-created) created string required [​](https://www.activepieces.com/docs/endpoints/users/schema#schema-updated) updated string required [​](https://www.activepieces.com/docs/endpoints/users/schema#schema-external-id-one-of-0) externalId string | null [​](https://www.activepieces.com/docs/endpoints/users/schema#schema-platform-id-one-of-0) platformId string | null [​](https://www.activepieces.com/docs/endpoints/users/schema#schema-last-active-date-one-of-0) lastActiveDate string | null [​](https://www.activepieces.com/docs/endpoints/users/schema#schema-image-url-one-of-0) imageUrl string | null [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/users/schema.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/users/schema) [Delete Project](https://www.activepieces.com/docs/endpoints/projects/delete) [Update User](https://www.activepieces.com/docs/endpoints/users/update) ⌘I --- # List Users - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/users/list#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Users List Users [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) cURL cURL curl --request GET \ --url https://cloud.activepieces.com/api/v1/users \ --header 'Authorization: Bearer ' 200 { "data": [\ {\ "id": "",\ "email": "",\ "firstName": "",\ "status": "ACTIVE",\ "platformRole": "ADMIN",\ "lastName": "",\ "created": "",\ "updated": "",\ "externalId": "",\ "platformId": "",\ "lastActiveDate": "",\ "imageUrl": ""\ }\ ], "next": "", "previous": "" } GET / v1 / users Try it cURL cURL curl --request GET \ --url https://cloud.activepieces.com/api/v1/users \ --header 'Authorization: Bearer ' 200 { "data": [\ {\ "id": "",\ "email": "",\ "firstName": "",\ "status": "ACTIVE",\ "platformRole": "ADMIN",\ "lastName": "",\ "created": "",\ "updated": "",\ "externalId": "",\ "platformId": "",\ "lastActiveDate": "",\ "imageUrl": ""\ }\ ], "next": "", "previous": "" } #### Authorizations [​](https://www.activepieces.com/docs/endpoints/users/list#authorization-authorization) Authorization string header required Use your api key generated from the admin console #### Query Parameters [​](https://www.activepieces.com/docs/endpoints/users/list#parameter-cursor) cursor string [​](https://www.activepieces.com/docs/endpoints/users/list#parameter-limit) limit number [​](https://www.activepieces.com/docs/endpoints/users/list#parameter-external-id) externalId string #### Response 200 - application/json Default Response [​](https://www.activepieces.com/docs/endpoints/users/list#response-data) data object\[\] required Show child attributes [​](https://www.activepieces.com/docs/endpoints/users/list#response-next-one-of-0) next string | null Cursor to the next page [​](https://www.activepieces.com/docs/endpoints/users/list#response-previous-one-of-0) previous string | null Cursor to the previous page [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/users/list.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/users/list) [Update User](https://www.activepieces.com/docs/endpoints/users/update) [Delete User](https://www.activepieces.com/docs/endpoints/users/delete) ⌘I --- # Create Project - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/projects/create#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Projects Create Project [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) cURL cURL curl --request POST \ --url https://cloud.activepieces.com/api/v1/projects \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "displayName": "", "externalId": "", "metadata": {}, "maxConcurrentJobs": 123 } ' 201 { "id": "", "created": "", "updated": "", "ownerId": "", "displayName": "", "platformId": "", "type": "TEAM", "icon": { "color": "RED" }, "releasesEnabled": true, "plan": { "id": "", "created": "", "updated": "", "projectId": "", "locked": false, "name": "", "piecesFilterType": "NONE", "pieces": [\ ""\ ] }, "analytics": { "totalUsers": 123, "activeUsers": 123, "totalFlows": 123, "activeFlows": 123 }, "maxConcurrentJobs": 123, "externalId": "", "metadata": {} } POST / v1 / projects Try it cURL cURL curl --request POST \ --url https://cloud.activepieces.com/api/v1/projects \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "displayName": "", "externalId": "", "metadata": {}, "maxConcurrentJobs": 123 } ' 201 { "id": "", "created": "", "updated": "", "ownerId": "", "displayName": "", "platformId": "", "type": "TEAM", "icon": { "color": "RED" }, "releasesEnabled": true, "plan": { "id": "", "created": "", "updated": "", "projectId": "", "locked": false, "name": "", "piecesFilterType": "NONE", "pieces": [\ ""\ ] }, "analytics": { "totalUsers": 123, "activeUsers": 123, "totalFlows": 123, "activeFlows": 123 }, "maxConcurrentJobs": 123, "externalId": "", "metadata": {} } #### Authorizations [​](https://www.activepieces.com/docs/endpoints/projects/create#authorization-authorization) Authorization string header required Use your api key generated from the admin console #### Body application/json [​](https://www.activepieces.com/docs/endpoints/projects/create#body-display-name) displayName string required Pattern: `^[^./]+$` [​](https://www.activepieces.com/docs/endpoints/projects/create#body-external-id-one-of-0) externalId string | null [​](https://www.activepieces.com/docs/endpoints/projects/create#body-metadata-one-of-0) metadata object Show child attributes [​](https://www.activepieces.com/docs/endpoints/projects/create#body-max-concurrent-jobs-one-of-0) maxConcurrentJobs number | null #### Response 201 - application/json Default Response [​](https://www.activepieces.com/docs/endpoints/projects/create#response-id) id string required [​](https://www.activepieces.com/docs/endpoints/projects/create#response-created) created string required [​](https://www.activepieces.com/docs/endpoints/projects/create#response-updated) updated string required [​](https://www.activepieces.com/docs/endpoints/projects/create#response-owner-id) ownerId string required [​](https://www.activepieces.com/docs/endpoints/projects/create#response-display-name) displayName string required [​](https://www.activepieces.com/docs/endpoints/projects/create#response-platform-id) platformId string required Pattern: `^[0-9a-zA-Z]{21}$` [​](https://www.activepieces.com/docs/endpoints/projects/create#response-type-one-of-0) type Option 1 · enumOption 2 · enumOption 1 · enumOption 2 · enum required Available options: `TEAM` [​](https://www.activepieces.com/docs/endpoints/projects/create#response-icon) icon object required Show child attributes [​](https://www.activepieces.com/docs/endpoints/projects/create#response-releases-enabled) releasesEnabled boolean required [​](https://www.activepieces.com/docs/endpoints/projects/create#response-plan) plan object required Show child attributes [​](https://www.activepieces.com/docs/endpoints/projects/create#response-analytics) analytics object required Show child attributes [​](https://www.activepieces.com/docs/endpoints/projects/create#response-max-concurrent-jobs-one-of-0) maxConcurrentJobs number | null [​](https://www.activepieces.com/docs/endpoints/projects/create#response-external-id) externalId string [​](https://www.activepieces.com/docs/endpoints/projects/create#response-metadata-one-of-0) metadata object Show child attributes [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/projects/create.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/projects/create) [Project Schema](https://www.activepieces.com/docs/endpoints/projects/schema) [Update Project](https://www.activepieces.com/docs/endpoints/projects/update) ⌘I --- # Send User Invitation (Upsert) - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/user-invitations/upsert#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation User Invitations Send User Invitation (Upsert) [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) cURL cURL curl --request POST \ --url https://cloud.activepieces.com/api/v1/user-invitations \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "type": "PROJECT", "email": "", "projectId": "", "projectRole": "" } ' 201 { "id": "", "created": "", "updated": "", "email": "", "status": "PENDING", "type": "PLATFORM", "platformId": "", "platformRole": "ADMIN", "projectId": "", "projectRoleId": "", "projectRole": { "id": "", "created": "", "updated": "", "name": "", "permissions": [\ ""\ ], "type": "", "platformId": "", "userCount": 123 }, "link": "" } POST / v1 / user-invitations Try it cURL cURL curl --request POST \ --url https://cloud.activepieces.com/api/v1/user-invitations \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "type": "PROJECT", "email": "", "projectId": "", "projectRole": "" } ' 201 { "id": "", "created": "", "updated": "", "email": "", "status": "PENDING", "type": "PLATFORM", "platformId": "", "platformRole": "ADMIN", "projectId": "", "projectRoleId": "", "projectRole": { "id": "", "created": "", "updated": "", "name": "", "permissions": [\ ""\ ], "type": "", "platformId": "", "userCount": 123 }, "link": "" } #### Authorizations [​](https://www.activepieces.com/docs/endpoints/user-invitations/upsert#authorization-authorization) Authorization string header required Use your api key generated from the admin console #### Body application/json * Option 1 * Option 2 [​](https://www.activepieces.com/docs/endpoints/user-invitations/upsert#body-one-of-0-type) type enum required Available options: `PROJECT` [​](https://www.activepieces.com/docs/endpoints/user-invitations/upsert#body-one-of-0-email) email string required [​](https://www.activepieces.com/docs/endpoints/user-invitations/upsert#body-one-of-0-project-id) projectId string required [​](https://www.activepieces.com/docs/endpoints/user-invitations/upsert#body-one-of-0-project-role) projectRole string required #### Response 201 - application/json Default Response [​](https://www.activepieces.com/docs/endpoints/user-invitations/upsert#response-id) id string required [​](https://www.activepieces.com/docs/endpoints/user-invitations/upsert#response-created) created string required [​](https://www.activepieces.com/docs/endpoints/user-invitations/upsert#response-updated) updated string required [​](https://www.activepieces.com/docs/endpoints/user-invitations/upsert#response-email) email string required [​](https://www.activepieces.com/docs/endpoints/user-invitations/upsert#response-status-one-of-0) status Option 1 · enumOption 2 · enumOption 1 · enumOption 2 · enum required Available options: `PENDING` [​](https://www.activepieces.com/docs/endpoints/user-invitations/upsert#response-type-one-of-0) type Option 1 · enumOption 2 · enumOption 1 · enumOption 2 · enum required Available options: `PLATFORM` [​](https://www.activepieces.com/docs/endpoints/user-invitations/upsert#response-platform-id) platformId string required [​](https://www.activepieces.com/docs/endpoints/user-invitations/upsert#response-platform-role-one-of-0) platformRole enum | null Available options: `ADMIN`, `MEMBER`, `OPERATOR` [​](https://www.activepieces.com/docs/endpoints/user-invitations/upsert#response-project-id-one-of-0) projectId string | null [​](https://www.activepieces.com/docs/endpoints/user-invitations/upsert#response-project-role-id-one-of-0) projectRoleId string | null [​](https://www.activepieces.com/docs/endpoints/user-invitations/upsert#response-project-role-one-of-0) projectRole object Show child attributes [​](https://www.activepieces.com/docs/endpoints/user-invitations/upsert#response-link) link string [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/user-invitations/upsert.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/user-invitations/upsert) [User Invitation Schema](https://www.activepieces.com/docs/endpoints/user-invitations/schema) [List User Invitations](https://www.activepieces.com/docs/endpoints/user-invitations/list) ⌘I --- # Update User - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/users/update#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Users Update User [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) cURL cURL curl --request POST \ --url https://cloud.activepieces.com/api/v1/users/{id} \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "status": "ACTIVE", "platformRole": "ADMIN", "externalId": "" } ' 200 { "id": "", "email": "", "firstName": "", "status": "ACTIVE", "platformRole": "ADMIN", "lastName": "", "created": "", "updated": "", "externalId": "", "platformId": "", "lastActiveDate": "", "imageUrl": "" } POST / v1 / users / {id} Try it cURL cURL curl --request POST \ --url https://cloud.activepieces.com/api/v1/users/{id} \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "status": "ACTIVE", "platformRole": "ADMIN", "externalId": "" } ' 200 { "id": "", "email": "", "firstName": "", "status": "ACTIVE", "platformRole": "ADMIN", "lastName": "", "created": "", "updated": "", "externalId": "", "platformId": "", "lastActiveDate": "", "imageUrl": "" } #### Authorizations [​](https://www.activepieces.com/docs/endpoints/users/update#authorization-authorization) Authorization string header required Use your api key generated from the admin console #### Path Parameters [​](https://www.activepieces.com/docs/endpoints/users/update#parameter-id) id string required Pattern: `^[0-9a-zA-Z]{21}$` #### Body application/json [​](https://www.activepieces.com/docs/endpoints/users/update#body-status-one-of-0) status Option 1 · enumOption 2 · enumOption 1 · enumOption 2 · enum Available options: `ACTIVE` [​](https://www.activepieces.com/docs/endpoints/users/update#body-platform-role-one-of-0) platformRole Option 1 · enumOption 2 · enumOption 3 · enumOption 1 · enumOption 2 · enumOption 3 · enum Available options: `ADMIN` [​](https://www.activepieces.com/docs/endpoints/users/update#body-external-id) externalId string #### Response 200 - application/json Default Response [​](https://www.activepieces.com/docs/endpoints/users/update#response-id) id string required [​](https://www.activepieces.com/docs/endpoints/users/update#response-email) email string required [​](https://www.activepieces.com/docs/endpoints/users/update#response-first-name) firstName string required [​](https://www.activepieces.com/docs/endpoints/users/update#response-status-one-of-0) status Option 1 · enumOption 2 · enumOption 1 · enumOption 2 · enum required Available options: `ACTIVE` [​](https://www.activepieces.com/docs/endpoints/users/update#response-platform-role-one-of-0) platformRole Option 1 · enumOption 2 · enumOption 3 · enumOption 1 · enumOption 2 · enumOption 3 · enum required Available options: `ADMIN` [​](https://www.activepieces.com/docs/endpoints/users/update#response-last-name) lastName string required [​](https://www.activepieces.com/docs/endpoints/users/update#response-created) created string required [​](https://www.activepieces.com/docs/endpoints/users/update#response-updated) updated string required [​](https://www.activepieces.com/docs/endpoints/users/update#response-external-id-one-of-0) externalId string | null [​](https://www.activepieces.com/docs/endpoints/users/update#response-platform-id-one-of-0) platformId string | null [​](https://www.activepieces.com/docs/endpoints/users/update#response-last-active-date-one-of-0) lastActiveDate string | null [​](https://www.activepieces.com/docs/endpoints/users/update#response-image-url-one-of-0) imageUrl string | null [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/users/update.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/users/update) [User Schema](https://www.activepieces.com/docs/endpoints/users/schema) [List Users](https://www.activepieces.com/docs/endpoints/users/list) ⌘I --- # List User Invitations - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/user-invitations/list#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation User Invitations List User Invitations [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) cURL cURL curl --request GET \ --url https://cloud.activepieces.com/api/v1/user-invitations \ --header 'Authorization: Bearer ' 200 { "data": [\ {\ "id": "",\ "created": "",\ "updated": "",\ "email": "",\ "status": "PENDING",\ "type": "PLATFORM",\ "platformId": "",\ "platformRole": "ADMIN",\ "projectId": "",\ "projectRoleId": "",\ "projectRole": {\ "id": "",\ "created": "",\ "updated": "",\ "name": "",\ "permissions": [\ ""\ ],\ "type": "",\ "platformId": "",\ "userCount": 123\ }\ }\ ], "next": "", "previous": "" } GET / v1 / user-invitations Try it cURL cURL curl --request GET \ --url https://cloud.activepieces.com/api/v1/user-invitations \ --header 'Authorization: Bearer ' 200 { "data": [\ {\ "id": "",\ "created": "",\ "updated": "",\ "email": "",\ "status": "PENDING",\ "type": "PLATFORM",\ "platformId": "",\ "platformRole": "ADMIN",\ "projectId": "",\ "projectRoleId": "",\ "projectRole": {\ "id": "",\ "created": "",\ "updated": "",\ "name": "",\ "permissions": [\ ""\ ],\ "type": "",\ "platformId": "",\ "userCount": 123\ }\ }\ ], "next": "", "previous": "" } #### Authorizations [​](https://www.activepieces.com/docs/endpoints/user-invitations/list#authorization-authorization) Authorization string header required Use your api key generated from the admin console #### Query Parameters [​](https://www.activepieces.com/docs/endpoints/user-invitations/list#parameter-limit) limit number [​](https://www.activepieces.com/docs/endpoints/user-invitations/list#parameter-cursor) cursor string [​](https://www.activepieces.com/docs/endpoints/user-invitations/list#parameter-one-of-0) type Option 1 · enumOption 2 · enumOption 1 · enumOption 2 · enum required Available options: `PLATFORM` [​](https://www.activepieces.com/docs/endpoints/user-invitations/list#parameter-one-of-0) projectId string | null [​](https://www.activepieces.com/docs/endpoints/user-invitations/list#parameter-one-of-0) status Option 1 · enumOption 2 · enumOption 1 · enumOption 2 · enum Available options: `PENDING` #### Response 200 - application/json Default Response [​](https://www.activepieces.com/docs/endpoints/user-invitations/list#response-data) data object\[\] required Show child attributes [​](https://www.activepieces.com/docs/endpoints/user-invitations/list#response-next-one-of-0) next string | null Cursor to the next page [​](https://www.activepieces.com/docs/endpoints/user-invitations/list#response-previous-one-of-0) previous string | null Cursor to the previous page [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/user-invitations/list.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/user-invitations/list) [Send User Invitation (Upsert)](https://www.activepieces.com/docs/endpoints/user-invitations/upsert) [Delete User Invitation](https://www.activepieces.com/docs/endpoints/user-invitations/delete) ⌘I --- # List Global Connections - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/global-connections/list#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Global Connections List Global Connections [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) cURL cURL curl --request GET \ --url https://cloud.activepieces.com/api/v1/global-connections \ --header 'Authorization: Bearer ' 200 { "data": [\ {\ "id": "",\ "created": "",\ "updated": "",\ "externalId": "",\ "displayName": "",\ "type": "OAUTH2",\ "pieceName": "",\ "projectIds": [\ ""\ ],\ "scope": "PROJECT",\ "status": "ACTIVE",\ "pieceVersion": "",\ "platformId": "",\ "ownerId": "",\ "owner": {\ "id": "",\ "email": "",\ "firstName": "",\ "status": "ACTIVE",\ "platformRole": "ADMIN",\ "lastName": "",\ "created": "",\ "updated": "",\ "externalId": "",\ "platformId": "",\ "lastActiveDate": "",\ "imageUrl": ""\ },\ "metadata": {},\ "flowIds": [\ ""\ ]\ }\ ], "next": "", "previous": "" } GET / v1 / global-connections Try it cURL cURL curl --request GET \ --url https://cloud.activepieces.com/api/v1/global-connections \ --header 'Authorization: Bearer ' 200 { "data": [\ {\ "id": "",\ "created": "",\ "updated": "",\ "externalId": "",\ "displayName": "",\ "type": "OAUTH2",\ "pieceName": "",\ "projectIds": [\ ""\ ],\ "scope": "PROJECT",\ "status": "ACTIVE",\ "pieceVersion": "",\ "platformId": "",\ "ownerId": "",\ "owner": {\ "id": "",\ "email": "",\ "firstName": "",\ "status": "ACTIVE",\ "platformRole": "ADMIN",\ "lastName": "",\ "created": "",\ "updated": "",\ "externalId": "",\ "platformId": "",\ "lastActiveDate": "",\ "imageUrl": ""\ },\ "metadata": {},\ "flowIds": [\ ""\ ]\ }\ ], "next": "", "previous": "" } #### Authorizations [​](https://www.activepieces.com/docs/endpoints/global-connections/list#authorization-authorization) Authorization string header required Use your api key generated from the admin console #### Query Parameters [​](https://www.activepieces.com/docs/endpoints/global-connections/list#parameter-cursor) cursor string [​](https://www.activepieces.com/docs/endpoints/global-connections/list#parameter-one-of-0) scope Option 1 · enumOption 2 · enumOption 1 · enumOption 2 · enum Available options: `PROJECT` [​](https://www.activepieces.com/docs/endpoints/global-connections/list#parameter-piece-name) pieceName string [​](https://www.activepieces.com/docs/endpoints/global-connections/list#parameter-display-name) displayName string [​](https://www.activepieces.com/docs/endpoints/global-connections/list#parameter-status) status enum\[\] Available options: `ACTIVE` [​](https://www.activepieces.com/docs/endpoints/global-connections/list#parameter-limit) limit number #### Response 200 - application/json Default Response [​](https://www.activepieces.com/docs/endpoints/global-connections/list#response-data) data object\[\] required Show child attributes [​](https://www.activepieces.com/docs/endpoints/global-connections/list#response-next-one-of-0) next string | null Cursor to the next page [​](https://www.activepieces.com/docs/endpoints/global-connections/list#response-previous-one-of-0) previous string | null Cursor to the previous page [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/global-connections/list.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/global-connections/list) [Update Global Connection](https://www.activepieces.com/docs/endpoints/global-connections/update) [Delete Global Connection](https://www.activepieces.com/docs/endpoints/global-connections/delete) ⌘I --- # User Email Verified - Activepieces [Skip to main content](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-email-verified#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Audit Logs User Email Verified [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) Example { "id": "", "created": "", "updated": "", "platformId": "", "action": "user.signed.in", "data": {}, "projectId": "", "projectDisplayName": "", "userId": "", "userEmail": "", "ip": "" } [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-email-verified#schema-id) id string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-email-verified#schema-created) created string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-email-verified#schema-updated) updated string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-email-verified#schema-platform-id) platformId string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-email-verified#schema-action-one-of-0) action Option 1 · enumOption 2 · enumOption 3 · enumOption 1 · enumOption 2 · enumOption 3 · enum required Available options: `user.signed.in` [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-email-verified#schema-data) data object required Show child attributes [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-email-verified#schema-project-id) projectId string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-email-verified#schema-project-display-name) projectDisplayName string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-email-verified#schema-user-id) userId string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-email-verified#schema-user-email) userEmail string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-email-verified#schema-ip) ip string [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/admin-guide/security/audit-logs/user-email-verified.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/admin-guide/security/audit-logs/user-email-verified) [User Signed Up](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-signed-up) [User Password Reset](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-password-reset) ⌘I --- # Development setup - Activepieces [Skip to main content](https://www.activepieces.com/docs/build-pieces/building-pieces/development-setup#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Build a Piece Development setup [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Prerequisites](https://www.activepieces.com/docs/build-pieces/building-pieces/development-setup#prerequisites) * [Instructions](https://www.activepieces.com/docs/build-pieces/building-pieces/development-setup#instructions) * [Pieces Development](https://www.activepieces.com/docs/build-pieces/building-pieces/development-setup#pieces-development) [​](https://www.activepieces.com/docs/build-pieces/building-pieces/development-setup#prerequisites) Prerequisites -------------------------------------------------------------------------------------------------------------------- * Node.js v18+ * npm v9+ [​](https://www.activepieces.com/docs/build-pieces/building-pieces/development-setup#instructions) Instructions ------------------------------------------------------------------------------------------------------------------ 1. Setup the environment node tools/setup-dev.js 2. Start the environment This command will start activepieces with sqlite3 and in memory queue. npm start By default, the development setup only builds specific pieces.Open the file `.env.dev` and add comma-separated list of pieces to make available.For more details, check out the [Piece Development](https://www.activepieces.com/docs/build-pieces/building-pieces/development-setup#pieces-development) section. 3. Go to _**localhost:4200**_ on your web browser and sign in with these details: Email: `[[email protected]](https://www.activepieces.com/cdn-cgi/l/email-protection) ` Password: `12345678` [​](https://www.activepieces.com/docs/build-pieces/building-pieces/development-setup#pieces-development) Pieces Development ------------------------------------------------------------------------------------------------------------------------------ When [`AP_PIECES_SYNC_MODE`](https://github.com/activepieces/activepieces/blob/main/.env.dev#L14) is set to `OFFICIAL_AUTO`, all pieces are automatically loaded from the cloud API and synced to the database on first launch. This process may take a few seconds to several minutes depending on your internet connection. For local development, pieces are loaded from your local `dist` folder instead of the database. To enable this, set the [`AP_DEV_PIECES`](https://github.com/activepieces/activepieces/blob/main/.env.dev#L5) environment variable with a comma-separated list of pieces. For example, to develop with `google-sheets` and `cal-com`: AP_DEV_PIECES=google-sheets,cal-com npm start [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/build-pieces/building-pieces/development-setup.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/build-pieces/building-pieces/development-setup) [Fork Repository](https://www.activepieces.com/docs/build-pieces/building-pieces/setup-fork) [Create Piece Definition](https://www.activepieces.com/docs/build-pieces/building-pieces/piece-definition) ⌘I --- # Create Piece Definition - Activepieces [Skip to main content](https://www.activepieces.com/docs/build-pieces/building-pieces/piece-definition#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Build a Piece Create Piece Definition [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Piece Definition](https://www.activepieces.com/docs/build-pieces/building-pieces/piece-definition#piece-definition) This tutorial will guide you through the process of creating a Gelato piece with an action that fetches random icecream flavor and trigger that fetches new icecream flavor created. It assumes that you are familiar with the following: * [Activepieces Local development](https://www.activepieces.com/docs/build-pieces/building-pieces/development-setup) Or [GitHub Codespaces](https://www.activepieces.com/docs/build-pieces/misc/codespaces) . * TypeScript syntax. [​](https://www.activepieces.com/docs/build-pieces/building-pieces/piece-definition#piece-definition) Piece Definition ------------------------------------------------------------------------------------------------------------------------- To get started, let’s generate a new piece for Gelato npm run cli pieces create You will be asked three questions to define your new piece: 1. `Piece Name`: Specify a name for your piece. This name uniquely identifies your piece within the ActivePieces ecosystem. 2. `Package Name`: Optionally, you can enter a name for the npm package associated with your piece. If left blank, the default name will be used. 3. `Piece Type`: Choose the piece type based on your intention. It can be either “custom” if it’s a tailored solution for your needs, or “community” if it’s designed to be shared and used by the broader community. **Example:** npm run cli pieces create ? Enter the piece name: gelato ? Enter the package name: @activepieces/piece-gelato ? Select the piece type: community The piece will be generated at `packages/pieces/community/gelato/`, the `src/index.ts` file should contain the following code import { PieceAuth, createPiece } from '@activepieces/pieces-framework'; export const gelato = createPiece({ displayName: 'Gelato', logoUrl: 'https://cdn.activepieces.com/pieces/gelato.png', auth: PieceAuth.None(), authors: [], actions: [], triggers: [], }); [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/build-pieces/building-pieces/piece-definition.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/build-pieces/building-pieces/piece-definition) [Development setup](https://www.activepieces.com/docs/build-pieces/building-pieces/development-setup) [Add Piece Authentication](https://www.activepieces.com/docs/build-pieces/building-pieces/piece-authentication) ⌘I --- # Add Piece Authentication - Activepieces [Skip to main content](https://www.activepieces.com/docs/build-pieces/building-pieces/piece-authentication#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Build a Piece Add Piece Authentication [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Piece Authentication](https://www.activepieces.com/docs/build-pieces/building-pieces/piece-authentication#piece-authentication) ### [​](https://www.activepieces.com/docs/build-pieces/building-pieces/piece-authentication#piece-authentication) Piece Authentication Activepieces supports multiple forms of authentication, you can check those forms [here](https://www.activepieces.com/docs/build-pieces/piece-reference/authentication) Now, let’s establish authentication for this piece, which necessitates the inclusion of an API Key in the headers. Modify `src/index.ts` file to add authentication, import { PieceAuth, createPiece } from '@activepieces/pieces-framework'; export const gelatoAuth = PieceAuth.SecretText({ displayName: 'API Key', required: true, description: 'Please use **test-key** as value for API Key', }); export const gelato = createPiece({ displayName: 'Gelato', logoUrl: 'https://cdn.activepieces.com/pieces/gelato.png', auth: gelatoAuth, authors: [], actions: [], triggers: [], }); Use the value **test-key** as the API key when testing actions or triggers for Gelato. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/build-pieces/building-pieces/piece-authentication.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/build-pieces/building-pieces/piece-authentication) [Create Piece Definition](https://www.activepieces.com/docs/build-pieces/building-pieces/piece-definition) [Create Action](https://www.activepieces.com/docs/build-pieces/building-pieces/create-action) ⌘I --- # User Password Reset - Activepieces [Skip to main content](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-password-reset#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Audit Logs User Password Reset [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) Example { "id": "", "created": "", "updated": "", "platformId": "", "action": "user.signed.in", "data": {}, "projectId": "", "projectDisplayName": "", "userId": "", "userEmail": "", "ip": "" } [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-password-reset#schema-id) id string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-password-reset#schema-created) created string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-password-reset#schema-updated) updated string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-password-reset#schema-platform-id) platformId string required [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-password-reset#schema-action-one-of-0) action Option 1 · enumOption 2 · enumOption 3 · enumOption 1 · enumOption 2 · enumOption 3 · enum required Available options: `user.signed.in` [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-password-reset#schema-data) data object required Show child attributes [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-password-reset#schema-project-id) projectId string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-password-reset#schema-project-display-name) projectDisplayName string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-password-reset#schema-user-id) userId string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-password-reset#schema-user-email) userEmail string [​](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-password-reset#schema-ip) ip string [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/admin-guide/security/audit-logs/user-password-reset.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/admin-guide/security/audit-logs/user-password-reset) [User Email Verified](https://www.activepieces.com/docs/admin-guide/security/audit-logs/user-email-verified) [Signing Key Created](https://www.activepieces.com/docs/admin-guide/security/audit-logs/signing-key-created) ⌘I --- # GitHub Codespaces - Activepieces [Skip to main content](https://www.activepieces.com/docs/build-pieces/misc/codespaces#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Misc GitHub Codespaces [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Steps to setup Codespaces](https://www.activepieces.com/docs/build-pieces/misc/codespaces#steps-to-setup-codespaces) GitHub Codespaces is a cloud development platform that enables developers to write, run, and debug code directly in their browsers, seamlessly integrated with GitHub. ### [​](https://www.activepieces.com/docs/build-pieces/misc/codespaces#steps-to-setup-codespaces) Steps to setup Codespaces 1. Go to [Activepieces repo](https://github.com/activepieces/activepieces) . 2. Click Code `<>`, then under codespaces click create codespace on main. ![Create Codespace](https://mintcdn.com/activepieces/ki8mFooo8mAmhMdP/resources/screenshots/development-setup_codespaces.png?w=2500&fit=max&auto=format&n=ki8mFooo8mAmhMdP&q=85&s=092a5f882369bd1b2ce25b92487d179d) By default, the development setup only builds specific pieces.Open the file `.env.dev` and add comma-separated list of pieces to make available.For more details, check out the [Piece Development](https://www.activepieces.com/docs/build-pieces/building-pieces/development-setup#pieces-development) section. 3. Open the terminal and run `npm start` 4. Access the frontend URL by opening port 4200 and signing in with these details: Email: `[[email protected]](https://www.activepieces.com/cdn-cgi/l/email-protection) ` Password: `12345678` [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/build-pieces/misc/codespaces.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/build-pieces/misc/codespaces) [Dev Containers](https://www.activepieces.com/docs/build-pieces/misc/dev-container) ⌘I --- # Start Building - Activepieces [Skip to main content](https://www.activepieces.com/docs/build-pieces/building-pieces/start-building#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Build a Piece Start Building [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Steps Overview](https://www.activepieces.com/docs/build-pieces/building-pieces/start-building#steps-overview) This section guides you in creating a Gelato piece, from setting up your development environment to contributing the piece. By the end of this tutorial, you will have a piece with an action that fetches a random ice cream flavor and a trigger that fetches newly created ice cream flavors. These are the next sections. In each step, we will do one small thing. This tutorial should take around 30 minutes. [​](https://www.activepieces.com/docs/build-pieces/building-pieces/start-building#steps-overview) Steps Overview ------------------------------------------------------------------------------------------------------------------- [](https://www.activepieces.com/docs/build-pieces/building-pieces/start-building#) Fork Repository Fork the repository to create your own copy of the codebase. [](https://www.activepieces.com/docs/build-pieces/building-pieces/start-building#) Setup Development Environment Set up your development environment with the necessary tools and dependencies. [](https://www.activepieces.com/docs/build-pieces/building-pieces/start-building#) Create Piece Definition Define the structure and behavior of your Gelato piece. [](https://www.activepieces.com/docs/build-pieces/building-pieces/start-building#) Add Piece Authentication Implement authentication mechanisms for your Gelato piece. [](https://www.activepieces.com/docs/build-pieces/building-pieces/start-building#) Create Action Create an action that fetches a random ice cream flavor. [](https://www.activepieces.com/docs/build-pieces/building-pieces/start-building#) Create Trigger Create a trigger that fetches newly created ice cream flavors. [](https://www.activepieces.com/docs/build-pieces/building-pieces/start-building#) Sharing Pieces Share your Gelato piece with others. Contribution ------------ Contribute a piece to our repo and receive +1,400 tasks/month on [Activepieces Cloud](https://cloud.activepieces.com/) . [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/build-pieces/building-pieces/start-building.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/build-pieces/building-pieces/start-building) [Overview](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [Fork Repository](https://www.activepieces.com/docs/build-pieces/building-pieces/setup-fork) ⌘I --- # Version History - Activepieces [Skip to main content](https://www.activepieces.com/docs/flows/versioning#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Flows Version History [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) Activepieces keeps track of all published flows and their versions. Here’s how it works: 1. You can edit a flow as many times as you want in **draft** mode. 2. Once you’re done with your changes, you can publish it. 3. The published version will be locked and uneditable. 4. If you try to edit a published flow, Activepieces will create a new **draft** if there is none and copy the **published** version to the new version. This means you can always go back to a previous version and edit the flow in draft mode without affecting the published version. ![Flow History](https://mintcdn.com/activepieces/31xTG5PE4V5GpSM9/resources/screenshots/flow-history.png?w=2500&fit=max&auto=format&n=31xTG5PE4V5GpSM9&q=85&s=24de78e342ce7672bc6ccb29c352940c) As you can see in the following screenshot, the yellow dot refers to DRAFT and the green dot refers to PUBLISHED. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/flows/versioning.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/flows/versioning) [Debugging Runs](https://www.activepieces.com/docs/flows/debugging-runs) [Technical Limits](https://www.activepieces.com/docs/flows/known-limits) ⌘I --- # Update Project - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/projects/update#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Projects Update Project [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) cURL cURL curl --request POST \ --url https://cloud.activepieces.com/api/v1/projects/{id} \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "releasesEnabled": true, "displayName": "", "externalId": "", "metadata": {}, "plan": { "pieces": [\ ""\ ], "piecesFilterType": "NONE" } } ' 200 { "id": "", "created": "", "updated": "", "ownerId": "", "displayName": "", "platformId": "", "type": "TEAM", "icon": { "color": "RED" }, "releasesEnabled": true, "plan": { "id": "", "created": "", "updated": "", "projectId": "", "locked": false, "name": "", "piecesFilterType": "NONE", "pieces": [\ ""\ ] }, "analytics": { "totalUsers": 123, "activeUsers": 123, "totalFlows": 123, "activeFlows": 123 }, "maxConcurrentJobs": 123, "externalId": "", "metadata": {} } POST / v1 / projects / {id} Try it cURL cURL curl --request POST \ --url https://cloud.activepieces.com/api/v1/projects/{id} \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "releasesEnabled": true, "displayName": "", "externalId": "", "metadata": {}, "plan": { "pieces": [\ ""\ ], "piecesFilterType": "NONE" } } ' 200 { "id": "", "created": "", "updated": "", "ownerId": "", "displayName": "", "platformId": "", "type": "TEAM", "icon": { "color": "RED" }, "releasesEnabled": true, "plan": { "id": "", "created": "", "updated": "", "projectId": "", "locked": false, "name": "", "piecesFilterType": "NONE", "pieces": [\ ""\ ] }, "analytics": { "totalUsers": 123, "activeUsers": 123, "totalFlows": 123, "activeFlows": 123 }, "maxConcurrentJobs": 123, "externalId": "", "metadata": {} } #### Authorizations [​](https://www.activepieces.com/docs/endpoints/projects/update#authorization-authorization) Authorization string header required Use your api key generated from the admin console #### Path Parameters [​](https://www.activepieces.com/docs/endpoints/projects/update#parameter-id) id string required #### Body application/json [​](https://www.activepieces.com/docs/endpoints/projects/update#body-releases-enabled) releasesEnabled boolean [​](https://www.activepieces.com/docs/endpoints/projects/update#body-display-name) displayName string Pattern: `^[^./]+$` [​](https://www.activepieces.com/docs/endpoints/projects/update#body-external-id) externalId string [​](https://www.activepieces.com/docs/endpoints/projects/update#body-metadata) metadata object Show child attributes [​](https://www.activepieces.com/docs/endpoints/projects/update#body-icon) icon object Show child attributes [​](https://www.activepieces.com/docs/endpoints/projects/update#body-plan) plan object Show child attributes #### Response 200 - application/json Default Response [​](https://www.activepieces.com/docs/endpoints/projects/update#response-id) id string required [​](https://www.activepieces.com/docs/endpoints/projects/update#response-created) created string required [​](https://www.activepieces.com/docs/endpoints/projects/update#response-updated) updated string required [​](https://www.activepieces.com/docs/endpoints/projects/update#response-owner-id) ownerId string required [​](https://www.activepieces.com/docs/endpoints/projects/update#response-display-name) displayName string required [​](https://www.activepieces.com/docs/endpoints/projects/update#response-platform-id) platformId string required Pattern: `^[0-9a-zA-Z]{21}$` [​](https://www.activepieces.com/docs/endpoints/projects/update#response-type-one-of-0) type Option 1 · enumOption 2 · enumOption 1 · enumOption 2 · enum required Available options: `TEAM` [​](https://www.activepieces.com/docs/endpoints/projects/update#response-icon) icon object required Show child attributes [​](https://www.activepieces.com/docs/endpoints/projects/update#response-releases-enabled) releasesEnabled boolean required [​](https://www.activepieces.com/docs/endpoints/projects/update#response-plan) plan object required Show child attributes [​](https://www.activepieces.com/docs/endpoints/projects/update#response-analytics) analytics object required Show child attributes [​](https://www.activepieces.com/docs/endpoints/projects/update#response-max-concurrent-jobs-one-of-0) maxConcurrentJobs number | null [​](https://www.activepieces.com/docs/endpoints/projects/update#response-external-id) externalId string [​](https://www.activepieces.com/docs/endpoints/projects/update#response-metadata-one-of-0) metadata object Show child attributes [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/projects/update.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/projects/update) [Create Project](https://www.activepieces.com/docs/endpoints/projects/create) [List Projects](https://www.activepieces.com/docs/endpoints/projects/list) ⌘I --- # Upsert Global Connection - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/global-connections/upsert#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Global Connections Upsert Global Connection [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) cURL cURL curl --request POST \ --url https://cloud.activepieces.com/api/v1/global-connections \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "displayName": "", "pieceName": "", "type": "SECRET_TEXT", "value": { "type": "SECRET_TEXT", "secret_text": "" }, "scope": "PLATFORM", "projectIds": [\ ""\ ], "metadata": {}, "pieceVersion": "", "externalId": "" } ' 201 { "id": "", "created": "", "updated": "", "externalId": "", "displayName": "", "type": "OAUTH2", "pieceName": "", "projectIds": [\ ""\ ], "scope": "PROJECT", "status": "ACTIVE", "pieceVersion": "", "platformId": "", "ownerId": "", "owner": { "id": "", "email": "", "firstName": "", "status": "ACTIVE", "platformRole": "ADMIN", "lastName": "", "created": "", "updated": "", "externalId": "", "platformId": "", "lastActiveDate": "", "imageUrl": "" }, "metadata": {}, "flowIds": [\ ""\ ] } POST / v1 / global-connections Try it cURL cURL curl --request POST \ --url https://cloud.activepieces.com/api/v1/global-connections \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data ' { "displayName": "", "pieceName": "", "type": "SECRET_TEXT", "value": { "type": "SECRET_TEXT", "secret_text": "" }, "scope": "PLATFORM", "projectIds": [\ ""\ ], "metadata": {}, "pieceVersion": "", "externalId": "" } ' 201 { "id": "", "created": "", "updated": "", "externalId": "", "displayName": "", "type": "OAUTH2", "pieceName": "", "projectIds": [\ ""\ ], "scope": "PROJECT", "status": "ACTIVE", "pieceVersion": "", "platformId": "", "ownerId": "", "owner": { "id": "", "email": "", "firstName": "", "status": "ACTIVE", "platformRole": "ADMIN", "lastName": "", "created": "", "updated": "", "externalId": "", "platformId": "", "lastActiveDate": "", "imageUrl": "" }, "metadata": {}, "flowIds": [\ ""\ ] } #### Authorizations [​](https://www.activepieces.com/docs/endpoints/global-connections/upsert#authorization-authorization) Authorization string header required Use your api key generated from the admin console #### Body application/json * Option 1 * Option 2 * Option 3 * Option 4 * Option 5 * Option 6 * Option 7 [​](https://www.activepieces.com/docs/endpoints/global-connections/upsert#body-one-of-0-display-name) displayName string required [​](https://www.activepieces.com/docs/endpoints/global-connections/upsert#body-one-of-0-piece-name) pieceName string required [​](https://www.activepieces.com/docs/endpoints/global-connections/upsert#body-one-of-0-type) type enum required Available options: `SECRET_TEXT` [​](https://www.activepieces.com/docs/endpoints/global-connections/upsert#body-one-of-0-value) value object required Show child attributes [​](https://www.activepieces.com/docs/endpoints/global-connections/upsert#body-one-of-0-scope) scope enum required Available options: `PLATFORM` [​](https://www.activepieces.com/docs/endpoints/global-connections/upsert#body-one-of-0-project-ids) projectIds string\[\] required [​](https://www.activepieces.com/docs/endpoints/global-connections/upsert#body-one-of-0-metadata) metadata object Show child attributes [​](https://www.activepieces.com/docs/endpoints/global-connections/upsert#body-one-of-0-piece-version) pieceVersion string [​](https://www.activepieces.com/docs/endpoints/global-connections/upsert#body-one-of-0-external-id) externalId string #### Response 201 - application/json App connection is a connection to an external app. App connection is a connection to an external app. [​](https://www.activepieces.com/docs/endpoints/global-connections/upsert#response-id) id string required [​](https://www.activepieces.com/docs/endpoints/global-connections/upsert#response-created) created string required [​](https://www.activepieces.com/docs/endpoints/global-connections/upsert#response-updated) updated string required [​](https://www.activepieces.com/docs/endpoints/global-connections/upsert#response-external-id) externalId string required [​](https://www.activepieces.com/docs/endpoints/global-connections/upsert#response-display-name) displayName string required [​](https://www.activepieces.com/docs/endpoints/global-connections/upsert#response-type-one-of-0) type Option 1 · enumOption 2 · enumOption 3 · enumOption 4 · enumOption 5 · enumOption 6 · enumOption 7 · enumOption 1 · enumOption 2 · enumOption 3 · enumOption 4 · enumOption 5 · enumOption 6 · enumOption 7 · enum required Available options: `OAUTH2` [​](https://www.activepieces.com/docs/endpoints/global-connections/upsert#response-piece-name) pieceName string required [​](https://www.activepieces.com/docs/endpoints/global-connections/upsert#response-project-ids) projectIds string\[\] required Pattern: `^[0-9a-zA-Z]{21}$` [​](https://www.activepieces.com/docs/endpoints/global-connections/upsert#response-scope-one-of-0) scope Option 1 · enumOption 2 · enumOption 1 · enumOption 2 · enum required Available options: `PROJECT` [​](https://www.activepieces.com/docs/endpoints/global-connections/upsert#response-status-one-of-0) status Option 1 · enumOption 2 · enumOption 3 · enumOption 1 · enumOption 2 · enumOption 3 · enum required Available options: `ACTIVE` [​](https://www.activepieces.com/docs/endpoints/global-connections/upsert#response-piece-version) pieceVersion string required [​](https://www.activepieces.com/docs/endpoints/global-connections/upsert#response-platform-id-one-of-0) platformId string | null [​](https://www.activepieces.com/docs/endpoints/global-connections/upsert#response-owner-id-one-of-0) ownerId string | null [​](https://www.activepieces.com/docs/endpoints/global-connections/upsert#response-owner-one-of-0) owner object Show child attributes [​](https://www.activepieces.com/docs/endpoints/global-connections/upsert#response-metadata-one-of-0) metadata object Show child attributes [​](https://www.activepieces.com/docs/endpoints/global-connections/upsert#response-flow-ids-one-of-0) flowIds string\[\] | null Pattern: `^[0-9a-zA-Z]{21}$` [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/global-connections/upsert.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/global-connections/upsert) [Global Connection Schema](https://www.activepieces.com/docs/endpoints/global-connections/schema) [Update Global Connection](https://www.activepieces.com/docs/endpoints/global-connections/update) ⌘I --- # Community (Public NPM) - Activepieces [Skip to main content](https://www.activepieces.com/docs/build-pieces/sharing-pieces/community#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Sharing Pieces Community (Public NPM) [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) You can publish your pieces to the npm registry and share them with the community. Users can install your piece from Settings -> My Pieces -> Install Piece -> type in the name of your piece package. 1 [](https://www.activepieces.com/docs/build-pieces/sharing-pieces/community#) Login to npm Make sure you are logged in to npm. If not, please run: npm login 2 [](https://www.activepieces.com/docs/build-pieces/sharing-pieces/community#) Rename Piece Rename the piece name in `package.json` to something unique or related to your organization’s scope (e.g., `@my-org/piece-PIECE_NAME`). You can find it at `packages/pieces/PIECE_NAME/package.json`. Don’t forget to increase the version number in `package.json` for each new release. 3 [](https://www.activepieces.com/docs/build-pieces/sharing-pieces/community#) Publish Replace `PIECE_FOLDER_NAME` with the name of the folder. Run the following command: npm run publish-piece PIECE_FOLDER_NAME **Congratulations! You can now import the piece from the settings page.** [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/build-pieces/sharing-pieces/community.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/build-pieces/sharing-pieces/community) [Contribute](https://www.activepieces.com/docs/build-pieces/sharing-pieces/contribute) [Private](https://www.activepieces.com/docs/build-pieces/sharing-pieces/private) ⌘I --- # Dev Containers - Activepieces [Skip to main content](https://www.activepieces.com/docs/build-pieces/misc/dev-container#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Misc Dev Containers [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Using Dev Containers in Visual Studio Code](https://www.activepieces.com/docs/build-pieces/misc/dev-container#using-dev-containers-in-visual-studio-code) * [Prerequisites](https://www.activepieces.com/docs/build-pieces/misc/dev-container#prerequisites) * [Using the Dev Container](https://www.activepieces.com/docs/build-pieces/misc/dev-container#using-the-dev-container) * [Exiting the Dev Container](https://www.activepieces.com/docs/build-pieces/misc/dev-container#exiting-the-dev-container) * [Troubleshoot](https://www.activepieces.com/docs/build-pieces/misc/dev-container#troubleshoot) [​](https://www.activepieces.com/docs/build-pieces/misc/dev-container#using-dev-containers-in-visual-studio-code) Using Dev Containers in Visual Studio Code --------------------------------------------------------------------------------------------------------------------------------------------------------------- The project includes a dev container configuration that allows you to use Visual Studio Code’s [Remote Development](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack) extension to develop the project in a consistent environment. This can be especially helpful if you are new to the project or if you have a different environment setup on your local machine. [​](https://www.activepieces.com/docs/build-pieces/misc/dev-container#prerequisites) Prerequisites ----------------------------------------------------------------------------------------------------- Before you can use the dev container, you will need to install the following: * [Visual Studio Code](https://code.visualstudio.com/) . * The [Remote Development](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack) extension for Visual Studio Code. * [Docker](https://www.docker.com/) . [​](https://www.activepieces.com/docs/build-pieces/misc/dev-container#using-the-dev-container) Using the Dev Container ------------------------------------------------------------------------------------------------------------------------- To use the dev container for the Activepieces project, follow these steps: 1. Clone the Activepieces repository to your local machine. 2. Open the project in Visual Studio Code. 3. Press `Ctrl+Shift+P` and type `> Dev Containers: Reopen in Container`. 4. Run `npm start`. 5. The backend will run at `localhost:3000` and the frontend will run at `localhost:4200`. By default, the development setup only builds specific pieces.Open the file `.env.dev` and add comma-separated list of pieces to make available.For more details, check out the [Piece Development](https://www.activepieces.com/docs/build-pieces/building-pieces/development-setup#pieces-development) section. The login credentials are: Email: `[[email protected]](https://www.activepieces.com/cdn-cgi/l/email-protection) ` Password: `12345678` [​](https://www.activepieces.com/docs/build-pieces/misc/dev-container#exiting-the-dev-container) Exiting the Dev Container ----------------------------------------------------------------------------------------------------------------------------- To exit the dev container and return to your local environment, follow these steps: 1. In the bottom left corner of Visual Studio Code, click the `Remote-Containers: Reopen folder locally` button. 2. Visual Studio Code will close the connection to the dev container and reopen the project in your local environment. [​](https://www.activepieces.com/docs/build-pieces/misc/dev-container#troubleshoot) Troubleshoot --------------------------------------------------------------------------------------------------- One of the best trouble shoot after an error occur is to reset the dev container. 1. Exit the dev container 2. Run the following sh tools/reset-dev.sh 3. Rebuild the dev container from above steps [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/build-pieces/misc/dev-container.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/build-pieces/misc/dev-container) [Testing Pieces](https://www.activepieces.com/docs/build-pieces/misc/testing-pieces) [GitHub Codespaces](https://www.activepieces.com/docs/build-pieces/misc/codespaces) ⌘I --- # Passing Data - Activepieces [Skip to main content](https://www.activepieces.com/docs/flows/passing-data#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Flows Passing Data [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Data flow](https://www.activepieces.com/docs/flows/passing-data#data-flow) * [Example Steps](https://www.activepieces.com/docs/flows/passing-data#example-steps) * [Data to Insert Panel](https://www.activepieces.com/docs/flows/passing-data#data-to-insert-panel) * [Testing Steps to Generate Data](https://www.activepieces.com/docs/flows/passing-data#testing-steps-to-generate-data) * [Advanced Tips](https://www.activepieces.com/docs/flows/passing-data#advanced-tips) * [Switching to Dynamic Values](https://www.activepieces.com/docs/flows/passing-data#switching-to-dynamic-values) * [Accessing data by path](https://www.activepieces.com/docs/flows/passing-data#accessing-data-by-path) [​](https://www.activepieces.com/docs/flows/passing-data#data-flow) Data flow -------------------------------------------------------------------------------- Any Activepieces flow is a vertical diagram that **starts with a trigger step** followed by **any number of action steps**. Steps are connected vertically. Data flows from parent steps to the children. Children steps have access to the output data of the parent steps. [​](https://www.activepieces.com/docs/flows/passing-data#example-steps) Example Steps ---------------------------------------------------------------------------------------- This flow has 3 steps, they can access data as follows: * **Step 1** is the main data producer to be used in the next steps. Data produced by Step 1 will be accessible in Steps 2 and 3. Some triggers don’t produce data though, like Schedules. * **Step 2** can access data produced by Step 1. After execution, this step will also produce data to be used in the next step(s). * **Step 3** can access data produced by Steps 1 and 2 as they’re its parent steps. This step can produce data but since it’s the last step in the flow, it can’t be used by other ones. [​](https://www.activepieces.com/docs/flows/passing-data#data-to-insert-panel) Data to Insert Panel ------------------------------------------------------------------------------------------------------ In order to use data from a previous step in your current step, place your cursor in any input, the **Data to Insert** panel will pop up. This panel shows the accessible steps and their data. You can expand the data items to view their content, and you can click the items to insert them in your current settings input. If an item in this panel has a caret (⌄) to the right, it means you can click on the item to expand its child properties. You can select the parent item or its properties as you need. When you insert data from this panel, it gets inserted at the cursor’s position in the input. This means you can combine static text and dynamic data in any field. We generally recommend that you expand the items before inserting them to understand the type of data they contain and whether they’re the right fit to the input you’re filling. [​](https://www.activepieces.com/docs/flows/passing-data#testing-steps-to-generate-data) Testing Steps to Generate Data -------------------------------------------------------------------------------------------------------------------------- We require you to test steps before accessing their data. This approach protects you from selecting the wrong data and breaking your flows after publishing them. If a step is not tested and you try to access its data, you will see the following message: ![Test your automation step first](https://mintcdn.com/activepieces/ki8mFooo8mAmhMdP/resources/passing-data-test-step-first.png?w=2500&fit=max&auto=format&n=ki8mFooo8mAmhMdP&q=85&s=d5fdea437c038655acd7b9976c6309bc) To fix this, go to the step and use the Generate Sample Data panel to test it. Steps use different approaches for testing. These are the common ones: * **Load Data:** Some triggers will let you load data from your connected account without having to perform any action in that account. * **Test Trigger:** Some triggers will require you to head to your connected account and fire the trigger in order to generate sample data. * **Send Data:** Webhooks require you to send a sample request to the webhook URL to generate sample data. * **Test Action:** Action steps will let you run the action in order to generate sample data. Follow the instructions in the Generate Sample Data panel to know how your step should be tested. Some triggers will also let you Use Mock Data, which will generate static sample data from the piece. We recommend that you test the step instead of using mock data. This is an example for generating sample data for a trigger using the **Load Data** button: [​](https://www.activepieces.com/docs/flows/passing-data#advanced-tips) Advanced Tips ---------------------------------------------------------------------------------------- ### [​](https://www.activepieces.com/docs/flows/passing-data#switching-to-dynamic-values) Switching to Dynamic Values Dropdowns and some other input types don’t let you select data from previous steps. If you’d like to bypass this and use data from previous steps instead, switch the input into a dynamic one using this button: ### [​](https://www.activepieces.com/docs/flows/passing-data#accessing-data-by-path) Accessing data by path If you can’t find the data you’re looking for in the **Data to Insert** panel but you’d like to use it, you can write a JSON path instead. Use the following syntax to write JSON paths: `{{step_slug.path.to.property}}` The `step_slug` can be found by moving your cursor over any of your flow steps, it will show to the right of the step. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/flows/passing-data.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/flows/passing-data) [Building Flows](https://www.activepieces.com/docs/flows/building-flows) [Publishing Flows](https://www.activepieces.com/docs/flows/publishing-flows) ⌘I --- # External Libraries - Activepieces [Skip to main content](https://www.activepieces.com/docs/build-pieces/piece-reference/external-libraries#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Piece Reference External Libraries [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Dependency Pinning](https://www.activepieces.com/docs/build-pieces/piece-reference/external-libraries#dependency-pinning) The Activepieces repository is structured as a monorepo, employing Nx as its build tool. To keep our main `package.json` as light as possible, we keep libraries that are only used for a piece in the piece `package.json` . This means when adding a new library you should navigate to the piece folder and install the library with our package manager `bun` cd packages/pieces/ bun install --save * Import the library into your piece. Guidelines: * Make sure you are using well-maintained libraries. * Ensure that the library size is not too large to avoid bloating the bundle size; this will make the piece load faster in the sandbox. [​](https://www.activepieces.com/docs/build-pieces/piece-reference/external-libraries#dependency-pinning) Dependency Pinning ------------------------------------------------------------------------------------------------------------------------------- When pieces are built for publishing, all dependency versions — including **transitive dependencies** (dependencies of your dependencies) — are automatically pinned to the exact versions resolved in the monorepo’s `bun.lock` file. This means: * You don’t need to worry about manually pinning transitive dependency versions. * The published piece will always install the same dependency tree that was tested during development. * This protects against supply chain attacks where a compromised transitive dependency could be silently pulled in at install time. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/build-pieces/piece-reference/external-libraries.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/build-pieces/piece-reference/external-libraries) [Files](https://www.activepieces.com/docs/build-pieces/piece-reference/files) [Piece Versioning](https://www.activepieces.com/docs/build-pieces/piece-reference/piece-versioning) ⌘I --- # Fork Repository - Activepieces [Skip to main content](https://www.activepieces.com/docs/build-pieces/building-pieces/setup-fork#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Build a Piece Fork Repository [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) To start building pieces, we need to fork the repository that contains the framework library and the development environment. Later, we will publish these pieces as `npm` artifacts. Follow these steps to fork the repository: If you are on windows, please install [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) and set up git there then proceed with the instructions down below 1. Go to the repository page at [https://github.com/activepieces/activepieces](https://github.com/activepieces/activepieces) . 2. Click the `Fork` button located in the top right corner of the page. ![Fork Repository](https://mintcdn.com/activepieces/uHZ35vXyxX7goNO-/resources/screenshots/fork-repository.jpg?w=2500&fit=max&auto=format&n=uHZ35vXyxX7goNO-&q=85&s=fa912e2c0634a5662761334495521976) 3. Clone your fork using a shallow clone for faster setup: git clone --depth=1 https://github.com/YOUR_USERNAME/activepieces.git Using `--depth=1` reduces the clone size significantly by only fetching the latest commit instead of the full history. If you are an enterprise customer and want to use the private pieces feature, you can refer to the tutorial on how to set up a [private fork](https://www.activepieces.com/docs/build-pieces/misc/private-fork) . [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/build-pieces/building-pieces/setup-fork.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/build-pieces/building-pieces/setup-fork) [Start Building](https://www.activepieces.com/docs/build-pieces/building-pieces/start-building) [Development setup](https://www.activepieces.com/docs/build-pieces/building-pieces/development-setup) ⌘I --- # Technical Limits - Activepieces [Skip to main content](https://www.activepieces.com/docs/flows/known-limits#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Flows Technical Limits [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Execution Limits](https://www.activepieces.com/docs/flows/known-limits#execution-limits) * [File Storage Limits](https://www.activepieces.com/docs/flows/known-limits#file-storage-limits) * [Webhook Limits](https://www.activepieces.com/docs/flows/known-limits#webhook-limits) * [Key / Value Storage Limits](https://www.activepieces.com/docs/flows/known-limits#key-%2F-value-storage-limits) ### [​](https://www.activepieces.com/docs/flows/known-limits#execution-limits) Execution Limits * **Flow Execution Time** Maximum: **600 seconds (10 minutes)** Flows exceeding this limit will be marked as timed out. * **Memory Usage** Maximum: **1 GB RAM** (Self hosted can be configured via `AP_SANDBOX_MEMORY_LIMIT`) The memory usage is measured for the entire Node.js process running the flow. There is approximately 300 MB of overhead for a warm process with pieces already loaded. **Note 1:** Flows paused by steps like **Wait for Approval** or **Delay** do **not** count toward the 600-second limit. **Note 2:** To handle longer processes, split them into multiple flows. For example: * Have one flow call another via **webhook**. * Process smaller **batches of items** in separate flows. * * * ### [​](https://www.activepieces.com/docs/flows/known-limits#file-storage-limits) File Storage Limits Files from actions or triggers are stored in the database/S3 to support retries for certain steps. * **Maximum File Size**: **10 MB** (Configurable via `AP_MAX_FILE_SIZE_MB`, default: **25 MB**) * **Maximum Flow Run Log Size**: **25 MB** (Configurable via `AP_MAX_FLOW_RUN_LOG_SIZE_MB`, default: **25 MB**) > This is the total combined size of all inputs and outputs for each step in a single flow run. * * * ### [​](https://www.activepieces.com/docs/flows/known-limits#webhook-limits) Webhook Limits * **Webhook Response Timeout**: **30 seconds** (Configurable via `AP_WEBHOOK_TIMEOUT_SECONDS`, default: **30 seconds**) > For synchronous webhook requests (URLs ending in `/sync`), Activepieces will wait up to this limit before returning a 408 Request Timeout response. * **Maximum Webhook Payload Size**: **5 MB** (Configurable via `AP_MAX_WEBHOOK_PAYLOAD_SIZE_MB`, default: **5 MB**) > Webhook payloads exceeding this limit will be rejected with HTTP 413. * **Webhook Payload Inline Threshold**: **512 KB** (Configurable via `AP_WEBHOOK_PAYLOAD_INLINE_THRESHOLD_KB`, default: **512 KB**) > Payloads below this threshold are stored inline in Redis for fastest processing. Payloads above this threshold are offloaded to file storage to protect Redis memory. * * * ### [​](https://www.activepieces.com/docs/flows/known-limits#key-/-value-storage-limits) Key / Value Storage Limits Some pieces use the built-in Activepieces key store (e.g., **Store Piece**, **Queue Piece**). * **Maximum Key Length**: **128 characters** * **Maximum Value Size**: **512 KB** [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/flows/known-limits.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/flows/known-limits) [Version History](https://www.activepieces.com/docs/flows/versioning) [MCP Server](https://www.activepieces.com/docs/mcp/overview) ⌘I --- # Publishing Flows - Activepieces [Skip to main content](https://www.activepieces.com/docs/flows/publishing-flows#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Flows Publishing Flows [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) The changes you make won’t work right away to avoid disrupting the flow that’s already published. To enable your changes, simply click on the publish button once you’re done with your changes. ![Flow Parts](https://mintcdn.com/activepieces/ki8mFooo8mAmhMdP/resources/publish-flow.png?w=2500&fit=max&auto=format&n=ki8mFooo8mAmhMdP&q=85&s=3cfb860e093d625e6f226fb36deec7d4) [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/flows/publishing-flows.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/flows/publishing-flows) [Passing Data](https://www.activepieces.com/docs/flows/passing-data) [Debugging Runs](https://www.activepieces.com/docs/flows/debugging-runs) ⌘I --- # Build Custom Pieces - Activepieces [Skip to main content](https://www.activepieces.com/docs/build-pieces/misc/build-piece#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Misc Build Custom Pieces [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [How It Works](https://www.activepieces.com/docs/build-pieces/misc/build-piece#how-it-works) * [Usage](https://www.activepieces.com/docs/build-pieces/misc/build-piece#usage) You can use the CLI to build custom pieces for the platform. This process compiles the pieces and exports them as a `.tgz` packed archive. ### [​](https://www.activepieces.com/docs/build-pieces/misc/build-piece#how-it-works) How It Works The CLI scans the `packages/pieces/` directory for the specified piece. It checks the **name** in the `package.json` file. If the piece is found, it builds and packages it into a `.tgz` archive. ### [​](https://www.activepieces.com/docs/build-pieces/misc/build-piece#usage) Usage To build a piece, follow these steps: 1. Ensure you have the CLI installed by cloning the repository. 2. Run the following command: npm run build-piece You will be prompted to enter the name of the piece you want to build. For example: ? Enter the piece folder name : google-drive The CLI will build the piece and you will be given the path to the archive. For example: Piece 'google-drive' built and packed successfully at packages/pieces/community/google-drive/dist You may also build the piece non-interactively by passing the piece name as an argument. For example: npm run build-piece google-drive [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/build-pieces/misc/build-piece.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/build-pieces/misc/build-piece) [Piece i18n](https://www.activepieces.com/docs/build-pieces/piece-reference/i18n) [Publish Custom Pieces](https://www.activepieces.com/docs/build-pieces/misc/publish-piece) ⌘I --- # Piece Examples - Activepieces [Skip to main content](https://www.activepieces.com/docs/build-pieces/piece-reference/examples#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Piece Reference Piece Examples [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Triggers:](https://www.activepieces.com/docs/build-pieces/piece-reference/examples#triggers) * [Actions:](https://www.activepieces.com/docs/build-pieces/piece-reference/examples#actions) * [Authentication](https://www.activepieces.com/docs/build-pieces/piece-reference/examples#authentication) To get the full benefit, it is recommended to read the tutorial first. [​](https://www.activepieces.com/docs/build-pieces/piece-reference/examples#triggers) Triggers: -------------------------------------------------------------------------------------------------- **Webhooks:** * [New Form Submission on Typeform](https://github.com/activepieces/activepieces/blob/main/packages/pieces/community/typeform/src/lib/trigger/new-submission.ts) **Polling:** * [New Completed Task On Todoist](https://github.com/activepieces/activepieces/blob/main/packages/pieces/community/todoist/src/lib/triggers/task-completed-trigger.ts) [​](https://www.activepieces.com/docs/build-pieces/piece-reference/examples#actions) Actions: ------------------------------------------------------------------------------------------------ * [Send a message On Discord](https://github.com/activepieces/activepieces/blob/main/packages/pieces/community/discord/src/lib/actions/send-message-webhook.ts) * [Send an mail On Gmail](https://github.com/activepieces/activepieces/blob/main/packages/pieces/community/gmail/src/lib/actions/send-email-action.ts) [​](https://www.activepieces.com/docs/build-pieces/piece-reference/examples#authentication) Authentication ------------------------------------------------------------------------------------------------------------- **OAuth2:** * [Slack](https://github.com/activepieces/activepieces/blob/main/packages/pieces/community/slack/src/index.ts) * [Gmail](https://github.com/activepieces/activepieces/blob/main/packages/pieces/community/gmail/src/index.ts) **API Key:** * [Sendgrid](https://github.com/activepieces/activepieces/blob/main/packages/pieces/community/sendgrid/src/index.ts) **Basic Authentication:** * [Twilio](https://github.com/activepieces/activepieces/blob/main/packages/pieces/community/twilio/src/index.ts) [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/build-pieces/piece-reference/examples.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/build-pieces/piece-reference/examples) [Piece Versioning](https://www.activepieces.com/docs/build-pieces/piece-reference/piece-versioning) [Enable Custom API Calls](https://www.activepieces.com/docs/build-pieces/piece-reference/custom-api-calls) ⌘I --- # Provision Users - Activepieces [Skip to main content](https://www.activepieces.com/docs/embedding/provision-users#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Essentials Provision Users [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Overview](https://www.activepieces.com/docs/embedding/provision-users#overview) This feature is available in our paid editions. Contact us [here](https://www.activepieces.com/sales) , and we'll be delighted to assist you! [​](https://www.activepieces.com/docs/embedding/provision-users#overview) Overview ------------------------------------------------------------------------------------- In Activepieces, there are **Projects** and **Users**. Each project is provisioned with their corresponding workspace, project, or team in your SaaS. The users are then mapped to the respective users in Activepieces. To achieve this, the backend will generate a signed token that contains all the necessary information to automatically create a user and project. If the user or project already exists, it will skip the creation and log in the user directly. 1 [](https://www.activepieces.com/docs/embedding/provision-users#) Step 1: Obtain Signing Key You can generate a signing key by going to **Platform Settings -> Signing Keys -> Generate Signing Key**.This will generate a public and private key pair. The public key will be used by Activepieces to verify the signature of the JWT tokens you send. The private key will be used by you to sign the JWT tokens.![Create Signing Key](https://mintcdn.com/activepieces/ki8mFooo8mAmhMdP/resources/screenshots/create-signing-key.png?w=2500&fit=max&auto=format&n=ki8mFooo8mAmhMdP&q=85&s=979139e06bf803a368f38dbd356d8d52) Please store your private key in a safe place, as it will not be stored in Activepieces. 2 [](https://www.activepieces.com/docs/embedding/provision-users#) Step 2: Generate a JWT The signing key will be used to generate JWT tokens for the currently logged-in user on your website, which will then be sent to the Activepieces Iframe as a query parameter to authenticate the user and exchange the token for a longer lived token.To generate these tokens, you will need to add code in your backend to generate the token using the RS256 algorithm, so the JWT header would look like this: To obtain the `SIGNING_KEY_ID`, refer to the signing key table and locate the value in the first column.![Signing Key ID](https://mintcdn.com/activepieces/uHZ35vXyxX7goNO-/resources/screenshots/signing-key-id.png?w=2500&fit=max&auto=format&n=uHZ35vXyxX7goNO-&q=85&s=e4fbadf85aa80f878a53f3e39f6ac591) { "alg": "RS256", "typ": "JWT", "kid": "SIGNING_KEY_ID" } The signed tokens must include these claims in the payload: { "version": "v3", "externalUserId": "user_id", "externalProjectId": "user_project_id", "firstName": "John", "lastName": "Doe", "role": "EDITOR", "piecesFilterType": "NONE", "exp": 1856563200, "tasks": 50000, "aiCredits": 250 } | Claim | Description | | --- | --- | | externalUserId | Unique identification of the user in **your** software | | externalProjectId | Unique identification of the user’s project in **your** software | | projectDisplayName | Display name of the user’s project | | firstName | First name of the user | | lastName | Last name of the user | | role | Role of the user in the Activepieces project (e.g., **EDITOR**, **VIEWER**, **ADMIN**) | | exp | Expiry timestamp for the token (Unix timestamp) | | piecesFilterType | Customize the project pieces, check [customize pieces](https://www.activepieces.com/docs/embedding/customize-pieces) | | piecesTags | Customize the project pieces, check [customize pieces](https://www.activepieces.com/docs/embedding/customize-pieces) | | tasks | Customize the tasks limit for your user’s project | | aiCredits | Customize the ai credits limit for your user’s project | You can use any JWT library to generate the token. Here is an example using the jsonwebtoken library in Node.js: **Friendly Tip #1**: You can also use this [tool](https://dinochiesa.github.io/jwt/) to generate a quick example. **Friendly Tip #2**: Make sure the expiry time is very short, as it’s a temporary token and will be exchanged for a longer-lived token. Node.js const jwt = require('jsonwebtoken'); // JWT NumericDates specified in seconds: const currentTime = Math.floor(Date.now() / 1000); let token = jwt.sign( { version: "v3", externalUserId: "user_id", externalProjectId: "user_project_id", firstName: "John", lastName: "Doe", role: "EDITOR", piecesFilterType: "NONE", exp: currentTime + (60 * 60), // 1 hour from now }, process.env.ACTIVEPIECES_SIGNING_KEY, { algorithm: "RS256", header: { kid: signingKeyID, // Include the "kid" in the header }, } ); Once you have generated the token, please check the embedding docs to know how to embed the token in the iframe. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/embedding/provision-users.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/embedding/provision-users) [Overview](https://www.activepieces.com/docs/embedding/overview) [Embed Builder](https://www.activepieces.com/docs/embedding/embed-builder) ⌘I --- # Migrate from Nx to Turbo - Activepieces [Skip to main content](https://www.activepieces.com/docs/build-pieces/misc/migrate-nx-to-turbo#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Misc Migrate from Nx to Turbo [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [What Changed](https://www.activepieces.com/docs/build-pieces/misc/migrate-nx-to-turbo#what-changed) * [Files affected per piece](https://www.activepieces.com/docs/build-pieces/misc/migrate-nx-to-turbo#files-affected-per-piece) * [Automatic Migration](https://www.activepieces.com/docs/build-pieces/misc/migrate-nx-to-turbo#automatic-migration) * [Migrate a specific piece](https://www.activepieces.com/docs/build-pieces/misc/migrate-nx-to-turbo#migrate-a-specific-piece) * [What the script does](https://www.activepieces.com/docs/build-pieces/misc/migrate-nx-to-turbo#what-the-script-does) * [Verify the Migration](https://www.activepieces.com/docs/build-pieces/misc/migrate-nx-to-turbo#verify-the-migration) The Activepieces monorepo has fully migrated to Turbo. This guide is kept for **historical reference** and for users with older forks that still use the Nx-based build system. If you have an existing fork with custom pieces built using the **old Nx-based build system**, you need to migrate them to the new **Turbo-based build system**. This guide explains what changed and provides a migration script. [​](https://www.activepieces.com/docs/build-pieces/misc/migrate-nx-to-turbo#what-changed) What Changed --------------------------------------------------------------------------------------------------------- The Activepieces monorepo replaced [Nx](https://nx.dev/) with [Turbo](https://turbo.build/) as its build orchestrator. For pieces, this means: | | **Old (Nx)** | **New (Turbo)** | | --- | --- | --- | | Build config | `project.json` per piece | `package.json` scripts | | Build command | `nx build pieces-{name}` | `turbo run build --filter=@activepieces/piece-{name}` | | Output directory | `dist/out-tsc` (shared) | `./dist` (local per piece) | | Task runner | Nx executor (`@nx/js:tsc`) | Direct `tsc -p tsconfig.lib.json && cp package.json dist/` | | Dependencies | Inferred by Nx graph | Workspace protocol (`workspace:*`) in `package.json` | ### [​](https://www.activepieces.com/docs/build-pieces/misc/migrate-nx-to-turbo#files-affected-per-piece) Files affected per piece * **`project.json`** — Deleted (no longer needed) * **`package.json`** — Added `build` and `lint` scripts, added `main` and `types` fields, added workspace dependencies * **`tsconfig.lib.json`** — Updated `outDir`, added `rootDir`, `baseUrl`, `paths` [​](https://www.activepieces.com/docs/build-pieces/misc/migrate-nx-to-turbo#automatic-migration) Automatic Migration ----------------------------------------------------------------------------------------------------------------------- Run the migration script to update all custom pieces at once: npx ts-node tools/scripts/migrate-custom-piece-to-turbo.ts This scans `packages/pieces/custom/` and applies all necessary changes. ### [​](https://www.activepieces.com/docs/build-pieces/misc/migrate-nx-to-turbo#migrate-a-specific-piece) Migrate a specific piece You can also pass a path to migrate a single piece: npx ts-node tools/scripts/migrate-custom-piece-to-turbo.ts packages/pieces/custom/my-piece ### [​](https://www.activepieces.com/docs/build-pieces/misc/migrate-nx-to-turbo#what-the-script-does) What the script does For each piece, the script: 1. **Updates `package.json`** — adds `build` and `lint` scripts, sets `main` and `types` entry points, ensures `@activepieces/pieces-framework`, `@activepieces/shared`, and `tslib` are listed as dependencies 2. **Updates `tsconfig.lib.json`** — sets `outDir` to `./dist`, adds `rootDir`, `baseUrl`, `paths`, and `declaration` settings 3. **Creates `tsconfig.json`** if missing — extends the root `tsconfig.base.json` 4. **Deletes `project.json`** — removes Nx configuration [​](https://www.activepieces.com/docs/build-pieces/misc/migrate-nx-to-turbo#verify-the-migration) Verify the Migration ------------------------------------------------------------------------------------------------------------------------- After migrating, build your piece to verify everything works: npx turbo run build --filter=@activepieces/piece-your-piece --force Or use the CLI: npm run build-piece your-piece The build output should appear in `packages/pieces/custom/your-piece/dist/`. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/build-pieces/misc/migrate-nx-to-turbo.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/build-pieces/misc/migrate-nx-to-turbo) [Custom Pieces CI/CD](https://www.activepieces.com/docs/build-pieces/misc/pieces-ci-cd) [Setup Private Fork](https://www.activepieces.com/docs/build-pieces/misc/private-fork) ⌘I --- # Piece Schema - Activepieces [Skip to main content](https://www.activepieces.com/docs/endpoints/pieces/schema#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Pieces Piece Schema [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) Example { "name": "", "displayName": "", "logoUrl": "", "description": "", "authors": [\ ""\ ], "version": "", "actions": {}, "triggers": {}, "id": "", "platformId": "", "directoryPath": "", "auth": { "displayName": "", "username": { "displayName": "", "description": "" }, "password": { "displayName": "", "description": "" }, "type": "BASIC_AUTH", "required": true, "description": "", "defaultValue": "" }, "categories": [\ "ARTIFICIAL_INTELLIGENCE"\ ], "minimumSupportedRelease": "", "maximumSupportedRelease": "", "i18n": { "nl": {}, "en": {}, "de": {}, "fr": {}, "es": {}, "ja": {}, "zh": {}, "pt": {}, "ar": {}, "zh-TW": {} } } [​](https://www.activepieces.com/docs/endpoints/pieces/schema#schema-name) name string required [​](https://www.activepieces.com/docs/endpoints/pieces/schema#schema-display-name) displayName string required [​](https://www.activepieces.com/docs/endpoints/pieces/schema#schema-logo-url) logoUrl string required [​](https://www.activepieces.com/docs/endpoints/pieces/schema#schema-description) description string required [​](https://www.activepieces.com/docs/endpoints/pieces/schema#schema-authors) authors string\[\] required [​](https://www.activepieces.com/docs/endpoints/pieces/schema#schema-version) version string required [​](https://www.activepieces.com/docs/endpoints/pieces/schema#schema-actions) actions object required Show child attributes [​](https://www.activepieces.com/docs/endpoints/pieces/schema#schema-triggers) triggers object required Show child attributes [​](https://www.activepieces.com/docs/endpoints/pieces/schema#schema-id) id string [​](https://www.activepieces.com/docs/endpoints/pieces/schema#schema-platform-id) platformId string [​](https://www.activepieces.com/docs/endpoints/pieces/schema#schema-directory-path) directoryPath string [​](https://www.activepieces.com/docs/endpoints/pieces/schema#schema-auth-one-of-0) auth Option 1 · objectOption 2 · objectOption 3 · objectOption 4 · objectOption 5 · object\[\]Option 1 · objectOption 2 · objectOption 3 · objectOption 4 · objectOption 5 · object\[\] Show child attributes [​](https://www.activepieces.com/docs/endpoints/pieces/schema#schema-categories) categories enum\[\] Available options: `ARTIFICIAL_INTELLIGENCE` [​](https://www.activepieces.com/docs/endpoints/pieces/schema#schema-minimum-supported-release) minimumSupportedRelease string [​](https://www.activepieces.com/docs/endpoints/pieces/schema#schema-maximum-supported-release) maximumSupportedRelease string [​](https://www.activepieces.com/docs/endpoints/pieces/schema#schema-i18n) i18n object Show child attributes [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/endpoints/pieces/schema.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/endpoints/pieces/schema) [Get Sample Data](https://www.activepieces.com/docs/endpoints/sample-data/get) [Install Piece](https://www.activepieces.com/docs/endpoints/pieces/install) ⌘I --- # Publish Custom Pieces - Activepieces [Skip to main content](https://www.activepieces.com/docs/build-pieces/misc/publish-piece#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Misc Publish Custom Pieces [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [How It Works](https://www.activepieces.com/docs/build-pieces/misc/publish-piece#how-it-works) * [Usage](https://www.activepieces.com/docs/build-pieces/misc/publish-piece#usage) You can use the CLI to publish custom pieces to the platform. This process packages the pieces and uploads them to the specified API endpoint. ### [​](https://www.activepieces.com/docs/build-pieces/misc/publish-piece#how-it-works) How It Works The CLI scans the `packages/pieces/` directory for the specified piece. It checks the **name** and **version** in the `package.json` file. If the piece is not already published, it builds, packages, and uploads it to the platform using the API. ### [​](https://www.activepieces.com/docs/build-pieces/misc/publish-piece#usage) Usage To publish a piece, follow these steps: 1. Ensure you have an API Key. Generate it from the Admin Interface by navigating to Settings. 2. Install the CLI by cloning the repository. 3. Run the following command: npm run publish-piece-to-api 4. You will be asked three questions to publish your piece: * `Piece Folder Name`: This is the name associated with the folder where the action resides. It helps organize and categorize actions within the piece. * `API URL`: This is the URL of the API endpoint where the piece will be published (ex: [https://cloud.activepieces.com/api](https://cloud.activepieces.com/api) ). * `API Key Source`: This is the source of the API key. It can be either `Env Variable (AP_API_KEY)` or `Manually`. In case you choose `Env Variable (AP_API_KEY)`, the CLI will use the API key from the `.env` file in the `packages/server/api` directory. In case you choose `Manually`, you will be asked to enter the API key. Examples: npm run publish-piece-to-api ? Enter the piece folder name : google-drive ? Enter the API URL : https://cloud.activepieces.com/api ? Enter the API Key Source : Env Variable (AP_API_KEY) npm run publish-piece-to-api ? Enter the piece folder name : google-drive ? Enter the API URL : https://cloud.activepieces.com/api ? Enter the API Key Source : Manually ? Enter the API Key : ap_1234567890abcdef1234567890abcdef [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/build-pieces/misc/publish-piece.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/build-pieces/misc/publish-piece) [Build Custom Pieces](https://www.activepieces.com/docs/build-pieces/misc/build-piece) [Custom Pieces CI/CD](https://www.activepieces.com/docs/build-pieces/misc/pieces-ci-cd) ⌘I --- # Custom Pieces CI/CD - Activepieces [Skip to main content](https://www.activepieces.com/docs/build-pieces/misc/pieces-ci-cd#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Misc Custom Pieces CI/CD [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [How It Works](https://www.activepieces.com/docs/build-pieces/misc/pieces-ci-cd#how-it-works) * [Usage](https://www.activepieces.com/docs/build-pieces/misc/pieces-ci-cd#usage) * [Developer Workflow](https://www.activepieces.com/docs/build-pieces/misc/pieces-ci-cd#developer-workflow) * [GitHub Action](https://www.activepieces.com/docs/build-pieces/misc/pieces-ci-cd#github-action) You can use the CLI to sync custom pieces. There is no need to rebuild the Docker image as they are loaded directly from npm. ### [​](https://www.activepieces.com/docs/build-pieces/misc/pieces-ci-cd#how-it-works) How It Works Use the CLI to sync items from `packages/pieces/custom/` to instances. In production, Activepieces acts as an npm registry, storing all piece versions. The CLI scans the directory for `package.json` files, checking the **name** and **version** of each piece. If a piece isn’t uploaded, it packages and uploads it via the API. ### [​](https://www.activepieces.com/docs/build-pieces/misc/pieces-ci-cd#usage) Usage To use the CLI, follow these steps: 1. Generate an API Key from the Admin Interface. Go to Settings and generate the API Key. 2. Install the CLI by cloning the repository. 3. Run the following command, replacing `API_KEY` with your generated API Key and `INSTANCE_URL` with your instance URL: AP_API_KEY=your_api_key_here bun run sync-pieces -- --apiUrl https://INSTANCE_URL/api ### [​](https://www.activepieces.com/docs/build-pieces/misc/pieces-ci-cd#developer-workflow) Developer Workflow 1. Developers create and modify the pieces offline. 2. Increment the piece version in their corresponding `package.json`. For more information, refer to the [piece versioning](https://www.activepieces.com/docs/build-pieces/piece-reference/piece-versioning) documentation. 3. Open a pull request towards the main branch. 4. Once the pull request is merged to the main branch, manually run the CLI or use a GitHub/GitLab Action to trigger the synchronization process. ### [​](https://www.activepieces.com/docs/build-pieces/misc/pieces-ci-cd#github-action) GitHub Action name: Sync Custom Pieces on: push: branches: - main workflow_dispatch: jobs: sync-pieces: runs-on: ubuntu-latest steps: # Step 1: Check out the repository code with full history - name: Check out repository code uses: actions/checkout@v3 with: fetch-depth: 0 # Step 2: Set up Bun - name: Set up Bun uses: oven-sh/setup-bun@v1 with: bun-version: latest # Step 3: Cache Bun dependencies - name: Cache Bun dependencies uses: actions/cache@v3 with: path: ~/.bun/install/cache key: bun-${{ hashFiles('bun.lockb') }} restore-keys: | bun- # Step 4: Install dependencies using Bun - name: Install dependencies run: bun install --no-save # Step 5: Sync Custom Pieces - name: Sync Custom Pieces env: AP_API_KEY: ${{ secrets.AP_API_KEY }} run: bun run sync-pieces -- --apiUrl ${{ secrets.INSTANCE_URL }}/api [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/build-pieces/misc/pieces-ci-cd.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/build-pieces/misc/pieces-ci-cd) [Publish Custom Pieces](https://www.activepieces.com/docs/build-pieces/misc/publish-piece) [Migrate from Nx to Turbo](https://www.activepieces.com/docs/build-pieces/misc/migrate-nx-to-turbo) ⌘I --- # Flow Control - Activepieces [Skip to main content](https://www.activepieces.com/docs/build-pieces/piece-reference/flow-control#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Piece Reference Flow Control [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Stop Flow](https://www.activepieces.com/docs/build-pieces/piece-reference/flow-control#stop-flow) * [Pause Flow and Wait for Webhook](https://www.activepieces.com/docs/build-pieces/piece-reference/flow-control#pause-flow-and-wait-for-webhook) * [Pause Flow and Delay](https://www.activepieces.com/docs/build-pieces/piece-reference/flow-control#pause-flow-and-delay) Flow Controls provide the ability to control the flow of execution from inside a piece. By using the `ctx` parameter in the `run` method of actions, you can perform various operations to control the flow. [​](https://www.activepieces.com/docs/build-pieces/piece-reference/flow-control#stop-flow) Stop Flow ------------------------------------------------------------------------------------------------------- You can stop the flow and provide a response to the webhook trigger. This can be useful when you want to terminate the execution of the piece and send a specific response back. **Example with Response:** context.run.stop({ response: { status: context.propsValue.status ?? StatusCodes.OK, body: context.propsValue.body, headers: (context.propsValue.headers as Record) ?? {}, }, }); **Example without Response:** context.run.stop(); [​](https://www.activepieces.com/docs/build-pieces/piece-reference/flow-control#pause-flow-and-wait-for-webhook) Pause Flow and Wait for Webhook --------------------------------------------------------------------------------------------------------------------------------------------------- You can pause flow and return HTTP response, also provide a callback to URL that you can call with certain payload and continue the flow. **Example:** ctx.run.pause({ pauseMetadata: { type: PauseType.WEBHOOK, response: { callbackUrl: context.generateResumeUrl({ queryParams: {}, }), }, }, }); [​](https://www.activepieces.com/docs/build-pieces/piece-reference/flow-control#pause-flow-and-delay) Pause Flow and Delay ----------------------------------------------------------------------------------------------------------------------------- You can pause or delay the flow until a specific timestamp. Currently, the only supported type of pause is a delay based on a future timestamp. **Example:** ctx.run.pause({ pauseMetadata: { type: PauseType.DELAY, resumeDateTime: futureTime.toUTCString() } }); These flow hooks give you control over the execution of the piece by allowing you to stop the flow or pause it until a certain condition is met. You can use these hooks to customize the behavior and flow of your actions. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/build-pieces/piece-reference/flow-control.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/build-pieces/piece-reference/flow-control) [Props Validation](https://www.activepieces.com/docs/build-pieces/piece-reference/properties-validation) [Persistent Storage](https://www.activepieces.com/docs/build-pieces/piece-reference/persistent-storage) ⌘I --- # Welcome - Activepieces [Skip to main content](https://www.activepieces.com/docs/overview/welcome#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Overview Welcome [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [🔥 Why Activepieces is Different:](https://www.activepieces.com/docs/overview/welcome#-why-activepieces-is-different) Learn Concepts -------------- Learn how to work with Activepieces Pieces ------ Browse available pieces Install ------- Learn how to install Activepieces Build pieces ------------ How to Build Pieces and Contribute [​](https://www.activepieces.com/docs/overview/welcome#-why-activepieces-is-different) 🔥 Why Activepieces is Different: =========================================================================================================================== * **💖 Loved by Everyone**: Intuitive interface and great experience for both technical and non-technical users with a quick learning curve. ![](https://mintcdn.com/activepieces/uHZ35vXyxX7goNO-/resources/templates.gif?s=076362bc114929ee518e20251d901b17) * **🌐 Open Ecosystem:** All pieces are open source and available on npmjs.com, **60% of the pieces are contributed by the community**. * **🛠️ Pieces are written in Typescript**: Pieces are npm packages in TypeScript, offering full customization with the best developer experience, including **hot reloading** for **local** piece development on your machine. 😎 ![](https://mintcdn.com/activepieces/ki8mFooo8mAmhMdP/resources/create-action.png?w=2500&fit=max&auto=format&n=ki8mFooo8mAmhMdP&q=85&s=fb6b48d36b7deb67a7ba801a6780a8b6) * **🤖 AI-Ready**: Native AI pieces and agents are built into Activepieces. Integrating AI into your flows is seamless and simple—experiment with popular providers, or quickly create custom agents using our easy-to-use AI SDK. * **🏢 Enterprise-Ready**: Developers set up the tools, and anyone in the organization can use the no-code builder. Full customization from branding to control. * **🔒 Secure by Design**: Self-hosted and network-gapped for maximum security and control over your data. * **🧠 Human in Loop**: Delay execution for a period of time or require approval. These are just pieces built on top of the piece framework, and you can build many pieces like that. 🎨 [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/overview/welcome.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/overview/welcome) [Building Flows](https://www.activepieces.com/docs/flows/building-flows) ⌘I --- # Enable Custom API Calls - Activepieces [Skip to main content](https://www.activepieces.com/docs/build-pieces/piece-reference/custom-api-calls#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Piece Reference Enable Custom API Calls [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Basic Example](https://www.activepieces.com/docs/build-pieces/piece-reference/custom-api-calls#basic-example) * [Dynamic Base URL and Basic Auth Example](https://www.activepieces.com/docs/build-pieces/piece-reference/custom-api-calls#dynamic-base-url-and-basic-auth-example) Custom API Calls allow the user to send a request to a specific endpoint if no action has been implemented for it. This will show in the actions list of the piece as `Custom API Call`, to enable this action for a piece, you need to call the `createCustomApiCallAction` in your actions array. [​](https://www.activepieces.com/docs/build-pieces/piece-reference/custom-api-calls#basic-example) Basic Example ------------------------------------------------------------------------------------------------------------------- The example below implements the action for the OpenAI piece. The OpenAI piece uses a `Bearer token` authorization header to identify the user sending the request. actions: [\ ...yourActions,\ createCustomApiCallAction({\ // The auth object defined in the piece\ auth: openaiAuth,\ // The base URL for the API\ baseUrl: () => {\ 'https://api.openai.com/v1'\ },\ // Mapping the auth object to the needed authorization headers\ authMapping: async (auth) => {\ return {\ 'Authorization': `Bearer ${auth}`\ }\ }\ })\ ] [​](https://www.activepieces.com/docs/build-pieces/piece-reference/custom-api-calls#dynamic-base-url-and-basic-auth-example) Dynamic Base URL and Basic Auth Example ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- The example below implements the action for the Jira Cloud piece. The Jira Cloud piece uses a dynamic base URL for it’s actions, where the base URL changes based on the values the user authenticated with. We will also implement a Basic authentication header. actions: [\ ...yourActions,\ createCustomApiCallAction({\ baseUrl: (auth) => {\ return `${(auth as JiraAuth).instanceUrl}/rest/api/3`\ },\ auth: jiraCloudAuth,\ authMapping: async (auth) => {\ const typedAuth = auth as JiraAuth\ return {\ 'Authorization': `Basic ${typedAuth.email}:${typedAuth.apiToken}`\ }\ }\ })\ ] [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/build-pieces/piece-reference/custom-api-calls.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/build-pieces/piece-reference/custom-api-calls) [Piece Examples](https://www.activepieces.com/docs/build-pieces/piece-reference/examples) [Piece i18n](https://www.activepieces.com/docs/build-pieces/piece-reference/i18n) ⌘I --- # Setup Private Fork - Activepieces [Skip to main content](https://www.activepieces.com/docs/build-pieces/misc/private-fork#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Misc Setup Private Fork [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Create a Private Fork (Private Pieces)](https://www.activepieces.com/docs/build-pieces/misc/private-fork#create-a-private-fork-private-pieces) * [Sync Your Fork](https://www.activepieces.com/docs/build-pieces/misc/private-fork#sync-your-fork) **Friendly Tip #1:** If you want to experiment, you can fork or clone the public repository. For private piece installation, you will need the paid edition. However, you can still develop pieces, contribute them back, **OR** publish them to the public npm registry and use them in your own instance or project. [​](https://www.activepieces.com/docs/build-pieces/misc/private-fork#create-a-private-fork-private-pieces) Create a Private Fork (Private Pieces) ---------------------------------------------------------------------------------------------------------------------------------------------------- By following these steps, you can create a private fork on GitHub, GitLab or another platform and configure the “activepieces” repository as the upstream source, allowing you to incorporate changes from the “activepieces” repository. 1. **Clone the Repository:** Begin by creating a bare clone of the repository. Remember that this is a temporary step and will be deleted later. git clone --bare [email protected]:activepieces/activepieces.git 2. **Create a Private Git Repository** Generate a new private repository on GitHub or your chosen platform. When initializing the new repository, do not include a README, license, or gitignore files. This precaution is essential to avoid merge conflicts when synchronizing your fork with the original repository. 3. **Mirror-Push to the Private Repository:** Mirror-push the bare clone you created earlier to your newly created “activepieces” repository. Make sure to replace `` in the URL below with your actual GitHub username. cd activepieces.git git push --mirror [email protected]:/activepieces.git 4. **Remove the Temporary Local Repository:** cd .. rm -rf activepieces.git 5. **Clone Your Private Repository:** Now, you can clone your “activepieces” repository onto your local machine into your desired directory. cd ~/path/to/directory git clone [email protected]:/activepieces.git 6. **Add the Original Repository as a Remote:** If desired, you can add the original repository as a remote to fetch potential future changes. However, remember to disable push operations for this remote, as you are not permitted to push changes to it. git remote add upstream [email protected]:activepieces/activepieces.git git remote set-url --push upstream DISABLE You can view a list of all your remotes using `git remote -v`. It should resemble the following: origin [email protected]:/activepieces.git (fetch) origin [email protected]:/activepieces.git (push) upstream [email protected]:activepieces/activepieces.git (fetch) upstream DISABLE (push) > When pushing changes, always use `git push origin`. ### [​](https://www.activepieces.com/docs/build-pieces/misc/private-fork#sync-your-fork) Sync Your Fork To retrieve changes from the “upstream” repository, fetch the remote and rebase your work on top of it. git fetch upstream git merge upstream/main Conflict resolution should not be necessary since you’ve only added pieces to your repository. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/build-pieces/misc/private-fork.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/build-pieces/misc/private-fork) [Migrate from Nx to Turbo](https://www.activepieces.com/docs/build-pieces/misc/migrate-nx-to-turbo) [Testing Pieces](https://www.activepieces.com/docs/build-pieces/misc/testing-pieces) ⌘I --- # Testing Pieces - Activepieces [Skip to main content](https://www.activepieces.com/docs/build-pieces/misc/testing-pieces#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Misc Testing Pieces [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Setup](https://www.activepieces.com/docs/build-pieces/misc/testing-pieces#setup) * [1\. Add vitest to your piece](https://www.activepieces.com/docs/build-pieces/misc/testing-pieces#1-add-vitest-to-your-piece) * [2\. Create a vitest config](https://www.activepieces.com/docs/build-pieces/misc/testing-pieces#2-create-a-vitest-config) * [3\. Write tests](https://www.activepieces.com/docs/build-pieces/misc/testing-pieces#3-write-tests) * [4\. Run tests](https://www.activepieces.com/docs/build-pieces/misc/testing-pieces#4-run-tests) Testing pieces is **optional** but recommended for complex logic. Pieces can be tested using [Vitest](https://vitest.dev/) with the `createMockActionContext` helper from the framework. For a full working example, see the [text-helper piece tests on GitHub](https://github.com/activepieces/activepieces/tree/main/packages/pieces/core/text-helper/test) . [​](https://www.activepieces.com/docs/build-pieces/misc/testing-pieces#setup) Setup -------------------------------------------------------------------------------------- ### [​](https://www.activepieces.com/docs/build-pieces/misc/testing-pieces#1-add-vitest-to-your-piece) 1\. Add vitest to your piece Add `vitest` as a dev dependency in your piece’s `package.json` and add a `test` script: { "scripts": { "build": "tsc -p tsconfig.lib.json && cp package.json dist/", "lint": "eslint 'src/**/*.ts'", "test": "vitest run" }, "devDependencies": { "vitest": "3.0.8" } } ### [​](https://www.activepieces.com/docs/build-pieces/misc/testing-pieces#2-create-a-vitest-config) 2\. Create a vitest config Create `vitest.config.ts` in your piece root: import path from 'path' import { defineConfig } from 'vitest/config' const repoRoot = path.resolve(__dirname, '../../../..') export default defineConfig({ test: { globals: true, environment: 'node', }, resolve: { alias: { '@activepieces/shared': path.resolve(repoRoot, 'packages/shared/src/index.ts'), '@activepieces/pieces-framework': path.resolve(repoRoot, 'packages/pieces/framework/src/index.ts'), '@activepieces/pieces-common': path.resolve(repoRoot, 'packages/pieces/common/src/index.ts'), }, }, }) ### [​](https://www.activepieces.com/docs/build-pieces/misc/testing-pieces#3-write-tests) 3\. Write tests Create a `test/` directory and add `.test.ts` files: import { createMockActionContext } from '@activepieces/pieces-framework'; import { myAction } from '../src/lib/actions/my-action'; describe('myAction', () => { test('does something', async () => { const ctx = createMockActionContext({ propsValue: { inputField: 'test value', }, }); const result = await myAction.run(ctx); expect(result).toBe('expected output'); }); }); ### [​](https://www.activepieces.com/docs/build-pieces/misc/testing-pieces#4-run-tests) 4\. Run tests # Run tests for a specific piece npx turbo test --filter=@activepieces/piece-text-helper # Run tests directly from the piece directory cd packages/pieces/core/text-helper npx vitest run [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/build-pieces/misc/testing-pieces.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/build-pieces/misc/testing-pieces) [Setup Private Fork](https://www.activepieces.com/docs/build-pieces/misc/private-fork) [Dev Containers](https://www.activepieces.com/docs/build-pieces/misc/dev-container) ⌘I --- # Files - Activepieces [Skip to main content](https://www.activepieces.com/docs/build-pieces/piece-reference/files#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Piece Reference Files [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Write](https://www.activepieces.com/docs/build-pieces/piece-reference/files#write) The `ctx.files` object allow you to store files in local storage or in a remote storage depending on the run environment. [​](https://www.activepieces.com/docs/build-pieces/piece-reference/files#write) Write ---------------------------------------------------------------------------------------- You can use the `write` method to write a file to the storage, It returns a string that can be used in other actions or triggers properties to reference the file. **Example:** const fileReference = await files.write({ fileName: 'file.txt', data: Buffer.from('text') }); This code will store the file in the database If the run environment is testing mode since it will be required to test other steps, other wise it will store it in the local temporary directory. For Reading the file If you are using the file property in a trigger or action, It will be automatically parsed and you can use it directly, please refer to `Property.File` in the [properties](https://www.activepieces.com/docs/build-pieces/piece-reference/properties#file) section. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/build-pieces/piece-reference/files.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/build-pieces/piece-reference/files) [Persistent Storage](https://www.activepieces.com/docs/build-pieces/piece-reference/persistent-storage) [External Libraries](https://www.activepieces.com/docs/build-pieces/piece-reference/external-libraries) ⌘I --- # Piece i18n - Activepieces [Skip to main content](https://www.activepieces.com/docs/build-pieces/piece-reference/i18n#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Piece Reference Piece i18n [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) 1 [](https://www.activepieces.com/docs/build-pieces/piece-reference/i18n#) Generate Run the following command to create a translation file with all the strings that need translation in your piece npm run cli pieces generate-translation-file PIECE_FOLDER_NAME 2 [](https://www.activepieces.com/docs/build-pieces/piece-reference/i18n#) Translate Make a copy of `packages/pieces///src/i18n/translation.json`, name it `.json` i.e fr.json and translate the values. For open source pieces, you can use the [Crowdin project](https://crowdin.com/project/activepieces) to translate to different languages. These translations will automatically sync back to your code. 3 [](https://www.activepieces.com/docs/build-pieces/piece-reference/i18n#) Test Locally After following the steps to [setup your development environment](https://www.activepieces.com/docs/build-pieces/building-pieces/development-setup) , click the small cog icon next to the logo in your dashboard and change the locale.![Locales](https://mintcdn.com/activepieces/ki8mFooo8mAmhMdP/resources/i18n-pieces.png?w=2500&fit=max&auto=format&n=ki8mFooo8mAmhMdP&q=85&s=81406211f34fd0ec06e761005fc759ca) In the builder your piece will now appear in the translated language:![French Webhooks](https://mintcdn.com/activepieces/ki8mFooo8mAmhMdP/resources/french-webhooks.png?w=2500&fit=max&auto=format&n=ki8mFooo8mAmhMdP&q=85&s=fcf11162f3e2554ff16e1e728cfb25f6) 4 [](https://www.activepieces.com/docs/build-pieces/piece-reference/i18n#) Publish Follow the docs here to [publish your piece](https://www.activepieces.com/docs/build-pieces/sharing-pieces/overview) [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/build-pieces/piece-reference/i18n.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/build-pieces/piece-reference/i18n) [Enable Custom API Calls](https://www.activepieces.com/docs/build-pieces/piece-reference/custom-api-calls) [Build Custom Pieces](https://www.activepieces.com/docs/build-pieces/misc/build-piece) ⌘I --- # Piece Versioning - Activepieces [Skip to main content](https://www.activepieces.com/docs/build-pieces/piece-reference/piece-versioning#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Piece Reference Piece Versioning [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Semantic Versioning](https://www.activepieces.com/docs/build-pieces/piece-reference/piece-versioning#semantic-versioning) * [Engine](https://www.activepieces.com/docs/build-pieces/piece-reference/piece-versioning#engine) * [Examples](https://www.activepieces.com/docs/build-pieces/piece-reference/piece-versioning#examples) * [Breaking changes](https://www.activepieces.com/docs/build-pieces/piece-reference/piece-versioning#breaking-changes) * [Non-breaking changes](https://www.activepieces.com/docs/build-pieces/piece-reference/piece-versioning#non-breaking-changes) Pieces are npm packages and follows **semantic versioning**. [​](https://www.activepieces.com/docs/build-pieces/piece-reference/piece-versioning#semantic-versioning) Semantic Versioning ------------------------------------------------------------------------------------------------------------------------------- The version number consists of three numbers: `MAJOR.MINOR.PATCH`, where: * **MAJOR** It should be incremented when there are breaking changes to the piece. * **MINOR** It should be incremented for new features or functionality that is compatible with the previous version, unless the major version is less than 1.0, in which case it can be a breaking change. * **PATCH** It should be incremented for bug fixes and small changes that do not introduce new features or break backward compatibility. [​](https://www.activepieces.com/docs/build-pieces/piece-reference/piece-versioning#engine) Engine ----------------------------------------------------------------------------------------------------- The engine will use the most up-to-date compatible version for a given piece version during the **DRAFT** flow versions. Once the flow is published, all pieces will be locked to a specific version. **Case 1: Piece Version is Less Than 1.0**: The engine will select the latest **patch** version that shares the same **minor** version number. **Case 2: Piece Version Reaches Version 1.0**: The engine will select the latest **minor** version that shares the same **major** version number. [​](https://www.activepieces.com/docs/build-pieces/piece-reference/piece-versioning#examples) Examples --------------------------------------------------------------------------------------------------------- when you make a change, remember to increment the version accordingly. ### [​](https://www.activepieces.com/docs/build-pieces/piece-reference/piece-versioning#breaking-changes) Breaking changes * Remove an existing action. * Add a required `action` prop. * Remove an existing action prop, whether required or optional. * Remove an attribute from an action output. * Change the existing behavior of an action/trigger. ### [​](https://www.activepieces.com/docs/build-pieces/piece-reference/piece-versioning#non-breaking-changes) Non-breaking changes * Add a new action. * Add an optional `action` prop. * Add an attribute to an action output. i.e., any removal is breaking, any required addition is breaking, everything else is not breaking. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/build-pieces/piece-reference/piece-versioning.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/build-pieces/piece-reference/piece-versioning) [External Libraries](https://www.activepieces.com/docs/build-pieces/piece-reference/external-libraries) [Piece Examples](https://www.activepieces.com/docs/build-pieces/piece-reference/examples) ⌘I --- # Persistent Storage - Activepieces [Skip to main content](https://www.activepieces.com/docs/build-pieces/piece-reference/persistent-storage#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Piece Reference Persistent Storage [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Put](https://www.activepieces.com/docs/build-pieces/piece-reference/persistent-storage#put) * [Get](https://www.activepieces.com/docs/build-pieces/piece-reference/persistent-storage#get) * [Delete](https://www.activepieces.com/docs/build-pieces/piece-reference/persistent-storage#delete) The `ctx` parameter inside triggers and actions provides a simple key/value storage mechanism. The storage is persistent, meaning that the stored values are retained even after the execution of the piece. By default, the storage operates at the flow level, but it can also be configured to store values at the project level. The storage scope is completely isolated. If a key is stored in a different scope, it will not be fetched when requested in different scope. [​](https://www.activepieces.com/docs/build-pieces/piece-reference/persistent-storage#put) Put ------------------------------------------------------------------------------------------------- You can store a value with a specified key in the storage. **Example:** ctx.store.put('KEY', 'VALUE', StoreScope.PROJECT); [​](https://www.activepieces.com/docs/build-pieces/piece-reference/persistent-storage#get) Get ------------------------------------------------------------------------------------------------- You can retrieve the value associated with a specific key from the storage. **Example:** const value = ctx.store.get('KEY', StoreScope.PROJECT); [​](https://www.activepieces.com/docs/build-pieces/piece-reference/persistent-storage#delete) Delete ------------------------------------------------------------------------------------------------------- You can delete a key-value pair from the storage. **Example:** ctx.store.delete('KEY', StoreScope.PROJECT); These storage operations allow you to store, retrieve, and delete key-value pairs in the persistent storage. You can use this storage mechanism to store and retrieve data as needed within your triggers and actions. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/build-pieces/piece-reference/persistent-storage.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/build-pieces/piece-reference/persistent-storage) [Flow Control](https://www.activepieces.com/docs/build-pieces/piece-reference/flow-control) [Files](https://www.activepieces.com/docs/build-pieces/piece-reference/files) ⌘I --- # Create Action - Activepieces [Skip to main content](https://www.activepieces.com/docs/build-pieces/building-pieces/create-action#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Build a Piece Create Action [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Action Definition](https://www.activepieces.com/docs/build-pieces/building-pieces/create-action#action-definition) * [Expose The Definition](https://www.activepieces.com/docs/build-pieces/building-pieces/create-action#expose-the-definition) * [Testing](https://www.activepieces.com/docs/build-pieces/building-pieces/create-action#testing) [​](https://www.activepieces.com/docs/build-pieces/building-pieces/create-action#action-definition) Action Definition ------------------------------------------------------------------------------------------------------------------------ Now let’s create first action which fetch random ice-cream flavor. npm run cli actions create You will be asked three questions to define your new piece: 1. `Piece Folder Name`: This is the name associated with the folder where the action resides. It helps organize and categorize actions within the piece. 2. `Action Display Name`: The name users see in the interface, conveying the action’s purpose clearly. 3. `Action Description`: A brief, informative text in the UI, guiding users about the action’s function and purpose. Next, let’s create the action file: **Example:** npm run cli actions create ? Enter the piece folder name : gelato ? Enter the action display name : get icecream flavor ? Enter the action description : fetches random icecream flavor. This will create a new TypeScript file named `get-icecream-flavor.ts` in the `packages/pieces/community/gelato/src/lib/actions` directory. Inside this file, paste the following code: import { createAction, Property, PieceAuth, } from '@activepieces/pieces-framework'; import { httpClient, HttpMethod } from '@activepieces/pieces-common'; import { gelatoAuth } from '../..'; export const getIcecreamFlavor = createAction({ name: 'get_icecream_flavor', // Must be a unique across the piece, this shouldn't be changed. auth: gelatoAuth, displayName: 'Get Icecream Flavor', description: 'Fetches random icecream flavor', props: {}, async run(context) { const res = await httpClient.sendRequest({ method: HttpMethod.GET, url: 'https://cloud.activepieces.com/api/v1/webhooks/RGjv57ex3RAHOgs0YK6Ja/sync', headers: { Authorization: context.auth, // Pass API key in headers }, }); return res.body; }, }); The createAction function takes an object with several properties, including the `name`, `displayName`, `description`, `props`, and `run` function of the action. The `name` property is a unique identifier for the action. The `displayName` and `description` properties are used to provide a human-readable name and description for the action. The `props` property is an object that defines the properties that the action requires from the user. In this case, the action doesn’t require any properties. The `run` function is the function that is called when the action is executed. It takes a single argument, context, which contains the values of the action’s properties. The `run` function utilizes the httpClient.sendRequest function to make a GET request, fetching a random ice cream flavor. It incorporates API key authentication in the request headers. Finally, it returns the response body. [​](https://www.activepieces.com/docs/build-pieces/building-pieces/create-action#expose-the-definition) Expose The Definition -------------------------------------------------------------------------------------------------------------------------------- To make the action readable by Activepieces, add it to the array of actions in the piece definition. import { createPiece } from '@activepieces/pieces-framework'; // Don't forget to add the following import. import { getIcecreamFlavor } from './lib/actions/get-icecream-flavor'; export const gelato = createPiece({ displayName: 'Gelato', logoUrl: 'https://cdn.activepieces.com/pieces/gelato.png', authors: [], auth: gelatoAuth, // Add the action here. actions: [getIcecreamFlavor], // <-------- triggers: [], }); [​](https://www.activepieces.com/docs/build-pieces/building-pieces/create-action#testing) Testing ==================================================================================================== By default, the development setup only builds specific components. Open the file `.env.dev` and include “gelato” in the `AP_DEV_PIECES`. For more details, check out the [Piece Development](https://www.activepieces.com/docs/build-pieces/building-pieces/development-setup#pieces-development) section. Once you edit the environment variable, restart the backend. The piece will be rebuilt. After this process, you’ll need to **refresh** the frontend to see the changes. If the build fails, try debugging by running `npx turbo run build --filter=@activepieces/piece-gelato`. It will display any errors in your code. To test the action, use the flow builder in Activepieces. It should function as shown in the screenshot. ![Gelato Action](https://mintcdn.com/activepieces/uHZ35vXyxX7goNO-/resources/screenshots/gelato-action.png?w=2500&fit=max&auto=format&n=uHZ35vXyxX7goNO-&q=85&s=799c7211ce7bdc240960f0e15c1ac76c) [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/build-pieces/building-pieces/create-action.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/build-pieces/building-pieces/create-action) [Add Piece Authentication](https://www.activepieces.com/docs/build-pieces/building-pieces/piece-authentication) [Create Trigger](https://www.activepieces.com/docs/build-pieces/building-pieces/create-trigger) ⌘I --- # Props Validation - Activepieces [Skip to main content](https://www.activepieces.com/docs/build-pieces/piece-reference/properties-validation#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Piece Reference Props Validation [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) Activepieces uses Zod for runtime validation of piece properties. Zod provides a powerful schema validation system that helps ensure your piece receives valid inputs. To use Zod validation in your piece, first import the validation helper and Zod: Please make sure the `minimumSupportedRelease` is set to at least `0.36.1` for the validation to work. import { createAction, Property } from '@activepieces/pieces-framework'; import { propsValidation } from '@activepieces/pieces-common'; import { z } from 'zod'; export const getIcecreamFlavor = createAction({ name: 'get_icecream_flavor', // Unique name for the action. displayName: 'Get Ice Cream Flavor', description: 'Fetches a random ice cream flavor based on user preferences.', props: { sweetnessLevel: Property.Number({ displayName: 'Sweetness Level', required: true, description: 'Specify the sweetness level (0 to 10).', }), includeToppings: Property.Checkbox({ displayName: 'Include Toppings', required: false, description: 'Should the flavor include toppings?', defaultValue: true, }), numberOfFlavors: Property.Number({ displayName: 'Number of Flavors', required: true, description: 'How many flavors do you want to fetch? (1-5)', defaultValue: 1, }), }, async run({ propsValue }) { // Validate the input properties using Zod await propsValidation.validateZod(propsValue, { sweetnessLevel: z.number().min(0).max(10, 'Sweetness level must be between 0 and 10.'), numberOfFlavors: z.number().min(1).max(5, 'You can fetch between 1 and 5 flavors.'), }); // Action logic const sweetnessLevel = propsValue.sweetnessLevel; const includeToppings = propsValue.includeToppings ?? true; // Default to true const numberOfFlavors = propsValue.numberOfFlavors; // Simulate fetching random ice cream flavors const allFlavors = [\ 'Vanilla',\ 'Chocolate',\ 'Strawberry',\ 'Mint',\ 'Cookie Dough',\ 'Pistachio',\ 'Mango',\ 'Coffee',\ 'Salted Caramel',\ 'Blackberry',\ ]; const selectedFlavors = allFlavors.slice(0, numberOfFlavors); return { message: `Here are your ${numberOfFlavors} flavors: ${selectedFlavors.join(', ')}`, sweetnessLevel: sweetnessLevel, includeToppings: includeToppings, }; }, }); [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/build-pieces/piece-reference/properties-validation.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/build-pieces/piece-reference/properties-validation) [Props](https://www.activepieces.com/docs/build-pieces/piece-reference/properties) [Flow Control](https://www.activepieces.com/docs/build-pieces/piece-reference/flow-control) ⌘I --- # MCP Server - Activepieces [Skip to main content](https://www.activepieces.com/docs/mcp/overview#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation MCP Server MCP Server [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [What is MCP?](https://www.activepieces.com/docs/mcp/overview#what-is-mcp) * [Enable the MCP Server](https://www.activepieces.com/docs/mcp/overview#enable-the-mcp-server) * [Connect Your AI Assistant](https://www.activepieces.com/docs/mcp/overview#connect-your-ai-assistant) * [Claude Desktop](https://www.activepieces.com/docs/mcp/overview#claude-desktop) * [Cursor / Other MCP Clients](https://www.activepieces.com/docs/mcp/overview#cursor-%2F-other-mcp-clients) * [Tool Categories](https://www.activepieces.com/docs/mcp/overview#tool-categories) * [Security](https://www.activepieces.com/docs/mcp/overview#security) Activepieces includes a built-in MCP server that allows AI assistants (Claude, GPT, etc.) to interact with your automation platform. AI agents can build flows, manage tables, test automations, and more — all through natural language. [​](https://www.activepieces.com/docs/mcp/overview#what-is-mcp) What is MCP? ------------------------------------------------------------------------------- The [Model Context Protocol](https://modelcontextprotocol.io/) is an open standard that lets AI assistants connect to external tools and data sources. Activepieces implements an MCP server that exposes 30 tools for managing your automation workflows. [​](https://www.activepieces.com/docs/mcp/overview#enable-the-mcp-server) Enable the MCP Server -------------------------------------------------------------------------------------------------- 1. Go to **Settings** → **MCP Server** 2. Toggle the server **on** 3. Copy the **server URL** and **token** [​](https://www.activepieces.com/docs/mcp/overview#connect-your-ai-assistant) Connect Your AI Assistant ---------------------------------------------------------------------------------------------------------- The MCP server uses the **Streamable HTTP** transport. Configure your AI client with: * **URL**: `https://your-instance.com/api/v1/projects/{projectId}/mcp-server/http` * **Authentication**: Bearer token (or `?token=` query parameter) The token can be rotated at any time from the MCP Server settings page. ### [​](https://www.activepieces.com/docs/mcp/overview#claude-desktop) Claude Desktop Add this to your Claude Desktop config (`claude_desktop_config.json`): { "mcpServers": { "activepieces": { "url": "https://your-instance.com/api/v1/projects/{projectId}/mcp-server/http?token={your-token}" } } } ### [​](https://www.activepieces.com/docs/mcp/overview#cursor-/-other-mcp-clients) Cursor / Other MCP Clients Use the Streamable HTTP URL with your token as a Bearer token in the Authorization header. [​](https://www.activepieces.com/docs/mcp/overview#tool-categories) Tool Categories -------------------------------------------------------------------------------------- Tools are organized into categories. **Discovery tools** are always available. Other categories can be enabled or disabled per-project in the MCP Server settings. | Category | Tools | Description | | --- | --- | --- | | [Discovery](https://www.activepieces.com/docs/mcp/overview#discovery) | 10 | Read-only tools for exploring flows, pieces, tables, runs, and AI models | | [Flow Management](https://www.activepieces.com/docs/mcp/overview#flow-management) | 4 | Create, rename, publish, and enable/disable flows | | [Flow Building](https://www.activepieces.com/docs/mcp/overview#flow-building) | 4 | Add, update, and delete steps and triggers | | [Router & Branching](https://www.activepieces.com/docs/mcp/overview#router-branching) | 2 | Add and delete conditional branches | | [Annotations](https://www.activepieces.com/docs/mcp/overview#annotations) | 1 | Manage canvas notes | | [Tables](https://www.activepieces.com/docs/mcp/overview#tables) | 6 | Full CRUD for tables, fields, and records | | [Testing & Runs](https://www.activepieces.com/docs/mcp/overview#testing-runs) | 3 | Test flows, inspect results, retry failures | See the [Tools Reference](https://www.activepieces.com/docs/mcp/tools) for the complete catalog with input schemas and examples. [​](https://www.activepieces.com/docs/mcp/overview#security) Security ------------------------------------------------------------------------ * **Credentials are never exposed** — connection secrets, API keys, and OAuth tokens are never returned by any MCP tool * **Project-scoped** — all operations are scoped to the authenticated project * **Sensitive setup** — the `ap_setup_guide` tool returns instructions for the user to configure connections and AI providers in the UI, rather than handling secrets through MCP * **Token rotation** — the MCP token can be rotated at any time without affecting existing connections or flows [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/mcp/overview.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/mcp/overview) [Technical Limits](https://www.activepieces.com/docs/flows/known-limits) [Tools Reference](https://www.activepieces.com/docs/mcp/tools) ⌘I --- # Create Trigger - Activepieces [Skip to main content](https://www.activepieces.com/docs/build-pieces/building-pieces/create-trigger#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Build a Piece Create Trigger [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Trigger Definition](https://www.activepieces.com/docs/build-pieces/building-pieces/create-trigger#trigger-definition) * [Expose The Definition](https://www.activepieces.com/docs/build-pieces/building-pieces/create-trigger#expose-the-definition) * [Testing](https://www.activepieces.com/docs/build-pieces/building-pieces/create-trigger#testing) This tutorial will guide you through the process of creating trigger for a Gelato piece that fetches new icecream flavor. [​](https://www.activepieces.com/docs/build-pieces/building-pieces/create-trigger#trigger-definition) Trigger Definition --------------------------------------------------------------------------------------------------------------------------- To create trigger run the following command, npm run cli triggers create 1. `Piece Folder Name`: This is the name associated with the folder where the trigger resides. It helps organize and categorize triggers within the piece. 2. `Trigger Display Name`: The name users see in the interface, conveying the trigger’s purpose clearly. 3. `Trigger Description`: A brief, informative text in the UI, guiding users about the trigger’s function and purpose. 4. `Trigger Technique`: Specifies the trigger type - either [polling](https://www.activepieces.com/docs/build-pieces/piece-reference/triggers/polling-trigger) or [webhook](https://www.activepieces.com/docs/build-pieces/piece-reference/triggers/webhook-trigger) . **Example:** npm run cli triggers create ? Enter the piece folder name : gelato ? Enter the trigger display name : new flavor created ? Enter the trigger description : triggers when a new icecream flavor is created. ? Select the trigger technique: polling This will create a new TypeScript file at `packages/pieces/community/gelato/src/lib/triggers` named `new-flavor-created.ts`. Inside this file, paste the following code: import { gelatoAuth } from '../../'; import { DedupeStrategy, HttpMethod, HttpRequest, Polling, httpClient, pollingHelper, } from '@activepieces/pieces-common'; import { TriggerStrategy, createTrigger, AppConnectionValueForAuthProperty } from '@activepieces/pieces-framework'; import dayjs from 'dayjs'; const polling: Polling< AppConnectionValueForAuthProperty, Record > = { strategy: DedupeStrategy.TIMEBASED, items: async ({ auth, propsValue, lastFetchEpochMS }) => { const request: HttpRequest = { method: HttpMethod.GET, url: 'https://cloud.activepieces.com/api/v1/webhooks/aHlEaNLc6vcF1nY2XJ2ed/sync', headers: { authorization: auth, }, }; const res = await httpClient.sendRequest(request); return res.body['flavors'].map((flavor: string) => ({ epochMilliSeconds: dayjs().valueOf(), data: flavor, })); }, }; export const newFlavorCreated = createTrigger({ auth: gelatoAuth, name: 'newFlavorCreated', displayName: 'new flavor created', description: 'triggers when a new icecream flavor is created.', props: {}, sampleData: {}, type: TriggerStrategy.POLLING, async test(context) { return await pollingHelper.test(polling, context); }, async onEnable(context) { const { store, auth, propsValue } = context; await pollingHelper.onEnable(polling, { store, auth, propsValue }); }, async onDisable(context) { const { store, auth, propsValue } = context; await pollingHelper.onDisable(polling, { store, auth, propsValue }); }, async run(context) { return await pollingHelper.poll(polling, context); }, }); The way polling triggers usually work is as follows: `Run`:The run method executes every 5 minutes, fetching data from the endpoint within a specified timestamp range or continuing until it identifies the last item ID. It then returns the new items as an array. In this example, the httpClient.sendRequest method is utilized to retrieve new flavors, which are subsequently stored in the store along with a timestamp. [​](https://www.activepieces.com/docs/build-pieces/building-pieces/create-trigger#expose-the-definition) Expose The Definition --------------------------------------------------------------------------------------------------------------------------------- To make the trigger readable by Activepieces, add it to the array of triggers in the piece definition. import { createPiece } from '@activepieces/pieces-framework'; import { getIcecreamFlavor } from './lib/actions/get-icecream-flavor'; // Don't forget to add the following import. import { newFlavorCreated } from './lib/triggers/new-flavor-created'; export const gelato = createPiece({ displayName: 'Gelato Tutorial', logoUrl: 'https://cdn.activepieces.com/pieces/gelato.png', authors: [], auth: gelatoAuth, actions: [getIcecreamFlavor], // Add the trigger here. triggers: [newFlavorCreated], // <-------- }); [​](https://www.activepieces.com/docs/build-pieces/building-pieces/create-trigger#testing) Testing ===================================================================================================== By default, the development setup only builds specific components. Open the file `.env.dev` and include “gelato” in the `AP_DEV_PIECES`. For more details, check out the [Piece Development](https://www.activepieces.com/docs/build-pieces/building-pieces/development-setup#pieces-development) section. Once you edit the environment variable, restart the backend. The piece will be rebuilt. After this process, you’ll need to **refresh** the frontend to see the changes. To test the trigger, use the load sample data from flow builder in Activepieces. It should function as shown in the screenshot. To make your webhook accessible from the internet, you need to expose your local development instance to the internet, do the following: 1. Install [localxpose](https://localxpose.io/docs#start-your-first-tunnel) . 2. Follow the documentation to start your first tunnel to localhost:4200. 3. Copy the tunnel domain, i.e wozcsvaint.loclx.io, and replace the `AP_FRONTEND_URL` environment variable in `.env.dev` with the exposed url, i.e [https://wozcsvaint.loclx.io](https://wozcsvaint.loclx.io/) 4. Go to /packages/web/vite.config.ts, uncomment allowedHosts and replace the value with the same tunnel domain, i.e wozcsvaint.loclx.io. Once you have completed these configurations, you will be able to test webhook triggers and run published flows that have them. ![Gelato Action](https://mintcdn.com/activepieces/uHZ35vXyxX7goNO-/resources/screenshots/gelato-trigger.png?w=2500&fit=max&auto=format&n=uHZ35vXyxX7goNO-&q=85&s=2dc1a6a4beb5fc1b80c80cda0c544ebc) [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/build-pieces/building-pieces/create-trigger.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/build-pieces/building-pieces/create-trigger) [Create Action](https://www.activepieces.com/docs/build-pieces/building-pieces/create-action) [Overview](https://www.activepieces.com/docs/build-pieces/sharing-pieces/overview) ⌘I --- # Webhook Trigger - Activepieces [Skip to main content](https://www.activepieces.com/docs/build-pieces/piece-reference/triggers/webhook-trigger#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Triggers Webhook Trigger [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) The way webhook triggers usually work is as follows: **On Enable:** Use `context.webhookUrl` to perform an HTTP request to register the webhook in a third-party app, and store the webhook Id in the `store`. **On Handshake:** Some services require a successful handshake request usually consisting of some challenge. It works similar to a normal run except that you return the correct challenge response. This is optional and in order to enable the handshake you need to configure one of the available handshake strategies in the `handshakeConfiguration` option. **Run:** You can find the HTTP body inside `context.payload.body`. If needed, alter the body; otherwise, return an array with a single item `context.payload.body`. **Disable:** Using the `context.store`, fetch the webhook ID from the enable step and delete the webhook on the third-party app. **Testing:** You cannot test it with Test Flow, as it uses static sample data provided in the piece. To test the trigger, publish the flow, perform the event. Then check the flow runs from the main dashboard. **Examples:** * [New Form Submission on Typeform](https://github.com/activepieces/activepieces/blob/main/packages/pieces/community/typeform/src/lib/trigger/new-submission.ts) To make your webhook accessible from the internet, you need to expose your local development instance to the internet, do the following: 1. Install [localxpose](https://localxpose.io/docs#start-your-first-tunnel) . 2. Follow the documentation to start your first tunnel to localhost:4200. 3. Copy the tunnel domain, i.e wozcsvaint.loclx.io, and replace the `AP_FRONTEND_URL` environment variable in `.env.dev` with the exposed url, i.e [https://wozcsvaint.loclx.io](https://wozcsvaint.loclx.io/) 4. Go to /packages/web/vite.config.ts, uncomment allowedHosts and replace the value with the same tunnel domain, i.e wozcsvaint.loclx.io. Once you have completed these configurations, you will be able to test webhook triggers and run published flows that have them. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/build-pieces/piece-reference/triggers/webhook-trigger.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/build-pieces/piece-reference/triggers/webhook-trigger) [Polling Trigger](https://www.activepieces.com/docs/build-pieces/piece-reference/triggers/polling-trigger) [Props](https://www.activepieces.com/docs/build-pieces/piece-reference/properties) ⌘I --- # Hardware Requirements - Activepieces [Skip to main content](https://www.activepieces.com/docs/install/configuration/hardware#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Configuration Hardware Requirements [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Technical Specifications](https://www.activepieces.com/docs/install/configuration/hardware#technical-specifications) * [Scaling Factors](https://www.activepieces.com/docs/install/configuration/hardware#scaling-factors) * [Redis](https://www.activepieces.com/docs/install/configuration/hardware#redis) * [PostgreSQL](https://www.activepieces.com/docs/install/configuration/hardware#postgresql) * [App Container](https://www.activepieces.com/docs/install/configuration/hardware#app-container) * [Worker Container](https://www.activepieces.com/docs/install/configuration/hardware#worker-container) * [Expected Performance](https://www.activepieces.com/docs/install/configuration/hardware#expected-performance) More information about architecture please visit our [architecture](https://www.activepieces.com/docs/install/architecture/overview) page. ### [​](https://www.activepieces.com/docs/install/configuration/hardware#technical-specifications) Technical Specifications Activepieces is designed to be memory-intensive rather than CPU-intensive. A modest instance will suffice for most scenarios, but requirements can vary based on specific use cases. | Component | Memory (RAM) | CPU Cores | Disk Space | Notes | | --- | --- | --- | --- | --- | | PostgreSQL | 1 GB | 1 | — | | | Redis | 1 GB | 1 | — | | | App | 2 GB | 1 | 30 GB | API server, UI, webhook routing | | Worker | 1 GB | 0.5 | — | Per replica; add replicas to scale | The above recommendations are designed to meet the needs of the majority of use cases. [​](https://www.activepieces.com/docs/install/configuration/hardware#scaling-factors) Scaling Factors -------------------------------------------------------------------------------------------------------- ### [​](https://www.activepieces.com/docs/install/configuration/hardware#redis) Redis Redis requires minimal scaling as it primarily stores jobs during processing. Activepieces leverages BullMQ, capable of handling a substantial number of jobs per second. ### [​](https://www.activepieces.com/docs/install/configuration/hardware#postgresql) PostgreSQL **Scaling Tip:** Since files are stored in the database, you can alleviate the load by configuring S3 storage for file management. PostgreSQL is typically not the system’s bottleneck. ### [​](https://www.activepieces.com/docs/install/configuration/hardware#app-container) App Container **Scaling Tip:** The App container is stateless, allowing for seamless horizontal scaling. ### [​](https://www.activepieces.com/docs/install/configuration/hardware#worker-container) Worker Container **Scaling Tip:** Workers are stateless. Add more worker replicas to increase concurrent flow execution capacity. The default Docker Compose setup starts 5 replicas. [​](https://www.activepieces.com/docs/install/configuration/hardware#expected-performance) Expected Performance ------------------------------------------------------------------------------------------------------------------ Activepieces ensures no request is lost; all requests are queued. In the event of a spike, requests will be processed later, which is acceptable as most flows are asynchronous, with synchronous flows being prioritized. It’s hard to predict exact performance because flows can be very different. But running a flow doesn’t slow things down, as it runs as fast as regular JavaScript. (Note: This applies to `SANDBOX_CODE_ONLY` and `UNSANDBOXED` execution modes, which are recommended and used in self-hosted setups.) You can anticipate handling over **20 million executions** monthly with this setup. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/install/configuration/hardware.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/install/configuration/hardware) [Environment Variables](https://www.activepieces.com/docs/install/configuration/environment-variables) [Breaking Changes](https://www.activepieces.com/docs/install/configuration/breaking-changes) ⌘I --- # Contribute - Activepieces [Skip to main content](https://www.activepieces.com/docs/build-pieces/sharing-pieces/contribute#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Sharing Pieces Contribute [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) 1 [](https://www.activepieces.com/docs/build-pieces/sharing-pieces/contribute#) Open a pull request * Build and test your piece. * Open a pull request from your repository to the main fork. * A maintainer will review your work closely. 2 [](https://www.activepieces.com/docs/build-pieces/sharing-pieces/contribute#) Merge the pull request * Once the pull request is approved, it will be merged into the main branch. * Your piece will be available within a few minutes. * An automatic GitHub action will package it and create an npm package on npmjs.com. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/build-pieces/sharing-pieces/contribute.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/build-pieces/sharing-pieces/contribute) [Overview](https://www.activepieces.com/docs/build-pieces/sharing-pieces/overview) [Community (Public NPM)](https://www.activepieces.com/docs/build-pieces/sharing-pieces/community) ⌘I --- # Overview - Activepieces [Skip to main content](https://www.activepieces.com/docs/install/architecture/overview#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Architecture Overview [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Components](https://www.activepieces.com/docs/install/architecture/overview#components) * [Reliability & Scalability](https://www.activepieces.com/docs/install/architecture/overview#reliability-%26-scalability) * [Repository Structure](https://www.activepieces.com/docs/install/architecture/overview#repository-structure) This page focuses on describing the main components of Activepieces and focus mainly on workflow executions. [​](https://www.activepieces.com/docs/install/architecture/overview#components) Components --------------------------------------------------------------------------------------------- ![Architecture](https://mintcdn.com/activepieces/XedTyUW4g-TEWLtM/resources/architecture.png?w=2500&fit=max&auto=format&n=XedTyUW4g-TEWLtM&q=85&s=cb97bc253cee8444a1c73e6faed2815d) **Activepieces:** * **App**: The main application that organizes everything from APIs to scheduled jobs. * **Worker**: Polls for new jobs, allocates a sandbox from the pool, executes the flows with the engine inside the sandbox, and sends results back to the app. * **Sandbox**: An isolated execution environment that manages process lifecycle, resource limits, and communication with the engine via WebSocket. * **Engine**: TypeScript code that parses flow JSON and executes it. It is compiled into a single JS file and runs inside the sandbox. * **UI**: Frontend written in React. **Third Party**: * **Postgres**: The main database for Activepieces. * **Redis**: This is used to power the queue using [BullMQ](https://docs.bullmq.io/) . [​](https://www.activepieces.com/docs/install/architecture/overview#reliability-&-scalability) Reliability & Scalability --------------------------------------------------------------------------------------------------------------------------- Postgres and Redis availability is outside the scope of this documentation, as many cloud providers already implement best practices to ensure their availability. * **Webhooks**: All webhooks are sent to the Activepieces app, which performs basic validation and adds them to the queue. In case of a spike, webhooks will be added to the queue. * **Polling Trigger**: All recurring jobs are added to Redis. In case of a failure, the missed jobs will be executed again. * **Flow Execution**: Workers poll jobs from the queue. In the event of a spike, the flow execution will still work but may be delayed depending on the size of the spike. To scale Activepieces, you typically need to increase the replicas of either workers, the app, or the Postgres database. A small Redis instance is sufficient as it can handle thousands of jobs per second and rarely acts as a bottleneck. [​](https://www.activepieces.com/docs/install/architecture/overview#repository-structure) Repository Structure ----------------------------------------------------------------------------------------------------------------- The repository is structured as a monorepo using Turbo, with TypeScript as the primary language. It is divided into several packages: . ├── packages │ ├── web │ ├── server │ │ ├── api │ │ ├── worker │ │ ├── engine │ │ ├── sandbox │ │ └── common │ ├── ee │ ├── pieces │ └── shared * `web`: This package contains the user interface, implemented using the React framework. * `api`: This package contains the main application written in TypeScript with the Fastify framework. * `worker`: This package contains the logic of accepting flow jobs and executing them using the engine. * `server-sandbox`: This package contains the sandbox execution environment, including process isolation, pool management, and WebSocket communication between the worker and engine. * `common`: This package contains the shared logic between worker and app. * `engine`: This package contains the logic for flow execution within the sandbox. Located under `server/engine`. * `pieces`: This package contains the implementation of triggers and actions for third-party apps. * `shared`: This package contains shared data models and helper functions used by the other packages. * `ee`: This package contains features that are only available in the paid edition. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/install/architecture/overview.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/install/architecture/overview) [Websocket Issues](https://www.activepieces.com/docs/install/troubleshooting/websocket-issues) [Workers & Sandboxing](https://www.activepieces.com/docs/install/architecture/workers) ⌘I --- # Overview - Activepieces [Skip to main content](https://www.activepieces.com/docs/build-pieces/sharing-pieces/overview#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Sharing Pieces Overview [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Methods](https://www.activepieces.com/docs/build-pieces/sharing-pieces/overview#methods) [​](https://www.activepieces.com/docs/build-pieces/sharing-pieces/overview#methods) Methods ---------------------------------------------------------------------------------------------- * [Contribute Back](https://www.activepieces.com/docs/build-pieces/sharing-pieces/contribute) : Publish your piece by contributing back your piece to main repository. * [Community](https://www.activepieces.com/docs/build-pieces/sharing-pieces/community) : Publish your piece on npm directly and share it with the community. * [Private](https://www.activepieces.com/docs/build-pieces/sharing-pieces/private) : Publish your piece on activepieces privately. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/build-pieces/sharing-pieces/overview.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/build-pieces/sharing-pieces/overview) [Create Trigger](https://www.activepieces.com/docs/build-pieces/building-pieces/create-trigger) [Contribute](https://www.activepieces.com/docs/build-pieces/sharing-pieces/contribute) ⌘I --- # Telemetry - Activepieces [Skip to main content](https://www.activepieces.com/docs/install/configuration/telemetry#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Configuration Telemetry [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Why Does Activepieces need data?](https://www.activepieces.com/docs/install/configuration/telemetry#why-does-activepieces-need-data) * [What Does Activepieces Collect?](https://www.activepieces.com/docs/install/configuration/telemetry#what-does-activepieces-collect) * [Opting out?](https://www.activepieces.com/docs/install/configuration/telemetry#opting-out) [​](https://www.activepieces.com/docs/install/configuration/telemetry#why-does-activepieces-need-data) Why Does Activepieces need data? ========================================================================================================================================== As a self-hosted product, gathering usage metrics and insights can be difficult for us. However, these analytics are essential in helping us understand key behaviors and delivering a higher quality experience that meets your needs. To ensure we can continue to improve our product, we have decided to track certain basic behaviors and metrics that are vital for understanding the usage of Activepieces. We have implemented a minimal tracking plan and provide a detailed list of the metrics collected in a separate section. [​](https://www.activepieces.com/docs/install/configuration/telemetry#what-does-activepieces-collect) What Does Activepieces Collect? ======================================================================================================================================== We value transparency in data collection and assure you that we do not collect any personal information. The following events are currently being collected: [Exact Code](https://github.com/activepieces/activepieces/blob/main/packages/shared/src/lib/common/telemetry.ts) [​](https://www.activepieces.com/docs/install/configuration/telemetry#opting-out) Opting out? ================================================================================================ To opt out, set the environment variable `AP_TELEMETRY_ENABLED=false` [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/install/configuration/telemetry.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/install/configuration/telemetry) [Breaking Changes](https://www.activepieces.com/docs/install/configuration/breaking-changes) [Setup HTTPS](https://www.activepieces.com/docs/install/guides/setup-ssl) ⌘I --- # Private - Activepieces [Skip to main content](https://www.activepieces.com/docs/build-pieces/sharing-pieces/private#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Sharing Pieces Private [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) This feature is available in our paid editions. Contact us [here](https://www.activepieces.com/sales) , and we'll be delighted to assist you! This guide assumes you have already created a piece and created a private fork of our repository, and you would like to package it as a file and upload it. Friendly Tip: There is a CLI to easily upload it to your platform. Please check out [Publish Custom Pieces](https://www.activepieces.com/docs/build-pieces/misc/publish-piece) . 1 [](https://www.activepieces.com/docs/build-pieces/sharing-pieces/private#) Build Piece Build the piece using the following command. Make sure to replace `${name}` with your piece folder name. npm run pieces -- build --name=${name} More information about building pieces can be found [here](https://www.activepieces.com/docs/build-pieces/misc/build-piece) . 2 [](https://www.activepieces.com/docs/build-pieces/sharing-pieces/private#) Upload Tarball Upload the generated tarball inside `dist/packages/pieces/${name}`from Activepieces Platform Admin -> Pieces![Manage Pieces](https://mintcdn.com/activepieces/uHZ35vXyxX7goNO-/resources/screenshots/install-piece.png?w=2500&fit=max&auto=format&n=uHZ35vXyxX7goNO-&q=85&s=f0d73c60a5077685d90f537a4f8a4ec1) [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/build-pieces/sharing-pieces/private.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/build-pieces/sharing-pieces/private) [Community (Public NPM)](https://www.activepieces.com/docs/build-pieces/sharing-pieces/community) [Piece Auth](https://www.activepieces.com/docs/build-pieces/piece-reference/authentication) ⌘I --- # Overview - Activepieces [Skip to main content](https://www.activepieces.com/docs/build-pieces/piece-reference/triggers/overview#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Triggers Overview [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Trigger Structure](https://www.activepieces.com/docs/build-pieces/piece-reference/triggers/overview#trigger-structure) * [Context Object](https://www.activepieces.com/docs/build-pieces/piece-reference/triggers/overview#context-object) This tutorial explains three techniques for creating triggers: * `Polling`: Periodically call endpoints to check for changes. * `Webhooks`: Listen to user events through a single URL. * `App Webhooks (Subscriptions)`: Use a developer app (using OAuth2) to receive all authorized user events at a single URL (Not Supported). to create new trigger run following command, npm run cli triggers create 1. `Piece Folder Name`: This is the name associated with the folder where the trigger resides. It helps organize and categorize triggers within the piece. 2. `Trigger Display Name`: The name users see in the interface, conveying the trigger’s purpose clearly. 3. `Trigger Description`: A brief, informative text in the UI, guiding users about the trigger’s function and purpose. 4. `Trigger Technique`: Specifies the trigger type - either polling or webhook. [​](https://www.activepieces.com/docs/build-pieces/piece-reference/triggers/overview#trigger-structure) Trigger Structure ============================================================================================================================ export const createNewIssue = createTrigger({ auth: PieceAuth | undefined name: string, // Unique name across the piece. displayName: string, // Display name on the interface. description: string, // Description for the action sampleData: null, type: TriggerStrategy.WEBHOOK | TriggerStrategy.POLLING | TriggerStrategy.APP_WEBHOOK, props: {}; // Required properties from the user. // Run when the user enable or publish the flow. onEnable: (ctx) => {}, // Run when the user disable the flow or // the old flow is deleted after new one is published. onDisable: (ctx) => {}, // Trigger implementation, It takes context as parameter. // should returns an array of payload, each payload considered run: async run(ctx): unknown[] => {} }) It’s important to note that the `run` method returns an array. The reason for this is that a single polling can contain multiple triggers, so each item in the array will trigger the flow to run. [​](https://www.activepieces.com/docs/build-pieces/piece-reference/triggers/overview#context-object) Context Object ---------------------------------------------------------------------------------------------------------------------- The Context object contains multiple helpful pieces of information and tools that can be useful while developing. // Store: A simple, lightweight key-value store that is helpful when you are developing triggers that persist between runs, used to store information like the last polling date. await context.store.put('_lastFetchedDate', new Date()); const lastFetchedData = await context.store.get('_lastFetchedDate', new Date()); // Webhook URL: A unique, auto-generated URL that will trigger the flow. Useful when you need to develop a trigger based on webhooks. context.webhookUrl; // Payload: Contains information about the HTTP request sent by the third party. It has three properties: status, headers, and body. context.payload; // PropsValue: Contains the information filled by the user in defined properties. context.propsValue; **App Webhooks (Not Supported)** Certain services, such as `Slack` and `Square`, only support webhooks at the developer app level. This means that all authorized users for the app will be sent to the same endpoint. While this technique will be supported soon, for now, a workaround is to perform polling on the endpoint. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/build-pieces/piece-reference/triggers/overview.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/build-pieces/piece-reference/triggers/overview) [Piece Auth](https://www.activepieces.com/docs/build-pieces/piece-reference/authentication) [Polling Trigger](https://www.activepieces.com/docs/build-pieces/piece-reference/triggers/polling-trigger) ⌘I --- # Engine - Activepieces [Skip to main content](https://www.activepieces.com/docs/install/architecture/engine#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Architecture Engine [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) The Engine file contains the following types of operations: * **Extract Piece Metadata**: Extracts metadata when installing new pieces. * **Execute Step**: Executes a single test step. * **Execute Flow**: Executes a flow. * **Execute Property**: Executes dynamic dropdowns or dynamic properties. * **Execute Trigger Hook**: Executes actions such as OnEnable, OnDisable, or extracting payloads. * **Execute Auth Validation**: Validates the authentication of the connection. The engine takes the flow JSON with an engine token scoped to this project and implements the API provided for the piece framework, such as: * Storage Service: A simple key/value persistent store for the piece framework. * File Service: A helper to store files either locally or in a database, such as for testing steps. * Fetch Metadata: Retrieves metadata of the current running project. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/install/architecture/engine.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/install/architecture/engine) [Workers & Sandboxing](https://www.activepieces.com/docs/install/architecture/workers) [Benchmark](https://www.activepieces.com/docs/install/architecture/benchmark) ⌘I --- # Handling Downtime - Activepieces [Skip to main content](https://www.activepieces.com/docs/handbook/engineering/onboarding/downtime-incident#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Engineering Onboarding Handling Downtime [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [📋 What You Need Before Starting](https://www.activepieces.com/docs/handbook/engineering/onboarding/downtime-incident#-what-you-need-before-starting) * [🚨 Stay Calm and Take Action](https://www.activepieces.com/docs/handbook/engineering/onboarding/downtime-incident#-stay-calm-and-take-action) * [🔍 Check for Infrastructure Problems](https://www.activepieces.com/docs/handbook/engineering/onboarding/downtime-incident#-check-for-infrastructure-problems) * [📜 Check Logs and Errors](https://www.activepieces.com/docs/handbook/engineering/onboarding/downtime-incident#-check-logs-and-errors) * [🛠️ Debugging with Playwright / BetterStack Monitors](https://www.activepieces.com/docs/handbook/engineering/onboarding/downtime-incident#-debugging-with-playwright-%2F-betterstack-monitors) * [🎭 Debugging Incidents via Playwright Artifacts](https://www.activepieces.com/docs/handbook/engineering/onboarding/downtime-incident#-debugging-incidents-via-playwright-artifacts) * [🚨 When Should You Ask for Help?](https://www.activepieces.com/docs/handbook/engineering/onboarding/downtime-incident#-when-should-you-ask-for-help) * [💡 Helpful Tips](https://www.activepieces.com/docs/handbook/engineering/onboarding/downtime-incident#-helpful-tips) ![Downtime Incident](https://media3.giphy.com/media/v1.Y2lkPTc5MGI3NjExdTZnbGxjc3k5d3NxeXQwcmhxeTRsbnNybnd4NG41ZnkwaDdsa3MzeSZlcD12MV9pbnRlcm5hbF9naWZfYnlfaWQmY3Q9Zw/2UCt7zbmsLoCXybx6t/giphy.gif) [​](https://www.activepieces.com/docs/handbook/engineering/onboarding/downtime-incident#-what-you-need-before-starting) 📋 What You Need Before Starting ----------------------------------------------------------------------------------------------------------------------------------------------------------- Make sure these are ready: * **[BetterStack Setup](https://www.activepieces.com/docs/handbook/engineering/playbooks/setup-betterstack) **: For managing incidents and on-call alerts. * **[BetterStack Logs](https://telemetry.betterstack.com/) **: For checking logs and errors. * **[BetterStack Monitors](https://uptime.betterstack.com/) **: For e2e test results and uptime monitoring. * **[BetterStack Errors](https://errors.betterstack.com/) **: For thrown errors. * * * [​](https://www.activepieces.com/docs/handbook/engineering/onboarding/downtime-incident#-stay-calm-and-take-action) 🚨 Stay Calm and Take Action --------------------------------------------------------------------------------------------------------------------------------------------------- Don’t panic! Follow these steps to fix the issue. 1. **Tell Your Users**: * Let your users know there’s an issue. Post on [Community](https://community.activepieces.com/) and Discord. * Example message: _“We’re looking into a problem with our services. Thanks for your patience!”_ 2. **Find Out What’s Wrong**: * Gather details. What’s not working? When did it start? 3. **Update the Status Page**: * Use [BetterStack](https://uptime.betterstack.com/) and create an incident to update the status page. Set it to _”Investigating”_ or _”Partial Outage”_. * * * [​](https://www.activepieces.com/docs/handbook/engineering/onboarding/downtime-incident#-check-for-infrastructure-problems) 🔍 Check for Infrastructure Problems ------------------------------------------------------------------------------------------------------------------------------------------------------------------- 1. **Look at DigitalOcean**: * Check if the CPU, memory, or disk usage is too high. * If it is: * **Increase the machine size** temporarily to fix the issue. * Keep looking for the root cause. * * * [​](https://www.activepieces.com/docs/handbook/engineering/onboarding/downtime-incident#-check-logs-and-errors) 📜 Check Logs and Errors ------------------------------------------------------------------------------------------------------------------------------------------- 1. **Use BetterStack Logs**: * Go to [https://telemetry.betterstack.com](https://telemetry.betterstack.com/) . * Search for recent errors in the logs. 2. **Check BetterStack errors**: * Go to [https://errors.betterstack.com](https://errors.betterstack.com/) . * Look for grouped errors (errors that happen a lot). * Try to **reproduce the error** and fix it if possible. * * * [​](https://www.activepieces.com/docs/handbook/engineering/onboarding/downtime-incident#-debugging-with-playwright-/-betterstack-monitors) 🛠️ Debugging with Playwright / BetterStack Monitors -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 1. **Check BetterStack Monitor Logs**: * Go to [https://uptime.betterstack.com](https://uptime.betterstack.com/) and review recent monitor failures. * If the issue is a **timeout**, it might mean there’s a bigger performance problem. 2. **Check Playwright E2E Results**: * Review the latest Playwright test run in CI for failed checks. * If it’s an E2E test failure due to UI changes, it’s likely not urgent. * Fix the test file packages/tests-e2e/scenarios/betterstack/webhook-should-return-response.flat.spec.js and the issue will go away once pushed to main and Sync Playwright test to BetterStack ci runs. * * * [​](https://www.activepieces.com/docs/handbook/engineering/onboarding/downtime-incident#-debugging-incidents-via-playwright-artifacts) 🎭 Debugging Incidents via Playwright Artifacts ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 1. Go to the [BetterStack Incidents list](https://uptime.betterstack.com/team/t142339/incidents?m=4211060) . 2. Choose the relevant incident. 3. Scroll down and open the **Artifacts** tab. 4. You’ll find **screenshots** of the failed Playwright tests and **logs** that help pinpoint what went wrong. * * * [​](https://www.activepieces.com/docs/handbook/engineering/onboarding/downtime-incident#-when-should-you-ask-for-help) 🚨 When Should You Ask for Help? ---------------------------------------------------------------------------------------------------------------------------------------------------------- Ask for help right away if: * Flows are failing. * The whole platform is down. * There’s a lot of data loss or corruption. * You’re not sure what is causing the issue. * You’ve spent **more than 5 minutes** and still don’t know what’s wrong. 💡 **How to Ask for Help**: * Use **BetterStack** to create a **critical alert**. * Go to the **Slack incident channel** and escalate the issue to the engineering team. If you’re unsure, **ask for help!** It’s better to be safe than sorry. * * * [​](https://www.activepieces.com/docs/handbook/engineering/onboarding/downtime-incident#-helpful-tips) 💡 Helpful Tips ------------------------------------------------------------------------------------------------------------------------- 1. **Stay Organized**: * Keep a list of steps to follow during downtime. * Write down everything you do so you can refer to it later. 2. **Communicate Clearly**: * Keep your team and users updated. * Use simple language in your updates. 3. **Take Care of Yourself**: * If you feel stressed, take a short break. Grab a coffee ☕, take a deep breath, and tackle the problem step by step. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/handbook/engineering/onboarding/downtime-incident.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/handbook/engineering/onboarding/downtime-incident) [On-Call](https://www.activepieces.com/docs/handbook/engineering/onboarding/on-call) [Stack & Tools](https://www.activepieces.com/docs/handbook/engineering/onboarding/stack) ⌘I --- # How to Separate Workers - Activepieces [Skip to main content](https://www.activepieces.com/docs/install/guides/separate-workers#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Guides How to Separate Workers [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) Benefits of separating workers from the main application (APP): * **Availability**: The application remains lightweight, allowing workers to be scaled independently. * **Security**: Workers lack direct access to Redis and the database, minimizing impact in case of a security breach. 1 [](https://www.activepieces.com/docs/install/guides/separate-workers#) Create Worker Token To create a worker token, use the local CLI command to generate the JWT and sign it with your `AP_JWT_SECRET` used for the app server. Follow these steps: 1. Open your terminal and navigate to the root of the repository. 2. Run the command: `npm run workers token`. 3. When prompted, enter the JWT secret (this should be the same as the `AP_JWT_SECRET` used for the app server). 4. The generated token will be displayed in your terminal, copy it and use it in the next step. ![Workers Token](https://mintcdn.com/activepieces/htEDiTsZNK_UML_C/resources/worker-token.png?w=2500&fit=max&auto=format&n=htEDiTsZNK_UML_C&q=85&s=79dcd1811ff4f113e88f53a0fae16267) 2 [](https://www.activepieces.com/docs/install/guides/separate-workers#) Configure Environment Variables Define the following environment variables in the `.env` file on the worker machine: * Set `AP_CONTAINER_TYPE` to `WORKER` * Specify `AP_FRONTEND_URL` * Provide `AP_WORKER_TOKEN` 3 [](https://www.activepieces.com/docs/install/guides/separate-workers#) Configure Persistent Volume Configure a persistent volume for the worker to cache flows and pieces. This is important as first uncached execution of pieces and flows are very slow. Having a persistent volume significantly improves execution speed.Add the following volume mapping to your docker configuration: volumes: - :/usr/src/app/cache Note: This setup works whether you attach one volume per worker, It cannot be shared across multiple workers. 4 [](https://www.activepieces.com/docs/install/guides/separate-workers#) Launch Worker Machine Launch the worker machine and supply it with the generated token. 5 [](https://www.activepieces.com/docs/install/guides/separate-workers#) Verify Worker Operation Verify that the workers are visible in the Platform Admin Console under Infra -> Workers.![Workers Infrastructure](https://mintcdn.com/activepieces/htEDiTsZNK_UML_C/resources/workers.png?w=2500&fit=max&auto=format&n=htEDiTsZNK_UML_C&q=85&s=e983a049af328d7844ad43deb23a269c) 6 [](https://www.activepieces.com/docs/install/guides/separate-workers#) Configure App Container Type On the APP machine, set `AP_CONTAINER_TYPE` to `APP`. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/install/guides/separate-workers.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/install/guides/separate-workers) [How to Setup S3](https://www.activepieces.com/docs/install/guides/setup-s3) [How to Setup App Webhooks](https://www.activepieces.com/docs/install/guides/setup-app-webhooks) ⌘I --- # Our Roles & Levels - Activepieces [Skip to main content](https://www.activepieces.com/docs/handbook/hiring/levels#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Hiring Our Roles & Levels [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Our Levels](https://www.activepieces.com/docs/handbook/hiring/levels#our-levels) * [L1 Product Engineers](https://www.activepieces.com/docs/handbook/hiring/levels#l1-product-engineers) * [L2 Product Engineers](https://www.activepieces.com/docs/handbook/hiring/levels#l2-product-engineers) * [L3 Product Engineers](https://www.activepieces.com/docs/handbook/hiring/levels#l3-product-engineers) * [How to Level Up](https://www.activepieces.com/docs/handbook/hiring/levels#how-to-level-up) **Product Engineers** are full stack engineers who handle both the engineering and product side, delivering features end-to-end. ### [​](https://www.activepieces.com/docs/handbook/hiring/levels#our-levels) Our Levels We break out seniority into three levels, **L1 to L3**. ### [​](https://www.activepieces.com/docs/handbook/hiring/levels#l1-product-engineers) L1 Product Engineers They tend to be early-career. * They get more management support than folks at other levels. * They focus on continuously absorbing new information about our users and how to be effective at **Activepieces**. * They aim to be increasingly autonomous as they gain more experience here. ### [​](https://www.activepieces.com/docs/handbook/hiring/levels#l2-product-engineers) L2 Product Engineers They are generally responsible for running a project start-to-finish. * They independently decide on the implementation details. * They work with **Stakeholders** / **teammates** / **L3s** on the plan. * They have personal responsibility for the **“how”** of what they’re working on, but share responsibility for the **“what”** and **“why”**. * They make consistent progress on their work by continuously defining the scope, incorporating feedback, trying different approaches and solutions, and deciding what will deliver the most value for users. ### [​](https://www.activepieces.com/docs/handbook/hiring/levels#l3-product-engineers) L3 Product Engineers Their scope is bigger than coding, they lead a product area, make key product decisions and guide the team with strong leadership skills. * **Planning**: They help **L2s** figure out what the next priority things to focus on and guide **L1s** in determining the right sequence of work to get a project done. * **Day-to-Day Work**: They might be hands-on with the day-to-day work of the team, providing support and resources to their teammates as needed. * **Customer Communication**: They handle direct communication with customers regarding planning and product direction, ensuring that customer needs and feedback are incorporated into the development process. ### [​](https://www.activepieces.com/docs/handbook/hiring/levels#how-to-level-up) How to Level Up There is no formal process, but it happens at the end of **each year** and is based on two things: 1. **Manager Review**: Managers look at how well the engineer has performed and grown over the year. 2. **Peer Review**: Colleagues give feedback on how well the engineer has worked with the team. This helps make sure promotions are fair and based on merit. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/handbook/hiring/levels.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/handbook/hiring/levels) [Our Hiring Process](https://www.activepieces.com/docs/handbook/hiring/hiring) [Our Team Structure](https://www.activepieces.com/docs/handbook/hiring/team) ⌘I --- # Environment Variables - Activepieces [Skip to main content](https://www.activepieces.com/docs/install/configuration/environment-variables#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Configuration Environment Variables [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Environment Variables](https://www.activepieces.com/docs/install/configuration/environment-variables#environment-variables) * [Setting Webhook (Frontend URL):](https://www.activepieces.com/docs/install/configuration/environment-variables#setting-webhook-frontend-url-) * [Redis Configuration](https://www.activepieces.com/docs/install/configuration/environment-variables#redis-configuration) * [SMTP Configuration](https://www.activepieces.com/docs/install/configuration/environment-variables#smtp-configuration) To configure activepieces, you will need to set some environment variables, There is file called `.env` at the root directory for our main repo. When you execute the [tools/deploy.sh](https://github.com/activepieces/activepieces/blob/main/tools/deploy.sh) script in the Docker installation tutorial, it will produce these values. [​](https://www.activepieces.com/docs/install/configuration/environment-variables#environment-variables) Environment Variables --------------------------------------------------------------------------------------------------------------------------------- | Variable | Description | Default Value | Example | | --- | --- | --- | --- | | `AP_CONFIG_PATH` | Optional parameter for specifying the path to store PGLite database and local settings. | `~/.activepieces` | | | `AP_CLOUD_AUTH_ENABLED` | Turn off the utilization of Activepieces oauth2 applications | `false` | | | `AP_DB_TYPE` | The type of database to use. `POSTGRES` for external PostgreSQL, `PGLITE` for embedded database. **Note:** `SQLITE3` is deprecated and will be automatically migrated to `PGLITE`. | `POSTGRES` | | | `AP_EXECUTION_MODE` | You can choose between ‘SANDBOX\_PROCESS’, ‘UNSANDBOXED’, ‘SANDBOX\_CODE\_ONLY’, ‘SANDBOX\_CODE\_AND\_PROCESS’ as possible values. If you decide to change this, make sure to carefully read [https://www.activepieces.com/docs/install/architecture/workers](https://www.activepieces.com/docs/install/architecture/workers) | `UNSANDBOXED` | | | `AP_ENCRYPTION_KEY` | ❗️ Encryption key used for connections is a 32-character (16 bytes) hexadecimal key. You can generate one using the following command: `openssl rand -hex 16`. | None | | | `AP_EXECUTION_DATA_RETENTION_DAYS` | The number of days to retain execution data, logs and events. | `30` | | | `AP_FRONTEND_URL` | ❗️ Url that will be used to specify redirect url and webhook url. | | | | `AP_INTERNAL_URL` | (BETA) Used to specify the SSO authentication URL. | None | [https://demo.activepieces.com/api](https://demo.activepieces.com/api) | | `AP_JWT_SECRET` | ❗️ Encryption key used for generating JWT tokens is a 32-character hexadecimal key. You can generate one using the following command: `openssl rand -hex 32`. | None | [https://demo.activepieces.com](https://demo.activepieces.com/) | | `AP_QUEUE_UI_ENABLED` | Enable the queue UI (only works with redis) | `true` | | | `AP_QUEUE_UI_USERNAME` | The username for the queue UI. This is required if `AP_QUEUE_UI_ENABLED` is set to `true`. | None | | | `AP_QUEUE_UI_PASSWORD` | The password for the queue UI. This is required if `AP_QUEUE_UI_ENABLED` is set to `true`. | None | | | `AP_REDIS_FAILED_JOB_RETENTION_DAYS` | The number of days to retain failed jobs in Redis. | `30` | | | `AP_REDIS_FAILED_JOB_RETENTION_MAX_COUNT` | The maximum number of failed jobs to retain in Redis. | `2000` | | | `AP_TRIGGER_DEFAULT_POLL_INTERVAL` | How many minutes before the system checks for new data updates for pieces with scheduled triggers, such as new Google Contacts. | `5` | | | `AP_PIECES_CACHE_MAX_ENTRIES` | Maximum number of entries in the in-memory LRU cache for piece metadata. The cache stores piece lists and individual piece metadata to reduce database load; when the limit is reached, least recently used entries are evicted. | `1000` | | | `AP_PIECES_SOURCE` | `AP_PIECES_SOURCE`: `FILE` for local development, `DB` for database. You can find more information about it in [Setting Piece Source](https://www.activepieces.com/docs/install/configuration/environment-variables#setting-piece-source)
section. | `CLOUD_AND_DB` | | | `AP_PIECES_SYNC_MODE` | `AP_PIECES_SYNC_MODE`: None for no metadata syncing / ‘OFFICIAL\_AUTO’ for automatic syncing for pieces metadata from cloud | `OFFICIAL_AUTO` | | | `AP_POSTGRES_DATABASE` | ❗️ The name of the PostgreSQL database | None | | | `AP_POSTGRES_HOST` | ❗️ The hostname or IP address of the PostgreSQL server | None | | | `AP_POSTGRES_PASSWORD` | ❗️ The password for the PostgreSQL, you can generate a 32-character hexadecimal key using the following command: `openssl rand -hex 32`. | None | | | `AP_POSTGRES_PORT` | ❗️ The port number for the PostgreSQL server | None | | | `AP_POSTGRES_USERNAME` | ❗️ The username for the PostgreSQL user | None | | | `AP_POSTGRES_USE_SSL` | Use SSL to connect the postgres database | `false` | | | `AP_POSTGRES_SSL_CA` | Use SSL Certificate to connect to the postgres database | | | | `AP_POSTGRES_URL` | Alternatively, you can specify only the connection string (e.g postgres://user:password@host:5432/database) instead of providing the database, host, port, username, and password. | None | | | `AP_POSTGRES_POOL_SIZE` | Maximum number of clients the pool should contain for the PostgreSQL database | None | | | `AP_POSTGRES_IDLE_TIMEOUT_MS` | Sets the idle timout pool for your PostgreSQL | `30000` | | | `AP_REDIS_TYPE` | Where to spin redis instance, either in memory (MEMORY) or in a dedicated instance (STANDALONE), or in a sentinel instance (SENTINEL) | `STANDALONE` | | | `AP_REDIS_URL` | If a Redis connection URL is specified, all other Redis properties will be ignored. | None | | | `AP_REDIS_USER` | ❗️ Username to use when connect to redis | None | | | `AP_REDIS_PASSWORD` | ❗️ Password to use when connect to redis | None | | | `AP_REDIS_HOST` | ❗️ The hostname or IP address of the Redis server | None | | | `AP_REDIS_PORT` | ❗️ The port number for the Redis server | None | | | `AP_REDIS_DB` | The Redis database index to use | `0` | | | `AP_REDIS_USE_SSL` | Connect to Redis with SSL | `false` | | | `AP_REDIS_SSL_CA_FILE` | The path to the CA file for the Redis server. | None | | | `AP_REDIS_SENTINEL_HOSTS` | If specified, this should be a comma-separated list of `host:port` pairs for Redis Sentinels. Make sure to set `AP_REDIS_CONNECTION_MODE` to `SENTINEL` | None | `sentinel-host-1:26379,sentinel-host-2:26379,sentinel-host-3:26379` | | `AP_REDIS_SENTINEL_NAME` | The name of the master node monitored by the sentinels. | None | `sentinel-host-1` | | `AP_REDIS_SENTINEL_ROLE` | The role to connect to, either `master` or `slave`. | None | `master` | | `AP_TRIGGER_TIMEOUT_SECONDS` | Maximum allowed runtime for a trigger to perform polling in seconds | `60` | | | `AP_FLOW_TIMEOUT_SECONDS` | Maximum allowed runtime for a flow to run in seconds | `600` | | | `AP_SANDBOX_MEMORY_LIMIT` | The maximum amount of memory (in kilobytes) that a single sandboxed engine process can use. Each engine process executes at most one execution at a time. This helps prevent runaway memory usage in custom code or pieces. If not set, the default is 1,048,576 KB (1,024 MB). | `1048576` | `1048576` | | `AP_SANDBOX_PROPAGATED_ENV_VARS` | Environment variables that will be propagated to the sandboxed code. If you are using it for pieces, we strongly suggests keeping everything in the authentication object to make sure it works across AP instances. | None | | | `AP_SCIM_DEFAULT_PROJECT_ROLE` | The default project role assigned to members when they are added to a project via SCIM group sync. Accepted values: `Admin`, `Editor`, `Viewer`. | `Editor` | `Viewer` | | `AP_TELEMETRY_ENABLED` | Collect telemetry information. | `true` | | | `AP_TEMPLATES_SOURCE_URL` | This is the endpoint we query for templates, remove it and templates will be removed from UI | `https://cloud.activepieces.com/api/v1/templates` | | | `AP_WEBHOOK_TIMEOUT_SECONDS` | The default timeout for webhooks. The maximum allowed is 15 minutes. Please note that Cloudflare limits it to 30 seconds. If you are using a reverse proxy for SSL, make sure it’s configured correctly. | `30` | | | `AP_TRIGGER_FAILURE_THRESHOLD` | The maximum number of consecutive trigger failures is 576 by default, which is equivalent to approximately 2 days. | `30` | | | `AP_PROJECT_RATE_LIMITER_ENABLED` | Enforce rate limits and prevent excessive usage by a single project. | `true` | | | `AP_MAX_CONCURRENT_JOBS_PER_PROJECT` | The maximum number of active runs a project can have. This is used to enforce rate limits and prevent excessive usage by a single project. | `100` | | | `AP_S3_ACCESS_KEY_ID` | The access key ID for your S3-compatible storage service. Not required if `AP_S3_USE_IRSA` is `true`. | None | | | `AP_S3_SECRET_ACCESS_KEY` | The secret access key for your S3-compatible storage service. Not required if `AP_S3_USE_IRSA` is `true`. | None | | | `AP_S3_BUCKET` | The name of the S3 bucket to use for file storage. | None | | | `AP_S3_ENDPOINT` | The endpoint URL for your S3-compatible storage service. Not required if `AWS_ENDPOINT_URL` is set. | None | `https://s3.amazonaws.com` | | `AP_S3_REGION` | The region where your S3 bucket is located. Not required if `AWS_REGION` is set. | None | `us-east-1` | | `AP_S3_USE_SIGNED_URLS` | Routes file traffic directly to S3 using pre-signed URLs, bypassing the API server. The bucket should remain private; signed URLs provide temporary authenticated access. | None | | | `AP_S3_USE_IRSA` | Use IAM Role for Service Accounts (IRSA) to connect to S3. When `true`, `AP_S3_ACCESS_KEY_ID` and `AP_S3_ACCESS_KEY_ID` are not required. | None | `true` | | `AP_SMTP_HOST` | The host name for the SMTP server that activepieces uses to send emails | `None` | `mail.example.com` | | `AP_SMTP_PORT` | The port number for the SMTP server that activepieces uses to send emails | `None` | 587 | | `AP_SMTP_USERNAME` | The user name for the SMTP server that activepieces uses to send emails | `None` | [\[email protected\]](https://www.activepieces.com/cdn-cgi/l/email-protection#a3d7c6d0d7e3cec2cacf8dc6dbc2ced3cfc68dc0ccce) | | `AP_SMTP_PASSWORD` | The password for the SMTP server that activepieces uses to send emails | `None` | secret1234 | | `AP_SMTP_SENDER_EMAIL` | The email address from which activepieces sends emails. | `None` | [\[email protected\]](https://www.activepieces.com/cdn-cgi/l/email-protection#7c08190f083c111d15105219041d110c1019521f1311) | | `AP_SMTP_SENDER_NAME` | The sender name activepieces uses to send emails. | | | | `AP_MAX_FILE_SIZE_MB` | The maximum allowed file size (in megabytes) for **uploaded files** in steps or triggers. Files larger than this value will be rejected. This does **not** control flow run log size—see `AP_MAX_FLOW_RUN_LOG_SIZE_MB`. | `25` | `10` | | `AP_MAX_FLOW_RUN_LOG_SIZE_MB` | The maximum allowed size (in megabytes) of the **flow run logs**—this is the total combined size of all inputs and outputs for each step in a single flow run. If logs exceed this size, they will be truncated, which may cause flow execution issues. | `25` | `25` | | `AP_MAX_WEBHOOK_PAYLOAD_SIZE_MB` | Maximum webhook payload size in MB. Payloads exceeding this are rejected with HTTP 413. | `5` | `10` | | `AP_WEBHOOK_PAYLOAD_INLINE_THRESHOLD_KB` | Webhook payloads below this size (in KB) are stored inline in Redis for fastest processing. Payloads above this are offloaded to file storage to protect Redis memory. | `512` | `1024` | | `AP_WORKER_CONCURRENCY` | The number of concurrent jobs the worker can process simultaneously. Each concurrent job uses one sandbox instance. | `5` | `10` | | `AP_FILE_STORAGE_LOCATION` | The location to store files. Possible values are `DB` for storing files in the database or `S3` for storing files in an S3-compatible storage service. | `DB` | | | `AP_PAUSED_FLOW_TIMEOUT_DAYS` | The maximum allowed pause duration in days for a paused flow, please note it can not exceed `AP_EXECUTION_DATA_RETENTION_DAYS` | `30` | | | `AP_MAX_RECORDS_PER_TABLE` | The maximum allowed number of records per table | `10000` | `10000` | | `AP_MAX_FIELDS_PER_TABLE` | The maximum allowed number of fields per table | `100` | `100` | | `AP_MAX_TABLES_PER_PROJECT` | The maximum allowed number of tables per project | `20` | `20` | | `AP_MAX_MCPS_PER_PROJECT` | The maximum allowed number of mcp per project | `20` | `20` | | `AP_MCP_OAUTH_ISSUER_URL` | The issuer URL used for MCP OAuth token generation and metadata discovery. Falls back to `AP_FRONTEND_URL` if not set. | None | `https://mcp.example.com` | | `AP_ENABLE_FLOW_ON_PUBLISH` | Whether publishing a new flow version should automatically enable the flow | `true` | `false` | | `AP_ISSUE_ARCHIVE_DAYS` | Controls the automatic archival of issues in the system. Issues that have not been updated for this many days will be automatically moved to an archived state. | `14` | `1` | | `AP_LOAD_TRANSLATIONS_FOR_DEV_PIECES` | Load translations for dev pieces (configured via `AP_DEV_PIECES`). When disabled, dev pieces are loaded without translations. This only affects development mode. | `false` | `true` | | `AP_CONTAINER_TYPE` | Controls which services to run in the Docker container. `APP` starts only the API server, `WORKER` starts only the worker, `WORKER_AND_APP` starts both. | `WORKER_AND_APP` | `APP` | | `AP_SSRF_PROTECTION_ENABLED` | Controls whether pieces can make http requests to private IPs. | `false` | “ | | `AP_SSRF_ALLOW_LIST` | Controls allowed private IPs for pieces http requests if AP\_SSRF\_PROTECTION\_ENABLED is enabled. | `false` | “ | The frontend URL is essential for webhooks and app triggers to work. It must be accessible to third parties to send data. ### [​](https://www.activepieces.com/docs/install/configuration/environment-variables#setting-webhook-frontend-url-) Setting Webhook (Frontend URL): The default URL is set to the machine’s IP address. To ensure proper operation, ensure that this address is accessible or specify an `AP_FRONTEND_URL` environment variable. One possible solution for this is using a service like ngrok ([https://ngrok.com/](https://ngrok.com/) ), which can be used to expose the frontend port (4200) to the internet. ### [​](https://www.activepieces.com/docs/install/configuration/environment-variables#redis-configuration) Redis Configuration Set the `AP_REDIS_URL` environment variable to the connection URL of your Redis server. Please note that if a Redis connection URL is specified, all other **Redis properties** will be ignored. If you don’t have the Redis URL, you can use the following command to get it. You can use the following variables: * `REDIS_USER`: The username to use when connecting to Redis. * `REDIS_PASSWORD`: The password to use when connecting to Redis. * `REDIS_HOST`: The hostname or IP address of the Redis server. * `REDIS_PORT`: The port number for the Redis server. * `REDIS_DB`: The Redis database index to use. * `REDIS_USE_SSL`: Connect to Redis with SSL. If you are using **Redis Sentinel**, you can set the following environment variables: * `AP_REDIS_TYPE`: Set this to `SENTINEL`. * `AP_REDIS_SENTINEL_HOSTS`: A comma-separated list of `host:port` pairs for Redis Sentinels. When set, all other Redis properties will be ignored. * `AP_REDIS_SENTINEL_NAME`: The name of the master node monitored by the sentinels. * `AP_REDIS_SENTINEL_ROLE`: The role to connect to, either `master` or `slave`. * `AP_REDIS_PASSWORD`: The password to use when connecting to Redis. * `AP_REDIS_USE_SSL`: Connect to Redis with SSL. * `AP_REDIS_SSL_CA_FILE`: The path to the CA file for the Redis server. ### [​](https://www.activepieces.com/docs/install/configuration/environment-variables#smtp-configuration) SMTP Configuration SMTP can be configured both from the platform admin screen and through environment variables. The enviroment variables are only used if the platform admin screen has no email configuration entered. Activepieces will only use the configuration from the environment variables if `AP_SMTP_HOST`, `AP_SMTP_PORT`, `AP_SMTP_USERNAME` and `AP_SMTP_PASSWORD` all have a value set. TLS is supported. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/install/configuration/environment-variables.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/install/configuration/environment-variables) [Deployment Checklist](https://www.activepieces.com/docs/install/configuration/overview) [Hardware Requirements](https://www.activepieces.com/docs/install/configuration/hardware) ⌘I --- # Polling Trigger - Activepieces [Skip to main content](https://www.activepieces.com/docs/build-pieces/piece-reference/triggers/polling-trigger#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Triggers Polling Trigger [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Polling library](https://www.activepieces.com/docs/build-pieces/piece-reference/triggers/polling-trigger#polling-library) * [Strategies](https://www.activepieces.com/docs/build-pieces/piece-reference/triggers/polling-trigger#strategies) * [Trigger Implementation](https://www.activepieces.com/docs/build-pieces/piece-reference/triggers/polling-trigger#trigger-implementation) The way polling triggers usually work is as follows: **On Enable:** Store the last timestamp or most recent item id using the context store property. **Run:** This method runs every **5 minutes**, fetches the endpoint between a certain timestamp or traverses until it finds the last item id, and returns the new items as an array. **Testing:** You can implement a test function which should return some of the most recent items. It’s recommended to limit this to five. **Examples:** * [New Record Airtable](https://github.com/activepieces/activepieces/blob/main/packages/pieces/community/airtable/src/lib/trigger/new-record.trigger.ts) * [New Updated Item Salesforce](https://github.com/activepieces/activepieces/blob/main/packages/pieces/community/salesforce/src/lib/trigger/new-updated-record.ts) [​](https://www.activepieces.com/docs/build-pieces/piece-reference/triggers/polling-trigger#polling-library) Polling library =============================================================================================================================== There multiple strategy to implement polling triggers, and we have created a library to help you with that. [​](https://www.activepieces.com/docs/build-pieces/piece-reference/triggers/polling-trigger#strategies) Strategies --------------------------------------------------------------------------------------------------------------------- **Timebased:** This strategy fetches new items using a timestamp. You need to implement the items method, which should return the most recent items. The library will detect new items based on the timestamp. The polling object’s generic type consists of the props value and the object type. const polling: Polling, Record> = { strategy: DedupeStrategy.TIMEBASED, items: async ({ propsValue, lastFetchEpochMS }) => { // Todo implement the logic to fetch the items const items = [ {id: 1, created_date: '2021-01-01T00:00:00Z'}, {id: 2, created_date: '2021-01-01T00:00:00Z'}]; return items.map((item) => ({ epochMilliSeconds: dayjs(item.created_date).valueOf(), data: item, })); } } **Last ID Strategy:** This strategy fetches new items based on the last item ID. To use this strategy, you need to implement the items method, which should return the most recent items. The library will detect new items after the last item ID. The polling object’s generic type consists of the props value and the object type const polling: Polling, Record> = { strategy: DedupeStrategy.LAST_ITEM, items: async ({ propsValue }) => { // Implement the logic to fetch the items const items = [{ id: 1 }, { id: 2 }]; return items.map((item) => ({ id: item.id, data: item, })); } } [​](https://www.activepieces.com/docs/build-pieces/piece-reference/triggers/polling-trigger#trigger-implementation) Trigger Implementation --------------------------------------------------------------------------------------------------------------------------------------------- After implementing the polling object, you can use the polling helper to implement the trigger. export const newTicketInView = createTrigger({ name: 'new_ticket_in_view', displayName: 'New ticket in view', description: 'Triggers when a new ticket is created in a view', type: TriggerStrategy.POLLING, props: { authentication: Property.SecretText({ displayName: 'Authentication', description: markdownProperty, required: true, }), }, sampleData: {}, onEnable: async (context) => { await pollingHelper.onEnable(polling, { store: context.store, propsValue: context.propsValue, auth: context.auth }) }, onDisable: async (context) => { await pollingHelper.onDisable(polling, { store: context.store, propsValue: context.propsValue, auth: context.auth }) }, run: async (context) => { return await pollingHelper.poll(polling, context); }, test: async (context) => { return await pollingHelper.test(polling, context); } }); [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/build-pieces/piece-reference/triggers/polling-trigger.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/build-pieces/piece-reference/triggers/polling-trigger) [Overview](https://www.activepieces.com/docs/build-pieces/piece-reference/triggers/overview) [Webhook Trigger](https://www.activepieces.com/docs/build-pieces/piece-reference/triggers/webhook-trigger) ⌘I --- # Run Enterprise Edition - Activepieces [Skip to main content](https://www.activepieces.com/docs/handbook/engineering/playbooks/run-ee#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Engineering Playbooks Run Enterprise Edition [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) The enterprise edition requires a postgres and redis instance to run, and a license key to activate. 1 [](https://www.activepieces.com/docs/handbook/engineering/playbooks/run-ee#) Run the dev container Follow the instructions [here](https://www.activepieces.com/docs/build-pieces/misc/dev-container) to run the dev container. 2 [](https://www.activepieces.com/docs/handbook/engineering/playbooks/run-ee#) Add the following env variables in \`server/api/.env\` Pase the following env variables in `server/api/.env` ## these variables are set to align with the .devcontainer/docker-compose.yml file AP_DB_TYPE=POSTGRES AP_DEV_PIECES="your_piece_name" AP_ENVIRONMENT="dev" AP_EDITION=ee AP_EXECUTION_MODE=UNSANDBOXED AP_FRONTEND_URL="http://localhost:4200" AP_WEBHOOK_URL="http://localhost:3000" AP_PIECES_SOURCE='FILE' AP_PIECES_SYNC_MODE='NONE' AP_LOG_LEVEL=debug AP_LOG_PRETTY=true AP_REDIS_HOST="redis" AP_REDIS_PORT="6379" AP_TRIGGER_DEFAULT_POLL_INTERVAL=1 AP_CACHE_PATH=/workspace/cache AP_POSTGRES_DATABASE=activepieces AP_POSTGRES_HOST=db AP_POSTGRES_PORT=5432 AP_POSTGRES_USERNAME=postgres AP_POSTGRES_PASSWORD=A79Vm5D4p2VQHOp2gd5 AP_ENCRYPTION_KEY=427a130d9ffab21dc07bcd549fcf0966 AP_JWT_SECRET=secret 3 [](https://www.activepieces.com/docs/handbook/engineering/playbooks/run-ee#) Activate Your License Key After signing in, activate the license key by going to **Platform Admin -> Setup -> License Keys**![Activation License Key](https://mintcdn.com/activepieces/ki8mFooo8mAmhMdP/resources/screenshots/activation-license-key-settings.png?w=2500&fit=max&auto=format&n=ki8mFooo8mAmhMdP&q=85&s=300627457e14ab17abfed9ca7eb8e8f7) [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/handbook/engineering/playbooks/run-ee.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/handbook/engineering/playbooks/run-ee) [Release Cycle](https://www.activepieces.com/docs/handbook/engineering/onboarding/release-cycle) [Setup BetterStack](https://www.activepieces.com/docs/handbook/engineering/playbooks/setup-betterstack) ⌘I --- # Overview - Activepieces [Skip to main content](https://www.activepieces.com/docs/handbook/engineering/overview#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Engineering Onboarding Overview [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) Welcome to the engineering team! This section contains essential information to help you get started, including our development processes, guidelines, and practices. We’re excited to have you on board. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/handbook/engineering/overview.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/handbook/engineering/overview) [How to handle Requests](https://www.activepieces.com/docs/handbook/customer-support/handle-requests) [Onboarding Check List](https://www.activepieces.com/docs/handbook/engineering/onboarding/onboarding-check-list) ⌘I --- # How to Setup OpenTelemetry - Activepieces [Skip to main content](https://www.activepieces.com/docs/install/guides/setup-opentelemetry#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Guides How to Setup OpenTelemetry [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Environment Variables](https://www.activepieces.com/docs/install/guides/setup-opentelemetry#environment-variables) Activepieces supports both standard OpenTelemetry environment variables and vendor-specific configuration for observability and tracing. [​](https://www.activepieces.com/docs/install/guides/setup-opentelemetry#environment-variables) Environment Variables ------------------------------------------------------------------------------------------------------------------------ | Variable | Description | Default Value | Example | | --- | --- | --- | --- | | `AP_OTEL_ENABLED` | Enable OpenTelemetry tracing | `false` | `true` | | `OTEL_EXPORTER_OTLP_ENDPOINT` | OTLP exporter endpoint URL | None | `https://your-collector:4317/v1/traces` | | `OTEL_EXPORTER_OTLP_HEADERS` | Headers for OTLP exporter (comma-separated key=value pairs) | None | `Authorization=Bearer token` | Both `AP_OTEL_ENABLED` and `OTEL_EXPORTER_OTLP_ENDPOINT` must be set for OpenTelemetry to be enabled. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/install/guides/setup-opentelemetry.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/install/guides/setup-opentelemetry) [Setup HTTPS](https://www.activepieces.com/docs/install/guides/setup-ssl) [How to Setup S3](https://www.activepieces.com/docs/install/guides/setup-s3) ⌘I --- # How to Setup App Webhooks - Activepieces [Skip to main content](https://www.activepieces.com/docs/install/guides/setup-app-webhooks#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Guides How to Setup App Webhooks [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Slack](https://www.activepieces.com/docs/install/guides/setup-app-webhooks#slack) Certain apps like Slack and Square only support one webhook per OAuth2 app. This means that manual configuration is required in their developer portal, and it cannot be automated. [​](https://www.activepieces.com/docs/install/guides/setup-app-webhooks#slack) Slack --------------------------------------------------------------------------------------- **Configure Webhook Secret** 1. Visit the “Basic Information” section of your Slack OAuth settings. 2. Copy the “Signing Secret” and save it. 3. Set the following environment variable in your activepieces environment: AP_APP_WEBHOOK_SECRETS={"@activepieces/piece-slack": {"webhookSecret": "SIGNING_SECRET"}} 4. Restart your application instance. **Configure Webhook URL** 1. Go to the “Event Subscription” settings in the Slack OAuth2 developer platform. 2. The URL format should be: `https://YOUR_AP_INSTANCE/api/v1/app-events/slack`. 3. When connecting to Slack, use your OAuth2 credentials or update the OAuth2 app details from the admin console (in platform plans). 4. Add the following events to the app: * `message.channels` * `reaction_added` * `message.im` * `message.groups` * `message.mpim` * `app_mention` [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/install/guides/setup-app-webhooks.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/install/guides/setup-app-webhooks) [How to Separate Workers](https://www.activepieces.com/docs/install/guides/separate-workers) [Rollback Guide](https://www.activepieces.com/docs/install/guides/rollback) ⌘I --- # How to Setup S3 - Activepieces [Skip to main content](https://www.activepieces.com/docs/install/guides/setup-s3#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Guides How to Setup S3 [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Environment Variables](https://www.activepieces.com/docs/install/guides/setup-s3#environment-variables) Run logs and files are stored in the database by default, but you can switch to S3 later without any migration; for most cases, the database is enough. It’s recommended to start with the database and switch to S3 if needed. After switching, expired files in the database will be deleted, and everything will be stored in S3. No manual migration is needed. [​](https://www.activepieces.com/docs/install/guides/setup-s3#environment-variables) Environment Variables ------------------------------------------------------------------------------------------------------------- | Variable | Description | Default Value | Example | | --- | --- | --- | --- | | `AP_FILE_STORAGE_LOCATION` | The location to store files. Set to `S3` for S3 storage. | `DB` | `S3` | | `AP_S3_ACCESS_KEY_ID` | The access key ID for your S3-compatible storage service. Not required if `AP_S3_USE_IRSA` is `true`. | None | | | `AP_S3_SECRET_ACCESS_KEY` | The secret access key for your S3-compatible storage service. Not required if `AP_S3_USE_IRSA` is `true`. | None | | | `AP_S3_BUCKET` | The name of the S3 bucket to use for file storage. | None | | | `AP_S3_ENDPOINT` | The endpoint URL for your S3-compatible storage service. Not required if `AWS_ENDPOINT_URL` is set. | None | `https://s3.amazonaws.com` | | `AP_S3_REGION` | The region where your S3 bucket is located. Not required if `AWS_REGION` is set. | None | `us-east-1` | | `AP_S3_USE_SIGNED_URLS` | Routes file traffic directly to S3 using pre-signed URLs, bypassing the API server. The bucket should remain private; signed URLs provide temporary authenticated access. | None | `true` | | `AP_S3_USE_IRSA` | Use IAM Role for Service Accounts (IRSA) to connect to S3. When `true`, `AP_S3_ACCESS_KEY_ID` and `AP_S3_SECRET_ACCESS_KEY` are not required. | None | `true` | | `AP_MAX_FILE_SIZE_MB` | The maximum allowed file size in megabytes for uploads including logs of flow runs. | `10` | `10` | **Friendly Tip #1**: If the S3 bucket supports signed URLs but needs to be accessible over a public network, you can set `AP_S3_USE_SIGNED_URLS` to `true` to route traffic directly to S3 and reduce heavy traffic on your API server. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/install/guides/setup-s3.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/install/guides/setup-s3) [How to Setup OpenTelemetry](https://www.activepieces.com/docs/install/guides/setup-opentelemetry) [How to Separate Workers](https://www.activepieces.com/docs/install/guides/separate-workers) ⌘I --- # Websocket Issues - Activepieces [Skip to main content](https://www.activepieces.com/docs/install/troubleshooting/websocket-issues#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Troubleshooting Websocket Issues [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) If you’re experiencing issues with websocket connections, it’s likely due to incorrect proxy configuration. Common symptoms include: * Test Flow button not working * Test step in flows not working * Real-time updates not showing To resolve these issues: 1. Ensure your reverse proxy is properly configured for websocket connections 2. Check our [Setup HTTPS](https://www.activepieces.com/docs/install/guides/setup-ssl) guide for correct configuration examples 3. Some browsers block http websocket connections, please setup SSL to resolve this issue. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/install/troubleshooting/websocket-issues.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/install/troubleshooting/websocket-issues) [Truncated Logs](https://www.activepieces.com/docs/install/troubleshooting/truncated-logs) [Overview](https://www.activepieces.com/docs/install/architecture/overview) ⌘I --- # Reset Password - Activepieces [Skip to main content](https://www.activepieces.com/docs/install/troubleshooting/reset-password#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Troubleshooting Reset Password [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) If you forgot your password on a self-hosted instance, you can reset it using the following steps: 1. **Locate PostgreSQL Docker Container**: * Use a command like `docker ps` to find the PostgreSQL container. 2. **Access the Container**: * Use SSH to access the PostgreSQL Docker container. docker exec -it POSTGRES_CONTAINER_ID /bin/bash 3. **Open the PostgreSQL Console**: * Inside the container, open the PostgreSQL console with the `psql` command. psql -U postgres 4. **Connect to the ActivePieces Database**: * Connect to the ActivePieces database. \c activepieces 5. **Create a Secure Password**: * Use a tool like [bcrypt-generator.com](https://bcrypt-generator.com/) to generate a new secure password, number of rounds is 10. 6. **Update Your Password**: * Run the following SQL query within the PostgreSQL console, replacing `HASH_PASSWORD` with your new password and `YOUR_EMAIL_ADDRESS` with your email. UPDATE public.user_identity SET password='HASH_PASSWORD' WHERE email='YOUR_EMAIL_ADDRESS'; [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/install/troubleshooting/reset-password.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/install/troubleshooting/reset-password) [Queues Dashboard](https://www.activepieces.com/docs/install/troubleshooting/bullboard) [Truncated Logs](https://www.activepieces.com/docs/install/troubleshooting/truncated-logs) ⌘I --- # Tools Reference - Activepieces [Skip to main content](https://www.activepieces.com/docs/mcp/tools#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation MCP Server Tools Reference [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Discovery](https://www.activepieces.com/docs/mcp/tools#discovery) * [ap\_list\_flows](https://www.activepieces.com/docs/mcp/tools#ap_list_flows) * [ap\_flow\_structure](https://www.activepieces.com/docs/mcp/tools#ap_flow_structure) * [ap\_list\_pieces](https://www.activepieces.com/docs/mcp/tools#ap_list_pieces) * [ap\_list\_connections](https://www.activepieces.com/docs/mcp/tools#ap_list_connections) * [ap\_list\_ai\_models](https://www.activepieces.com/docs/mcp/tools#ap_list_ai_models) * [ap\_list\_tables](https://www.activepieces.com/docs/mcp/tools#ap_list_tables) * [ap\_find\_records](https://www.activepieces.com/docs/mcp/tools#ap_find_records) * [ap\_list\_runs](https://www.activepieces.com/docs/mcp/tools#ap_list_runs) * [ap\_get\_run](https://www.activepieces.com/docs/mcp/tools#ap_get_run) * [ap\_setup\_guide](https://www.activepieces.com/docs/mcp/tools#ap_setup_guide) * [Flow Management](https://www.activepieces.com/docs/mcp/tools#flow-management) * [ap\_create\_flow](https://www.activepieces.com/docs/mcp/tools#ap_create_flow) * [ap\_rename\_flow](https://www.activepieces.com/docs/mcp/tools#ap_rename_flow) * [ap\_change\_flow\_status](https://www.activepieces.com/docs/mcp/tools#ap_change_flow_status) * [ap\_lock\_and\_publish](https://www.activepieces.com/docs/mcp/tools#ap_lock_and_publish) * [Flow Building](https://www.activepieces.com/docs/mcp/tools#flow-building) * [ap\_update\_trigger](https://www.activepieces.com/docs/mcp/tools#ap_update_trigger) * [ap\_add\_step](https://www.activepieces.com/docs/mcp/tools#ap_add_step) * [ap\_update\_step](https://www.activepieces.com/docs/mcp/tools#ap_update_step) * [ap\_delete\_step](https://www.activepieces.com/docs/mcp/tools#ap_delete_step) * [Router & Branching](https://www.activepieces.com/docs/mcp/tools#router-%26-branching) * [ap\_add\_branch](https://www.activepieces.com/docs/mcp/tools#ap_add_branch) * [ap\_delete\_branch](https://www.activepieces.com/docs/mcp/tools#ap_delete_branch) * [Annotations](https://www.activepieces.com/docs/mcp/tools#annotations) * [ap\_manage\_notes](https://www.activepieces.com/docs/mcp/tools#ap_manage_notes) * [Tables](https://www.activepieces.com/docs/mcp/tools#tables) * [ap\_create\_table](https://www.activepieces.com/docs/mcp/tools#ap_create_table) * [ap\_delete\_table](https://www.activepieces.com/docs/mcp/tools#ap_delete_table) * [ap\_manage\_fields](https://www.activepieces.com/docs/mcp/tools#ap_manage_fields) * [ap\_insert\_records](https://www.activepieces.com/docs/mcp/tools#ap_insert_records) * [ap\_update\_record](https://www.activepieces.com/docs/mcp/tools#ap_update_record) * [ap\_delete\_records](https://www.activepieces.com/docs/mcp/tools#ap_delete_records) * [Testing & Runs](https://www.activepieces.com/docs/mcp/tools#testing-%26-runs) * [ap\_test\_flow](https://www.activepieces.com/docs/mcp/tools#ap_test_flow) * [ap\_test\_step](https://www.activepieces.com/docs/mcp/tools#ap_test_step) * [ap\_retry\_run](https://www.activepieces.com/docs/mcp/tools#ap_retry_run) [​](https://www.activepieces.com/docs/mcp/tools#discovery) Discovery ----------------------------------------------------------------------- These tools are always available (locked) and read-only. They help AI agents understand what’s in the project before making changes. ### [​](https://www.activepieces.com/docs/mcp/tools#ap_list_flows) ap\_list\_flows List all flows in the current project. | Input | Type | Required | Description | | --- | --- | --- | --- | | — | — | — | No inputs required | ### [​](https://www.activepieces.com/docs/mcp/tools#ap_flow_structure) ap\_flow\_structure Get the structure of a flow: step tree, configuration status, and valid insert locations. | Input | Type | Required | Description | | --- | --- | --- | --- | | `flowId` | string | Yes | The flow ID | ### [​](https://www.activepieces.com/docs/mcp/tools#ap_list_pieces) ap\_list\_pieces List available pieces with their actions and triggers. Required before adding or updating steps. | Input | Type | Required | Description | | --- | --- | --- | --- | | `searchQuery` | string | No | Filter pieces by name | | `includeActions` | boolean | No | Include action details | | `includeTriggers` | boolean | No | Include trigger details | ### [​](https://www.activepieces.com/docs/mcp/tools#ap_list_connections) ap\_list\_connections List OAuth/app connections in the project. Required before adding steps that need authentication. | Input | Type | Required | Description | | --- | --- | --- | --- | | — | — | — | No inputs required | ### [​](https://www.activepieces.com/docs/mcp/tools#ap_list_ai_models) ap\_list\_ai\_models List configured AI providers and their available models. Use this to discover valid `aiProviderModel` values for configuring Run Agent steps. | Input | Type | Required | Description | | --- | --- | --- | --- | | `provider` | string | No | Filter by provider (`openai`, `anthropic`, `google`, `azure`, `openrouter`, `activepieces`, `cloudflare-gateway`, `custom`) | ### [​](https://www.activepieces.com/docs/mcp/tools#ap_list_tables) ap\_list\_tables List all tables in the project with their fields (name, type, id) and row counts. | Input | Type | Required | Description | | --- | --- | --- | --- | | — | — | — | No inputs required | ### [​](https://www.activepieces.com/docs/mcp/tools#ap_find_records) ap\_find\_records Query records from a table with optional filtering. | Input | Type | Required | Description | | --- | --- | --- | --- | | `tableId` | string | Yes | The table ID | | `filters` | array | No | Filter conditions (fieldName, operator, value) | | `limit` | number | No | Max records (default 50, max 500) | **Filter operators:** `eq`, `neq`, `gt`, `gte`, `lt`, `lte`, `co` (contains), `exists`, `not_exists` ### [​](https://www.activepieces.com/docs/mcp/tools#ap_list_runs) ap\_list\_runs List recent flow runs with optional filters. | Input | Type | Required | Description | | --- | --- | --- | --- | | `flowId` | string | No | Filter by flow | | `status` | string | No | Filter by status (SUCCEEDED, FAILED, RUNNING, etc.) | | `limit` | number | No | Max runs (default 10, max 50) | ### [​](https://www.activepieces.com/docs/mcp/tools#ap_get_run) ap\_get\_run Get detailed results of a flow run including step-by-step outputs, errors, and durations. | Input | Type | Required | Description | | --- | --- | --- | --- | | `flowRunId` | string | Yes | The run ID | ### [​](https://www.activepieces.com/docs/mcp/tools#ap_setup_guide) ap\_setup\_guide Get step-by-step instructions for setting up connections or AI providers. Returns instructions for the user to follow in the UI — credentials are never handled through MCP. | Input | Type | Required | Description | | --- | --- | --- | --- | | `topic` | string | Yes | `connection` or `ai_provider` | | `pieceName` | string | No | For connections: which piece needs auth | * * * [​](https://www.activepieces.com/docs/mcp/tools#flow-management) Flow Management ----------------------------------------------------------------------------------- Create and manage flows. ### [​](https://www.activepieces.com/docs/mcp/tools#ap_create_flow) ap\_create\_flow Create a new empty flow. | Input | Type | Required | Description | | --- | --- | --- | --- | | `flowName` | string | Yes | Display name for the flow | ### [​](https://www.activepieces.com/docs/mcp/tools#ap_rename_flow) ap\_rename\_flow Rename an existing flow. | Input | Type | Required | Description | | --- | --- | --- | --- | | `flowId` | string | Yes | The flow ID | | `displayName` | string | Yes | New name | ### [​](https://www.activepieces.com/docs/mcp/tools#ap_change_flow_status) ap\_change\_flow\_status Enable or disable a flow. | Input | Type | Required | Description | | --- | --- | --- | --- | | `flowId` | string | Yes | The flow ID | | `status` | string | Yes | `ENABLED` or `DISABLED` | ### [​](https://www.activepieces.com/docs/mcp/tools#ap_lock_and_publish) ap\_lock\_and\_publish Publish the current draft of a flow. Validates all steps are configured. | Input | Type | Required | Description | | --- | --- | --- | --- | | `flowId` | string | Yes | The flow ID | * * * [​](https://www.activepieces.com/docs/mcp/tools#flow-building) Flow Building ------------------------------------------------------------------------------- Add, configure, and remove steps in a flow. ### [​](https://www.activepieces.com/docs/mcp/tools#ap_update_trigger) ap\_update\_trigger Set or update the trigger for a flow. | Input | Type | Required | Description | | --- | --- | --- | --- | | `flowId` | string | Yes | The flow ID | | `pieceName` | string | Yes | Piece name (e.g., `@activepieces/piece-gmail`) | | `pieceVersion` | string | Yes | Piece version (e.g., `~0.11.6`) | | `triggerName` | string | Yes | Trigger name from the piece | | `input` | object | No | Trigger configuration | | `auth` | string | No | Connection externalId | | `displayName` | string | No | Display name for the trigger step | ### [​](https://www.activepieces.com/docs/mcp/tools#ap_add_step) ap\_add\_step Add a new step to a flow. Creates a skeleton — configure it with `ap_update_step`. | Input | Type | Required | Description | | --- | --- | --- | --- | | `flowId` | string | Yes | The flow ID | | `parentStepName` | string | Yes | Step to insert after/into | | `stepLocationRelativeToParent` | string | Yes | `AFTER`, `INSIDE_LOOP`, or `INSIDE_BRANCH` | | `stepType` | string | Yes | `CODE`, `PIECE`, `LOOP_ON_ITEMS`, or `ROUTER` | | `displayName` | string | Yes | Step display name | | `pieceName` | string | No | For PIECE steps | | `pieceVersion` | string | No | For PIECE steps | | `actionName` | string | No | For PIECE steps | | `branchIndex` | number | No | For INSIDE\_BRANCH | ### [​](https://www.activepieces.com/docs/mcp/tools#ap_update_step) ap\_update\_step Update an existing step’s settings. Auto-fills default values for optional properties. | Input | Type | Required | Description | | --- | --- | --- | --- | | `flowId` | string | Yes | The flow ID | | `stepName` | string | Yes | Step name (e.g., `step_1`) | | `displayName` | string | No | New display name | | `input` | object | No | Step configuration | | `auth` | string | No | Connection externalId | | `actionName` | string | No | For PIECE steps | | `loopItems` | string | No | For LOOP steps | | `skip` | boolean | No | Skip this step | Use `{{stepName.output.field}}` syntax in input values to reference data from previous steps. ### [​](https://www.activepieces.com/docs/mcp/tools#ap_delete_step) ap\_delete\_step Delete a step from a flow. | Input | Type | Required | Description | | --- | --- | --- | --- | | `flowId` | string | Yes | The flow ID | | `stepName` | string | Yes | Step to delete | * * * [​](https://www.activepieces.com/docs/mcp/tools#router-&-branching) Router & Branching ----------------------------------------------------------------------------------------- Manage conditional branches in router steps. ### [​](https://www.activepieces.com/docs/mcp/tools#ap_add_branch) ap\_add\_branch Add a conditional branch to a router step. | Input | Type | Required | Description | | --- | --- | --- | --- | | `flowId` | string | Yes | The flow ID | | `stepName` | string | Yes | The router step name | ### [​](https://www.activepieces.com/docs/mcp/tools#ap_delete_branch) ap\_delete\_branch Delete a branch from a router step. | Input | Type | Required | Description | | --- | --- | --- | --- | | `flowId` | string | Yes | The flow ID | | `stepName` | string | Yes | The router step name | | `branchIndex` | number | Yes | Which branch to delete | * * * [​](https://www.activepieces.com/docs/mcp/tools#annotations) Annotations --------------------------------------------------------------------------- ### [​](https://www.activepieces.com/docs/mcp/tools#ap_manage_notes) ap\_manage\_notes Add, update, or delete canvas notes on a flow. | Input | Type | Required | Description | | --- | --- | --- | --- | | `flowId` | string | Yes | The flow ID | | `operation` | string | Yes | `ADD`, `UPDATE`, or `DELETE` | | `noteId` | string | No | Required for UPDATE/DELETE | | `content` | string | No | Note text (required for ADD) | | `color` | string | No | Note color | | `position` | object | No | `{x, y}` canvas position | | `size` | object | No | `{width, height}` note dimensions (default 200x200) | * * * [​](https://www.activepieces.com/docs/mcp/tools#tables) Tables ----------------------------------------------------------------- Full CRUD operations for the built-in Tables feature. Use field names (not IDs) when inserting or updating records. ### [​](https://www.activepieces.com/docs/mcp/tools#ap_create_table) ap\_create\_table Create a new table with an initial set of fields. | Input | Type | Required | Description | | --- | --- | --- | --- | | `name` | string | Yes | Table name | | `fields` | array | Yes | Fields: `{name, type, options?}` | **Field types:** `TEXT`, `NUMBER`, `DATE`, `STATIC_DROPDOWN` (requires `options` array) ### [​](https://www.activepieces.com/docs/mcp/tools#ap_delete_table) ap\_delete\_table Permanently delete a table and all its data. | Input | Type | Required | Description | | --- | --- | --- | --- | | `tableId` | string | Yes | The table ID | ### [​](https://www.activepieces.com/docs/mcp/tools#ap_manage_fields) ap\_manage\_fields Add, rename, or delete fields on a table. | Input | Type | Required | Description | | --- | --- | --- | --- | | `tableId` | string | Yes | The table ID | | `operation` | string | Yes | `ADD`, `UPDATE`, or `DELETE` | | `fieldId` | string | No | Required for UPDATE/DELETE | | `name` | string | No | Required for ADD/UPDATE | | `type` | string | No | Required for ADD | | `options` | array | No | For STATIC\_DROPDOWN | ### [​](https://www.activepieces.com/docs/mcp/tools#ap_insert_records) ap\_insert\_records Insert one or more records into a table. | Input | Type | Required | Description | | --- | --- | --- | --- | | `tableId` | string | Yes | The table ID | | `records` | array | Yes | 1-50 records, each mapping field names to values | ### [​](https://www.activepieces.com/docs/mcp/tools#ap_update_record) ap\_update\_record Update specific cells in a record. Only specified fields are changed. | Input | Type | Required | Description | | --- | --- | --- | --- | | `tableId` | string | Yes | The table ID | | `recordId` | string | Yes | The record ID | | `fields` | object | Yes | Field names to new values | ### [​](https://www.activepieces.com/docs/mcp/tools#ap_delete_records) ap\_delete\_records Permanently delete one or more records. | Input | Type | Required | Description | | --- | --- | --- | --- | | `recordIds` | array | Yes | Record IDs to delete | * * * [​](https://www.activepieces.com/docs/mcp/tools#testing-&-runs) Testing & Runs --------------------------------------------------------------------------------- Test flows, inspect results, and retry failures. Test tools poll for up to 120 seconds and return step-by-step results. ### [​](https://www.activepieces.com/docs/mcp/tools#ap_test_flow) ap\_test\_flow Test a flow end-to-end in the test environment using saved sample data. | Input | Type | Required | Description | | --- | --- | --- | --- | | `flowId` | string | Yes | The flow ID | The flow must have a configured trigger. The tool validates this before running and returns a clear error if not. ### [​](https://www.activepieces.com/docs/mcp/tools#ap_test_step) ap\_test\_step Test a single step within a flow. Runs all steps up to and including the target step. | Input | Type | Required | Description | | --- | --- | --- | --- | | `flowId` | string | Yes | The flow ID | | `stepName` | string | Yes | Step to test | ### [​](https://www.activepieces.com/docs/mcp/tools#ap_retry_run) ap\_retry\_run Retry a failed flow run. | Input | Type | Required | Description | | --- | --- | --- | --- | | `flowRunId` | string | Yes | The failed run ID | | `strategy` | string | Yes | `FROM_FAILED_STEP` or `ON_LATEST_VERSION` | * **FROM\_FAILED\_STEP**: Resume from where it failed, keeping previous step outputs * **ON\_LATEST\_VERSION**: Re-run the entire flow with the current published version [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/mcp/tools.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/mcp/tools) [MCP Server](https://www.activepieces.com/docs/mcp/overview) [i18n Translations](https://www.activepieces.com/docs/about/i18n) ⌘I --- # Piece Auth - Activepieces [Skip to main content](https://www.activepieces.com/docs/build-pieces/piece-reference/authentication#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Piece Reference Piece Auth [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Secret Text](https://www.activepieces.com/docs/build-pieces/piece-reference/authentication#secret-text) * [Username and Password](https://www.activepieces.com/docs/build-pieces/piece-reference/authentication#username-and-password) * [Custom](https://www.activepieces.com/docs/build-pieces/piece-reference/authentication#custom) * [OAuth2](https://www.activepieces.com/docs/build-pieces/piece-reference/authentication#oauth2) Piece authentication is used to gather user credentials and securely store them for future use in different flows. The authentication must be defined as the `auth` parameter in the `createPiece`, `createTrigger`, and `createAction` functions. This requirement ensures that the type of authentication can be inferred correctly in triggers and actions. The auth parameter for `createPiece`, `createTrigger`, and `createAction` functions can take an array, but you cannot have more than one auth property of the same type, i.e two OAUTH2 properties. ### [​](https://www.activepieces.com/docs/build-pieces/piece-reference/authentication#secret-text) Secret Text This authentication collects sensitive information, such as passwords or API keys. It is displayed as a masked input field. **Example:** PieceAuth.SecretText({ displayName: 'API Key', description: 'Enter your API key', required: true, // Optional Validation validate: async ({auth}) => { if(auth.startsWith('sk_')){ return { valid: true, } } return { valid: false, error: 'Invalid Api Key' } } }) ### [​](https://www.activepieces.com/docs/build-pieces/piece-reference/authentication#username-and-password) Username and Password This authentication collects a username and password as separate fields. **Example:** PieceAuth.BasicAuth({ displayName: 'Credentials', description: 'Enter your username and password', required: true, username: { displayName: 'Username', description: 'Enter your username', }, password: { displayName: 'Password', description: 'Enter your password', }, // Optional Validation validate: async ({auth}) => { if(auth){ return { valid: true, } } return { valid: false, error: 'Invalid Api Key' } } }) ### [​](https://www.activepieces.com/docs/build-pieces/piece-reference/authentication#custom) Custom This authentication allows for custom authentication by collecting specific properties, such as a base URL and access token. **Example:** PieceAuth.CustomAuth({ displayName: 'Custom Authentication', description: 'Enter custom authentication details', props: { base_url: Property.ShortText({ displayName: 'Base URL', description: 'Enter the base URL', required: true, }), access_token: PieceAuth.SecretText({ displayName: 'Access Token', description: 'Enter the access token', required: true }) }, // Optional Validation validate: async ({auth}) => { if(auth){ return { valid: true, } } return { valid: false, error: 'Invalid Api Key' } }, required: true }) ### [​](https://www.activepieces.com/docs/build-pieces/piece-reference/authentication#oauth2) OAuth2 This authentication collects OAuth2 authentication details, including the authentication URL, token URL, and scope. **Example:** PieceAuth.OAuth2({ displayName: 'OAuth2 Authentication', grantType: OAuth2GrantType.AUTHORIZATION_CODE, required: true, authUrl: 'https://example.com/auth', tokenUrl: 'https://example.com/token', scope: ['read', 'write'] }) Please note `OAuth2GrantType.CLIENT_CREDENTIALS` is also supported for service-based authentication. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/build-pieces/piece-reference/authentication.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/build-pieces/piece-reference/authentication) [Private](https://www.activepieces.com/docs/build-pieces/sharing-pieces/private) [Overview](https://www.activepieces.com/docs/build-pieces/piece-reference/triggers/overview) ⌘I --- # Our Hiring Process - Activepieces [Skip to main content](https://www.activepieces.com/docs/handbook/hiring/hiring#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Hiring Our Hiring Process [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Interviewing Tips](https://www.activepieces.com/docs/handbook/hiring/hiring#interviewing-tips) Engineers are the majority of the Activepieces team, and we are always looking for highly talented product engineers. 1 [](https://www.activepieces.com/docs/handbook/hiring/hiring#) Technical Interview Here, you’ll face a real challenge from Activepieces. We’ll guide you through it to see how you solve problems. 2 [](https://www.activepieces.com/docs/handbook/hiring/hiring#) Product & Leadership Interview We’ll chat about your past experiences and how you design products. It’s like having a friendly conversation where we reflect on what you’ve done before. 3 [](https://www.activepieces.com/docs/handbook/hiring/hiring#) Work Trial You’ll do open source task for one day. This open source contribution task help us understand how well we work together. [​](https://www.activepieces.com/docs/handbook/hiring/hiring#interviewing-tips) Interviewing Tips ---------------------------------------------------------------------------------------------------- Every interview should make us say **HELL YES**. If not, we’ll kindly pass. **Avoid Bias:** Get opinions from others to make fair decisions. **Speak Up Early:** If you’re unsure about something, ask or test it right away. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/handbook/hiring/hiring.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/handbook/hiring/hiring) [Teams](https://www.activepieces.com/docs/handbook/team) [Our Roles & Levels](https://www.activepieces.com/docs/handbook/hiring/levels) ⌘I --- # Engineering Workflow - Activepieces [Skip to main content](https://www.activepieces.com/docs/handbook/engineering/onboarding/how-we-work#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Engineering Onboarding Engineering Workflow [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Sprints](https://www.activepieces.com/docs/handbook/engineering/onboarding/how-we-work#sprints) * [Pull Requests](https://www.activepieces.com/docs/handbook/engineering/onboarding/how-we-work#pull-requests) * [Planning is everyone’s job.](https://www.activepieces.com/docs/handbook/engineering/onboarding/how-we-work#planning-is-everyone%E2%80%99s-job) Activepieces work is based on one-week sprints, as priorities change fast, the sprint has to be short to adapt. [​](https://www.activepieces.com/docs/handbook/engineering/onboarding/how-we-work#sprints) Sprints ----------------------------------------------------------------------------------------------------- Sprints are shared publicly on our GitHub account. This would give everyone visibility into what we are working on. * There should be a GitHub issue for the sprint set up in advance that outlines the changes. * Each _individual_ should come prepared with specific suggestions for what they will work on over the next sprint. **if you’re in an engineering role, no one will dictate to you what to build – it is up to you to drive this.** * Teams generally meet once a week to pick the **priorities** together. * Everyone in the team should attend the sprint planning. * Anyone can comment on the sprint issue before or after the sprint. [​](https://www.activepieces.com/docs/handbook/engineering/onboarding/how-we-work#pull-requests) Pull Requests ----------------------------------------------------------------------------------------------------------------- When it comes to code review, we have a few guidelines to ensure efficiency: * Create a pull request in draft state as soon as possible. * Be proactive and review other people’s pull requests. Don’t wait for someone to ask for your review; it’s your responsibility. * Assign only one reviewer to your pull request. * Add the PR to the current project (sprint) so we can keep track of unmerged PRs at the end of each sprint. * It is the **responsibility** of the **PR owner** to draft the test scenarios within the PR description. Upon review, the reviewer may assume that these scenarios have been tested and provide additional suggestions for scenarios. * Large, incomplete features should be broken down into smaller tasks and continuously merged into the main branch. [​](https://www.activepieces.com/docs/handbook/engineering/onboarding/how-we-work#planning-is-everyone%E2%80%99s-job) Planning is everyone’s job. ---------------------------------------------------------------------------------------------------------------------------------------------------- Every engineer is responsible for discovering bugs/opportunities and bringing them up in the sprint to convert them into actionable tasks. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/handbook/engineering/onboarding/how-we-work.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/handbook/engineering/onboarding/how-we-work) [Onboarding Check List](https://www.activepieces.com/docs/handbook/engineering/onboarding/onboarding-check-list) [On-Call](https://www.activepieces.com/docs/handbook/engineering/onboarding/on-call) ⌘I --- # Database Migrations - Activepieces [Skip to main content](https://www.activepieces.com/docs/handbook/engineering/playbooks/database-migration#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Engineering Playbooks Database Migrations [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Database Support](https://www.activepieces.com/docs/handbook/engineering/playbooks/database-migration#database-support) * [Editions](https://www.activepieces.com/docs/handbook/engineering/playbooks/database-migration#editions) * [How To Generate](https://www.activepieces.com/docs/handbook/engineering/playbooks/database-migration#how-to-generate) * [PGlite Compatibility](https://www.activepieces.com/docs/handbook/engineering/playbooks/database-migration#pglite-compatibility) Activepieces uses TypeORM as its database driver in Node.js. We support two database types across different editions of our platform. The database migration files contain both what to do to migrate (up method) and what to do when rolling back (down method). Read more about TypeORM migrations here: [https://orkhan.gitbook.io/typeorm/docs/migrations](https://orkhan.gitbook.io/typeorm/docs/migrations) [​](https://www.activepieces.com/docs/handbook/engineering/playbooks/database-migration#database-support) Database Support ----------------------------------------------------------------------------------------------------------------------------- * PostgreSQL * PGlite **Why Do we have PGlite?** We support PGlite to simplify development and self-hosting. It’s particularly helpful for: * Developers creating pieces who want a quick setup * Self-hosters using platforms to manage docker images but doesn’t support docker compose. PGlite is a lightweight PostgreSQL implementation that runs embedded, so migrations are compatible with PostgreSQL. [​](https://www.activepieces.com/docs/handbook/engineering/playbooks/database-migration#editions) Editions ------------------------------------------------------------------------------------------------------------- * **Enterprise & Cloud Edition** (Must use PostgreSQL) * **Community Edition** (Can use PostgreSQL or PGlite) ### [​](https://www.activepieces.com/docs/handbook/engineering/playbooks/database-migration#how-to-generate) How To Generate 1 [](https://www.activepieces.com/docs/handbook/engineering/playbooks/database-migration#) Setup AP\_DB\_TYPE Set the `AP_DB_TYPE` environment variable to `POSTGRES` after making sure have latest state by running Activepieces first. 2 [](https://www.activepieces.com/docs/handbook/engineering/playbooks/database-migration#) Generate Migration Run the migration generation command: npx turbo run db-migration --filter=api -- --name= Replace `` with a descriptive name for your migration. 3 [](https://www.activepieces.com/docs/handbook/engineering/playbooks/database-migration#) Update Migration File The command will generate a new migration file in `packages/server/api/src/app/database/migration/postgres/`.The generated file uses `MigrationInterface` — you need to update it: 1. Change `implements MigrationInterface` to `implements Migration` 2. Update the import from `typeorm` to import `Migration` from `../../migration` 3. Add `breaking = false` (or `true` if the migration drops columns/tables or transforms data irreversibly) 4. Add `release = ''` matching the upcoming release version (check `package.json` in the repo root) 5. Implement the `down()` method with queries that reverse the `up()` changes (unless `breaking = true`) 6. Register it in `postgres-connection.ts` import { QueryRunner } from 'typeorm' import { Migration } from '../../migration' export class AddMyColumn1234567890 implements Migration { name = 'AddMyColumn1234567890' breaking = false release = '0.78.0' public async up(queryRunner: QueryRunner): Promise { await queryRunner.query(`ALTER TABLE "project" ADD COLUMN "description" text`) } public async down(queryRunner: QueryRunner): Promise { await queryRunner.query(`ALTER TABLE "project" DROP COLUMN "description"`) } } CI will fail if `breaking`, `release`, or `down()` are missing on new migrations. [​](https://www.activepieces.com/docs/handbook/engineering/playbooks/database-migration#pglite-compatibility) PGlite Compatibility ------------------------------------------------------------------------------------------------------------------------------------- While PGlite is mostly PostgreSQL-compatible, some features are not supported. When using features like `CONCURRENTLY` for index operations, you need to conditionally handle PGlite: import { QueryRunner } from 'typeorm' import { Migration } from '../../migration' import { system } from '../../../helper/system/system' import { AppSystemProp } from '../../../helper/system/system-props' import { DatabaseType } from '../../database-type' const databaseType = system.get(AppSystemProp.DB_TYPE) const isPGlite = databaseType === DatabaseType.PGLITE export class AddMyIndex1234567890 implements Migration { name = 'AddMyIndex1234567890' breaking = false release = '0.78.0' transaction = false // Required when using CONCURRENTLY public async up(queryRunner: QueryRunner): Promise { if (isPGlite) { await queryRunner.query(`CREATE INDEX "idx_name" ON "table" ("column")`) } else { await queryRunner.query(`CREATE INDEX CONCURRENTLY "idx_name" ON "table" ("column")`) } } public async down(queryRunner: QueryRunner): Promise { if (isPGlite) { await queryRunner.query(`DROP INDEX "idx_name"`) } else { await queryRunner.query(`DROP INDEX CONCURRENTLY "idx_name"`) } } } `CREATE INDEX CONCURRENTLY` and `DROP INDEX CONCURRENTLY` are not supported in PGlite because PGLite is a single user/connection database. Always add a check for PGlite when using these operations. Always test your migrations by running them both up and down to ensure they work as expected. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/handbook/engineering/playbooks/database-migration.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/handbook/engineering/playbooks/database-migration) [Cloud Infrastructure](https://www.activepieces.com/docs/handbook/engineering/playbooks/infrastructure) [Feature Announcement](https://www.activepieces.com/docs/handbook/engineering/playbooks/product-announcement) ⌘I --- # Benchmark - Activepieces [Skip to main content](https://www.activepieces.com/docs/install/architecture/benchmark#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Architecture Benchmark [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [What’s Measured](https://www.activepieces.com/docs/install/architecture/benchmark#what%E2%80%99s-measured) * [Results](https://www.activepieces.com/docs/install/architecture/benchmark#results) * [Test Environment](https://www.activepieces.com/docs/install/architecture/benchmark#test-environment) * [How to Reproduce](https://www.activepieces.com/docs/install/architecture/benchmark#how-to-reproduce) * [Via GitHub Actions UI](https://www.activepieces.com/docs/install/architecture/benchmark#via-github-actions-ui) * [Via CLI](https://www.activepieces.com/docs/install/architecture/benchmark#via-cli) [​](https://www.activepieces.com/docs/install/architecture/benchmark#what%E2%80%99s-measured) What’s Measured ---------------------------------------------------------------------------------------------------------------- The benchmark tests end-to-end webhook flow execution: an HTTP request hits a **Catch Webhook** trigger, runs a **Code** action, and returns a response via **Return Response**. This measures the full request lifecycle including routing, execution, and response delivery. [​](https://www.activepieces.com/docs/install/architecture/benchmark#results) Results ---------------------------------------------------------------------------------------- | Configuration | Throughput (req/s) | Mean Latency | P50 | P99 | | --- | --- | --- | --- | --- | | 1 App, 2 Workers | 95.1 | 20.8 ms | 15.4 ms | 62.7 ms | | 2 Apps, 4 Workers | 167.6 | 23.4 ms | 20.0 ms | 65.1 ms | | 3 Apps, 6 Workers | 231.8 | 24.8 ms | 21.2 ms | 71.5 ms | | 1 App, 4 Workers | 174.5 | 22.4 ms | 19.0 ms | 56.7 ms | | 2 Apps, 8 Workers | 286.5 | 26.0 ms | 22.3 ms | 89.5 ms | | 3 Apps, 12 Workers | 336.6 | 35.1 ms | 34.8 ms | 51.5 ms | [​](https://www.activepieces.com/docs/install/architecture/benchmark#test-environment) Test Environment ---------------------------------------------------------------------------------------------------------- * **Runner**: `depot-ubuntu-24.04-16` (16 cores) * **App container**: 2 CPU / 4 GB memory * **Worker container**: 0.5 CPU / 1 GB memory * **Execution mode**: `SANDBOX_CODE_ONLY` * **Rate limiter**: Disabled (`AP_PROJECT_RATE_LIMITER_ENABLED=false`) * **Total requests**: 500 per configuration [​](https://www.activepieces.com/docs/install/architecture/benchmark#how-to-reproduce) How to Reproduce ---------------------------------------------------------------------------------------------------------- ### [​](https://www.activepieces.com/docs/install/architecture/benchmark#via-github-actions-ui) Via GitHub Actions UI 1. Go to the **Actions** tab in the repository 2. Select the **Benchmark** workflow 3. Click **Run workflow** 4. Optionally adjust `total_requests` (default: 500) 5. All 6 configurations (1:2 and 1:4 ratios at 1x/2x/3x scale) run in parallel automatically ### [​](https://www.activepieces.com/docs/install/architecture/benchmark#via-cli) Via CLI gh workflow run benchmark.yml After the workflow completes, check the **summary** job for a combined comparison table. These benchmarks run in `SANDBOX_CODE_ONLY` mode. This does **not** represent the performance of Activepieces Cloud, which uses a different sandboxing mechanism to support multi-tenancy. For more information, see [Sandboxing](https://www.activepieces.com/docs/install/architecture/workers#sandboxing) . [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/install/architecture/benchmark.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/install/architecture/benchmark) [Engine](https://www.activepieces.com/docs/install/architecture/engine) ⌘I --- # Overview - Activepieces [Skip to main content](https://www.activepieces.com/docs/install/overview#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Get Started Overview [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Recommended Options](https://www.activepieces.com/docs/install/overview#recommended-options) * [Other Options](https://www.activepieces.com/docs/install/overview#other-options) * [Cloud Edition](https://www.activepieces.com/docs/install/overview#cloud-edition) Activepieces Community Edition can be deployed using **Docker**, **Docker Compose**, and **Kubernetes**. Community Edition is **free** and **open source**.You can read the difference between the editions [here](https://www.activepieces.com/pricing) . [​](https://www.activepieces.com/docs/install/overview#recommended-options) Recommended Options -------------------------------------------------------------------------------------------------- Docker (Fastest) ---------------- Deploy Activepieces as a single Docker container using the PGLite database. Docker Compose -------------- Deploy Activepieces with **Redis** and **PostgreSQL** setup. [​](https://www.activepieces.com/docs/install/overview#other-options) Other Options -------------------------------------------------------------------------------------- Helm ---- Install on Kubernetes with Helm. Railway ------- 1-Click Install on Railway. Easypanel --------- 1-Click Install with Easypanel template, maintained by the community. Elestio ------- 1-Click Install on Elestio. AWS (Pulumi) ------------ Install on AWS with Pulumi. GCP --- Install on GCP as a VM template. PikaPods -------- Instantly run on PikaPods from $2.9/month. RepoCloud --------- Easily install on RepoCloud using this template, maintained by the community. Zeabur ------ 1-Click Install on Zeabur. [​](https://www.activepieces.com/docs/install/overview#cloud-edition) Cloud Edition -------------------------------------------------------------------------------------- Activepieces Cloud ------------------ This is the fastest option. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/install/overview.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/install/overview) [Docker](https://www.activepieces.com/docs/install/options/docker) ⌘I --- # Truncated Logs - Activepieces [Skip to main content](https://www.activepieces.com/docs/install/troubleshooting/truncated-logs#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Troubleshooting Truncated Logs [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Overview](https://www.activepieces.com/docs/install/troubleshooting/truncated-logs#overview) * [How It Works](https://www.activepieces.com/docs/install/troubleshooting/truncated-logs#how-it-works) * [Known Limitation](https://www.activepieces.com/docs/install/troubleshooting/truncated-logs#known-limitation) * [Solution](https://www.activepieces.com/docs/install/troubleshooting/truncated-logs#solution) [​](https://www.activepieces.com/docs/install/troubleshooting/truncated-logs#overview) Overview -------------------------------------------------------------------------------------------------- If you see `(truncated)` in the flow run logs, it means the logs have exceeded the maximum allowed file size. [​](https://www.activepieces.com/docs/install/troubleshooting/truncated-logs#how-it-works) How It Works ---------------------------------------------------------------------------------------------------------- There is a current limitation where the log file of a run cannot grow past a certain size. When this limit is reached, the engine automatically removes the largest keys in the JSON output until it fits within the allowed size. **This does not affect flow execution.** Your flow will continue to run normally even when logs are truncated. [​](https://www.activepieces.com/docs/install/troubleshooting/truncated-logs#known-limitation) Known Limitation ------------------------------------------------------------------------------------------------------------------ There is one known issue with truncated logs: If you **pause** a flow, then **resume** it, and the resumed step references data from a truncated step, the flow will fail because the referenced data is no longer available in the logs. [​](https://www.activepieces.com/docs/install/troubleshooting/truncated-logs#solution) Solution -------------------------------------------------------------------------------------------------- You can increase the `AP_MAX_FILE_SIZE_MB` environment variable to a higher value to allow larger log files: AP_MAX_FILE_SIZE_MB=50 **Future Improvement:** There is a planned enhancement to change this limit from per-log-file to per-step, which will provide more granular control over log sizes. This feature is currently in the planning phase. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/install/troubleshooting/truncated-logs.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/install/troubleshooting/truncated-logs) [Reset Password](https://www.activepieces.com/docs/install/troubleshooting/reset-password) [Websocket Issues](https://www.activepieces.com/docs/install/troubleshooting/websocket-issues) ⌘I --- # Overview - Activepieces [Skip to main content](https://www.activepieces.com/docs/handbook/customer-support/overview#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Customer Support Overview [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Support Schedule](https://www.activepieces.com/docs/handbook/customer-support/overview#support-schedule) * [Support Channels](https://www.activepieces.com/docs/handbook/customer-support/overview#support-channels) * [Support Hours & SLA:](https://www.activepieces.com/docs/handbook/customer-support/overview#support-hours-%26-sla) At Activepieces, we take a unique approach to customer support. Instead of having dedicated support staff, our full-time engineers handle support requests on rotation. This ensures you get expert technical help from the people who build the product. ### [​](https://www.activepieces.com/docs/handbook/customer-support/overview#support-schedule) Support Schedule Our on-call engineer handles customer support as part of their rotation. For more details about how this works, check out our on-call documentation. ### [​](https://www.activepieces.com/docs/handbook/customer-support/overview#support-channels) Support Channels * Community Support * GitHub Issues: We actively monitor and respond to issues on our [GitHub repository](https://github.com/activepieces/activepieces) * Community Forum: We engage with users on our [Community Platform](https://community.activepieces.com/) to provide help and gather feedback * Email: only for account related issues, delete account request or billing issues. * Enterprise Support * Enterprise customers receive dedicated support through Slack * We use [Pylon](https://usepylon.com/) to manage support tickets and customer channels efficiently * For detailed information on using Pylon, see our [Pylon Guide](https://www.activepieces.com/docs/handbook/customer-support/pylon) ### [​](https://www.activepieces.com/docs/handbook/customer-support/overview#support-hours-&-sla) Support Hours & SLA: Work in progress—coming soon! [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/handbook/customer-support/overview.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/handbook/customer-support/overview) [Our Compensation](https://www.activepieces.com/docs/handbook/hiring/compensation) [Tone & Communication](https://www.activepieces.com/docs/handbook/customer-support/tone) ⌘I --- # Deployment Checklist - Activepieces [Skip to main content](https://www.activepieces.com/docs/install/configuration/overview#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Configuration Deployment Checklist [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) This tutorial assumes you have already followed the quick start guide using one of the installation methods listed in [Install Overview](https://www.activepieces.com/docs/install/overview) . In this section, we will go through the checklist after using one of the installation methods and ensure that your deployment is production-ready. Decide on Sandboxing You should decide on the sandboxing mode for your deployment based on your use case and whether it is multi-tenant or not. Here is a simplified way to decide: **Friendly Tip #1**: For multi-tenant setups, use V8/Code Sandboxing.It is secure and does not require privileged Docker access in Kubernetes. Privileged Docker is usually not allowed to prevent root escalation threats. **Friendly Tip #2**: For single-tenant setups, use No Sandboxing. It is faster and does not require privileged Docker access. | Name | Supports NPM in Code Piece | Requires Docker to be Privileged | Performance | Secure for Multi Tenant | Reusable Workers | Environment Variable | | --- | --- | --- | --- | --- | --- | --- | | V8/Code Sandboxing | ❌ | No | Fast & Lightweight | ✅ | ✅ | Set `AP_EXECUTION_MODE` to `SANDBOX_CODE_ONLY` | | No Sandboxing | ✅ | No | Fast & Lightweight | ❌ | ✅ | Set `AP_EXECUTION_MODE` to `UNSANDBOXED` | | Kernel Namespaces Sandboxing | ✅ | Yes | Slow & CPU Intensive | ✅ | ❌ | Set `AP_EXECUTION_MODE` to `SANDBOX_PROCESS` | | Combined Sandboxing | ❌ | Yes | Medium & CPU Intensive | ✅ | ✅ | Set `AP_EXECUTION_MODE` to `SANDBOX_CODE_AND_PROCESS` | More Information at [Sandboxing & Workers](https://www.activepieces.com/docs/install/architecture/workers#sandboxing) Enterprise Edition (Optional) For licensing inquiries regarding the self-hosted enterprise edition, please reach out to `[[email protected]](https://www.activepieces.com/cdn-cgi/l/email-protection) `, as the code and Docker image are not covered by the MIT license. You can request a trial key from within the app or in the cloud by filling out the form. Alternatively, you can contact sales at [https://www.activepieces.com/sales](https://www.activepieces.com/sales) . Please know that when your trial runs out, all enterprise [features](https://www.activepieces.com/pricing) will be shut down meaning any user other than the platform admin will be deactivated, and your private pieces will be deleted, which could result in flows using them to fail. Before version 0.73.0, you cannot switch from CE to EE directly We suggest upgrading to 0.73.0 with the same edition first, then switch `AP_EDITION`. Enterprise edition must use `PostgreSQL` as the database backend and `Redis` as the Queue System. [​](https://www.activepieces.com/docs/install/configuration/overview#installation) Installation -------------------------------------------------------------------------------------------------- 1. Set the `AP_EDITION` environment variable to `ee`. 2. Set the `AP_EXECUTION_MODE` to anything other than `UNSANDBOXED`, check the above section. 3. Once your instance is up, activate the license key by going to **Platform Admin -> Setup -> License Keys**. ![Activation License Key](https://mintcdn.com/activepieces/ki8mFooo8mAmhMdP/resources/screenshots/activation-license-key-settings.png?w=2500&fit=max&auto=format&n=ki8mFooo8mAmhMdP&q=85&s=300627457e14ab17abfed9ca7eb8e8f7) Setup HTTPS Setting up HTTPS is highly recommended because many services require webhook URLs to be secure (HTTPS). This helps prevent potential errors.To set up SSL, you can use any reverse proxy. For a step-by-step guide, check out our example using [Nginx](https://www.activepieces.com/docs/install/guides/setup-ssl) . Troubleshooting (Optional) If you encounter any issues, check out our [Troubleshooting](https://www.activepieces.com/docs/install/troubleshooting/websocket-issues) guide. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/install/configuration/overview.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/install/configuration/overview) [Elestio](https://www.activepieces.com/docs/install/options/elestio) [Environment Variables](https://www.activepieces.com/docs/install/configuration/environment-variables) ⌘I --- # How to handle Requests - Activepieces [Skip to main content](https://www.activepieces.com/docs/handbook/customer-support/handle-requests#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Customer Support How to handle Requests [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Ticket fields](https://www.activepieces.com/docs/handbook/customer-support/handle-requests#ticket-fields) * [Requests](https://www.activepieces.com/docs/handbook/customer-support/handle-requests#requests) * [Type 1: Quick Fixes & Urgent Issues](https://www.activepieces.com/docs/handbook/customer-support/handle-requests#type-1-quick-fixes-%26-urgent-issues) * [Type 2: Complex Technical Issues](https://www.activepieces.com/docs/handbook/customer-support/handle-requests#type-2-complex-technical-issues) * [Type 3: Feature Enhancement Requests](https://www.activepieces.com/docs/handbook/customer-support/handle-requests#type-3-feature-enhancement-requests) * [Type 4: Business Case](https://www.activepieces.com/docs/handbook/customer-support/handle-requests#type-4-business-case) * [Frequently Asked Questions](https://www.activepieces.com/docs/handbook/customer-support/handle-requests#frequently-asked-questions) As a support engineer, you should: * Fix the urgent issues (please see the definition below) * Open tickets for all non-urgent issues. **(DO NOT INCLUDE ANY SENSITIVE INFO IN ISSUE)** * Keep customers updated * Write clear ticket descriptions * Help the team prioritize work * Route issues to the right people Our support hours are from **8 am to 6 pm New York time (ET)**. Please keep this in mind when communicating response expectations to customers. ### [​](https://www.activepieces.com/docs/handbook/customer-support/handle-requests#ticket-fields) Ticket fields When handling support tickets, ensure you set the appropriate status and priority to help with ticket management and response time: ### [​](https://www.activepieces.com/docs/handbook/customer-support/handle-requests#requests) Requests ### [​](https://www.activepieces.com/docs/handbook/customer-support/handle-requests#type-1-quick-fixes-&-urgent-issues) Type 1: Quick Fixes & Urgent Issues * Understand the issue and how urgent it is. * Open a ticket for on linear with “require attention” label and assign someone. ### [​](https://www.activepieces.com/docs/handbook/customer-support/handle-requests#type-2-complex-technical-issues) Type 2: Complex Technical Issues * Assess the issue and determine its urgency. * Always create a Linear issue for the feature request, and send it to the customer. * Leave a comment on the Linear issue with an estimated completion time. ### [​](https://www.activepieces.com/docs/handbook/customer-support/handle-requests#type-3-feature-enhancement-requests) Type 3: Feature Enhancement Requests * Always create a Linear issue for the feature request and send it to the customer. * Evaluate the request and dig deeper into what the customer is trying to solve, then either evaluate and open a new ticket or append to an existing ticket in the backlog. * Add it to our roadmap and discuss it with the team. ### [​](https://www.activepieces.com/docs/handbook/customer-support/handle-requests#type-4-business-case) Type 4: Business Case * These cases involve purchasing new features, billing, or discussing agreements. * Change the Team to “Success” on Pylon. * Tag someone from the Success Team to handle it. New features will always have the status “Backlog”. Please make sure to communicate that we will discuss and address it in future production cycles so the customer doesn’t expect immediate action. ### [​](https://www.activepieces.com/docs/handbook/customer-support/handle-requests#frequently-asked-questions) Frequently Asked Questions What if I don't understand the feature or issue? If you don’t understand the feature or issue, reach out to the customer for clarification. It’s important to fully grasp the problem before proceeding. You can also consult with your team for additional insights. How do I prioritize multiple urgent issues? When faced with multiple urgent issues, assess the impact of each on the customer and the system. Prioritize based on severity, number of affected users, and potential risks. Communicate with your team to ensure alignment on priorities. What if there is an angry or abusive customer? If you encounter an abusive or rude customer, escalate the issue to Mohammad AbuAboud or Ashraf Samhouri. It’s important to handle such situations with care and ensure that the customer feels heard while maintaining a respectful and professional demeanor. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/handbook/customer-support/handle-requests.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/handbook/customer-support/handle-requests) [How to use Pylon](https://www.activepieces.com/docs/handbook/customer-support/pylon) [Overview](https://www.activepieces.com/docs/handbook/engineering/overview) ⌘I --- # Activepieces Handbook - Activepieces [Skip to main content](https://www.activepieces.com/docs/handbook/overview#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Handbook Activepieces Handbook [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) Welcome to the Activepieces Handbook! This guide serves as a complete resource for understanding our organization. Inside, you’ll find detailed sections covering various aspects of our internal processes and policies. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/handbook/overview.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/handbook/overview) [Teams](https://www.activepieces.com/docs/handbook/team) ⌘I --- # Our Compensation - Activepieces [Skip to main content](https://www.activepieces.com/docs/handbook/hiring/compensation#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Hiring Our Compensation [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) The packages include three factors for the salary: * **Role**: The specific position and responsibilities of the employee. * **Location**: The geographical area where the employee is based. * **Level**: The seniority and experience level of the employee. Salaries are fixed and based on levels and seniority, not negotiation. This ensures fair pay for everyone. Salaries are updated based on market trends and the company’s performance. It’s easier to justify raises when the business is great. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/handbook/hiring/compensation.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/handbook/hiring/compensation) [Our Team Structure](https://www.activepieces.com/docs/handbook/hiring/team) [Overview](https://www.activepieces.com/docs/handbook/customer-support/overview) ⌘I --- # Cloud Infrastructure - Activepieces [Skip to main content](https://www.activepieces.com/docs/handbook/engineering/playbooks/infrastructure#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Engineering Playbooks Cloud Infrastructure [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Hosting Providers](https://www.activepieces.com/docs/handbook/engineering/playbooks/infrastructure#hosting-providers) * [Environments](https://www.activepieces.com/docs/handbook/engineering/playbooks/infrastructure#environments) * [Observability: Logs & Telemetry](https://www.activepieces.com/docs/handbook/engineering/playbooks/infrastructure#observability-logs-%26-telemetry) * [Kamal for Deployment](https://www.activepieces.com/docs/handbook/engineering/playbooks/infrastructure#kamal-for-deployment) The playbooks are private, Please ask your team for access. Our infrastructure stack includes several key components to monitor, deploy, and manage our services effectively. [​](https://www.activepieces.com/docs/handbook/engineering/playbooks/infrastructure#hosting-providers) Hosting Providers --------------------------------------------------------------------------------------------------------------------------- We use two main hosting providers: * **DigitalOcean**: Hosts our databases including Redis and PostgreSQL. * **Hetzner**: Provides the machines that run our services. [​](https://www.activepieces.com/docs/handbook/engineering/playbooks/infrastructure#environments) Environments ----------------------------------------------------------------------------------------------------------------- | Environment | Domain | Kamal Config | | --- | --- | --- | | Staging | `stg.activepieces.com` | `mrsk/stg` | | Production | `cloud.activepieces.com` | `mrsk/prod` | Staging receives every merge to `main` and is promoted to production daily at 9 AM UTC. See the [Releases & Deployment](https://www.activepieces.com/docs/handbook/engineering/playbooks/releases) playbook for the full flow. [​](https://www.activepieces.com/docs/handbook/engineering/playbooks/infrastructure#observability-logs-&-telemetry) Observability: Logs & Telemetry ------------------------------------------------------------------------------------------------------------------------------------------------------ We collect logs and telemetry from all services using **HyperDX**. [​](https://www.activepieces.com/docs/handbook/engineering/playbooks/infrastructure#kamal-for-deployment) Kamal for Deployment --------------------------------------------------------------------------------------------------------------------------------- We use **Kamal** as a deployment tool to deploy our Docker containers to staging and production with zero downtime. Kamal configs live on the devops machine under `mrsk/stg` and `mrsk/prod`. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/handbook/engineering/playbooks/infrastructure.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/handbook/engineering/playbooks/infrastructure) [Canary Deployment](https://www.activepieces.com/docs/handbook/engineering/playbooks/canary-deployment) [Database Migrations](https://www.activepieces.com/docs/handbook/engineering/playbooks/database-migration) ⌘I --- # Tone & Communication - Activepieces [Skip to main content](https://www.activepieces.com/docs/handbook/customer-support/tone#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Customer Support Tone & Communication [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Casual](https://www.activepieces.com/docs/handbook/customer-support/tone#casual) * [Fast](https://www.activepieces.com/docs/handbook/customer-support/tone#fast) * [Honest](https://www.activepieces.com/docs/handbook/customer-support/tone#honest) * [Always Communicate the Next Step](https://www.activepieces.com/docs/handbook/customer-support/tone#always-communicate-the-next-step) * [Use “we,” not “I”](https://www.activepieces.com/docs/handbook/customer-support/tone#use-%E2%80%9Cwe%E2%80%9D-not-%E2%80%9Ci%E2%80%9D) Our customers are fellow engineers and great people to work with. This guide will help you understand the tone and communication style that reflects Activepieces’ culture in customer support. #### [​](https://www.activepieces.com/docs/handbook/customer-support/tone#casual) Casual Chat with them like you’re talking to a friend. There’s no need to sound like a robot. For example: * ✅ “Hey there! How can I help you today?” * ❌ “Greetings. How may I assist you with your inquiry?” * ✅ “No worries, we’ll get this sorted out together!” * ❌ “Please hold while I process your request.” #### [​](https://www.activepieces.com/docs/handbook/customer-support/tone#fast) Fast Reply quickly! People love fast responses. Even if you don’t know the answer right away, let them know you’ll get back to them with the information. This is the fastest way to make customers happy; everyone likes to be heard. #### [​](https://www.activepieces.com/docs/handbook/customer-support/tone#honest) Honest Explain the issue clearly, don’t be defensive, and be honest. We’re all about open source and transparency here – it’s part of our culture. For example: * ✅ “I’m sorry, I forgot to follow up on this. Let’s get it sorted out now.” * ❌ “I apologize for the delay; there were unforeseen circumstances.” ### [​](https://www.activepieces.com/docs/handbook/customer-support/tone#always-communicate-the-next-step) Always Communicate the Next Step Always clarify the next step, such as whether the ticket will receive an immediate response or be added to the backlog for team discussion. #### [​](https://www.activepieces.com/docs/handbook/customer-support/tone#use-%E2%80%9Cwe%E2%80%9D-not-%E2%80%9Ci%E2%80%9D) Use “we,” not “I” * ✅ “We made a mistake here. We’ll fix that for you.” * ❌ “I’ll look into this for you.” * You’re speaking on behalf of the company in every email you send. * Use “we” to show customers they have the whole team’s support. Customers are real people who want to talk to real people. Be yourself, be helpful, and focus on solving their problems! [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/handbook/customer-support/tone.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/handbook/customer-support/tone) [Overview](https://www.activepieces.com/docs/handbook/customer-support/overview) [How to use Pylon](https://www.activepieces.com/docs/handbook/customer-support/pylon) ⌘I --- # Queues Dashboard - Activepieces [Skip to main content](https://www.activepieces.com/docs/install/troubleshooting/bullboard#content-area) [Activepieces home page![light logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/light.svg)![dark logo](https://mintlify.s3.us-west-1.amazonaws.com/activepieces/resources/logo/dark.svg)](https://www.activepieces.com/) Search... ⌘K Search... Navigation Troubleshooting Queues Dashboard [Overview](https://www.activepieces.com/docs/overview/welcome) [Admin Guide](https://www.activepieces.com/docs/admin-guide/guides/structure-projects) [Deploy](https://www.activepieces.com/docs/install/overview) [Embedding](https://www.activepieces.com/docs/embedding/overview) [Build Pieces](https://www.activepieces.com/docs/build-pieces/building-pieces/overview) [API Reference](https://www.activepieces.com/docs/endpoints/overview) [Handbook](https://www.activepieces.com/docs/handbook/overview) On this page * [Setup BullBoard](https://www.activepieces.com/docs/install/troubleshooting/bullboard#setup-bullboard) * [Queue Overview](https://www.activepieces.com/docs/install/troubleshooting/bullboard#queue-overview) * [Low Priority Jobs](https://www.activepieces.com/docs/install/troubleshooting/bullboard#low-priority-jobs) * [RENEW\_WEBHOOK](https://www.activepieces.com/docs/install/troubleshooting/bullboard#renew-webhook) * [EXECUTE\_POLLING](https://www.activepieces.com/docs/install/troubleshooting/bullboard#execute-polling) * [Medium Priority Jobs](https://www.activepieces.com/docs/install/troubleshooting/bullboard#medium-priority-jobs) * [EXECUTE\_FLOW](https://www.activepieces.com/docs/install/troubleshooting/bullboard#execute-flow) * [EXECUTE\_WEBHOOK](https://www.activepieces.com/docs/install/troubleshooting/bullboard#execute-webhook) * [DELAYED\_FLOW](https://www.activepieces.com/docs/install/troubleshooting/bullboard#delayed-flow) * [High Priority Jobs](https://www.activepieces.com/docs/install/troubleshooting/bullboard#high-priority-jobs) * [EXECUTE\_PROPERTY](https://www.activepieces.com/docs/install/troubleshooting/bullboard#execute-property) * [EXECUTE\_EXTRACT\_PIECE\_INFORMATION](https://www.activepieces.com/docs/install/troubleshooting/bullboard#execute-extract-piece-information) * [EXECUTE\_VALIDATION](https://www.activepieces.com/docs/install/troubleshooting/bullboard#execute-validation) * [EXECUTE\_TRIGGER\_HOOK](https://www.activepieces.com/docs/install/troubleshooting/bullboard#execute-trigger-hook) The Bull Board is a tool that allows you to check issues with scheduling and internal flow runs issues. ![BullBoard Overview](https://raw.githubusercontent.com/felixmosh/bull-board/master/screenshots/overview.png) [​](https://www.activepieces.com/docs/install/troubleshooting/bullboard#setup-bullboard) Setup BullBoard ----------------------------------------------------------------------------------------------------------- To enable the Bull Board UI in your self-hosted installation: 1. Define these environment variables: * `AP_QUEUE_UI_ENABLED`: Set to `true` * `AP_QUEUE_UI_USERNAME`: Set your desired username * `AP_QUEUE_UI_PASSWORD`: Set your desired password 2. Access the UI at `/api/ui` For cloud installations, please ask your team for access to the internal documentation that explains how to access BullBoard. [​](https://www.activepieces.com/docs/install/troubleshooting/bullboard#queue-overview) Queue Overview --------------------------------------------------------------------------------------------------------- We have one main queue called `workerJobs` that handles all job types. Each job has a `jobType` field that tells us what it does: ### [​](https://www.activepieces.com/docs/install/troubleshooting/bullboard#low-priority-jobs) Low Priority Jobs #### [​](https://www.activepieces.com/docs/install/troubleshooting/bullboard#renew-webhook) RENEW\_WEBHOOK Renews webhooks for pieces that have webhooks channel with expiration like Google Sheets. #### [​](https://www.activepieces.com/docs/install/troubleshooting/bullboard#execute-polling) EXECUTE\_POLLING Checks external services for new data at regular intervals. ### [​](https://www.activepieces.com/docs/install/troubleshooting/bullboard#medium-priority-jobs) Medium Priority Jobs #### [​](https://www.activepieces.com/docs/install/troubleshooting/bullboard#execute-flow) EXECUTE\_FLOW Runs flows when they’re triggered. #### [​](https://www.activepieces.com/docs/install/troubleshooting/bullboard#execute-webhook) EXECUTE\_WEBHOOK Processes incoming webhook requests that start flow runs. #### [​](https://www.activepieces.com/docs/install/troubleshooting/bullboard#delayed-flow) DELAYED\_FLOW Runs flows that were scheduled for later, like paused flows or delayed executions. ### [​](https://www.activepieces.com/docs/install/troubleshooting/bullboard#high-priority-jobs) High Priority Jobs #### [​](https://www.activepieces.com/docs/install/troubleshooting/bullboard#execute-property) EXECUTE\_PROPERTY Loads dynamic properties for pieces that need them at runtime. #### [​](https://www.activepieces.com/docs/install/troubleshooting/bullboard#execute-extract-piece-information) EXECUTE\_EXTRACT\_PIECE\_INFORMATION Gets information about pieces when they’re being installed or set up. #### [​](https://www.activepieces.com/docs/install/troubleshooting/bullboard#execute-validation) EXECUTE\_VALIDATION Checks that flow settings, inputs, or data are correct before running. #### [​](https://www.activepieces.com/docs/install/troubleshooting/bullboard#execute-trigger-hook) EXECUTE\_TRIGGER\_HOOK Runs special logic before or after triggers fire. Failed jobs are not normal and need to be checked right away to find and fix what’s causing them. They require immediate investigation as they represent executions that failed for unknown reasons that could indicate system issues. Delayed jobs represent either paused flows scheduled for future execution, upcoming polling job iterations, or jobs being retried due to temporary failures. They indicate an internal system error occurred and the job will be retried automatically according to the backoff policy. [Suggest edits](https://github.com/activepieces/activepieces/edit/main/docs/install/troubleshooting/bullboard.mdx) [Raise issue](https://github.com/activepieces/activepieces/issues/new?title=Issue%20on%20docs&body=Path:%20/install/troubleshooting/bullboard) [Rollback Guide](https://www.activepieces.com/docs/install/guides/rollback) [Reset Password](https://www.activepieces.com/docs/install/troubleshooting/reset-password) ⌘I ---