ContextQMD
Back to Activepieces

Breaking Changes

docs/install/configuration/breaking-changes.mdx

0.82.113.7 KB
Original Source

0.82.0

What has changed?

Piece Versions Are Now Pinned

  • Piece versions are no longer stored with wildcards (~1.2.0, ^1.2.0). All piece steps now use exact versions (e.g. 1.2.0).
  • A migration automatically strips wildcard prefixes from all existing flow versions on upgrade.
  • The LOCK_AND_PUBLISH operation no longer resolves piece versions at publish time — steps run with the exact version stored in the flow.
  • A new version switcher UI in the builder lets users upgrade or downgrade piece versions manually.

REST API

  • ADD_ACTION, UPDATE_ACTION, and UPDATE_TRIGGER now strip wildcard prefixes (~, ^) from pieceVersion before saving. If you were relying on wildcard versions to auto-resolve on publish, your steps will now be pinned to the base version (e.g. ~1.2.0 becomes 1.2.0).
  • LOCK_AND_PUBLISH no longer modifies pieceVersion on any step. The version in the draft is the version that will run.
  • A new endpoint GET /v1/pieces/:name/versions is available to list all versions of a piece, useful for building custom version selection.

Concurrent Jobs Env Var Renamed

  • AP_MAX_CONCURRENT_JOBS_PER_PROJECT → AP_DEFAULT_CONCURRENT_JOBS_LIMIT. Default drops from 100 to 5.

Outbound HTTP is SSRF-filtered

  • Server-side HTTP (OAuth, Vault, Conjur, event destinations, on-call pager, MCP validator) now blocks private, loopback, and cloud-metadata IPs. Reach internal hosts by adding their IP/CIDR to AP_SSRF_ALLOW_LIST.

Do you need to take action?

  • Pinned piece versions — if you create or update flows via the REST API with wildcard versions (~ or ^), switch to exact versions; wildcards are silently stripped. If your publish flow relied on LOCK_AND_PUBLISH resolving wildcards, set the exact version on each step before publishing. Use GET /v1/pieces/:name/versions to list available versions.
  • Concurrent jobs — rename AP_MAX_CONCURRENT_JOBS_PER_PROJECT to AP_DEFAULT_CONCURRENT_JOBS_LIMIT. To keep the old cap, set AP_DEFAULT_CONCURRENT_JOBS_LIMIT=100.
  • SSRF filter — if you self-host Vault, Conjur, an OAuth2 token endpoint, or any internal webhook on a private IP, set AP_SSRF_ALLOW_LIST (comma-separated IPs or CIDRs, e.g. 10.0.5.12,192.168.10.0/24) before upgrading.

0.80.0

What has changed?

Infrastructure

  • A new environment variable AP_MAX_WEBHOOK_PAYLOAD_SIZE_MB has been introduced to control the maximum allowed webhook payload size. The default is 25 MB. Webhooks exceeding this limit will be rejected with a 413 Request Too Long response.
  • Nginx has been removed from the Docker image. Fastify now serves both the API and the React frontend directly. All API routes are now under the /api prefix natively. If you were using /v1/health as a health check endpoint (e.g. in Kubernetes probes or load balancer checks), update it to /api/v1/health.
  • Secret managers has been refactored, the version in 0.79.0 no longer is supported, it was not used by anyone but it's worth to mention to upgrade to 0.80.0 before considering using the feature

API

  • A new UPDATE_SAMPLE_DATA_INFO flow operation has been introduced to handle sample data updates independently.
  • UPDATE_ACTION and UPDATE_TRIGGER no longer accept or apply changes to sampleData in step settings. Any sampleData fields sent in these requests will be ignored and the existing sample data will be preserved.
  • A new required lastUpdatedDate field has been added to all actions and triggers, tracked automatically by the server. It is not accepted in UPDATE_ACTION or UPDATE_TRIGGER requests.

Do you need to take action?

  • If you want to restrict webhook payload sizes below the new 25 MB default, set AP_MAX_WEBHOOK_PAYLOAD_SIZE_MB to your desired limit.
  • If you are using the API to update sample data on steps via UPDATE_ACTION or UPDATE_TRIGGER, switch to the new UPDATE_SAMPLE_DATA_INFO operation instead.
  • If you have custom health checks pointing to /v1/health, update them to /api/v1/health.

0.78.1

What has changed?

  • The Platform Operator role can now edit all projects.

Do you need to take action?

  • Only if you want to restrict Operators from having editor access to every project. Review your Operator permissions as needed.

0.78.0

What has changed?

  • The usageCount field has been removed from both the template API responses and the database—it's no longer available.
  • The Todos feature is now deprecated and will not be supported going forward.

Do you need to take action?

  • If you're using the Todos feature, update your flows to use the new approvals channels available from the approvals tab in the piece selector.

0.77.0

What has changed?

  • For Embed Plan users: the "Use a Template" dialog no longer appears when clicking the "New Flow" button.
  • The /flow-templates API endpoints have been removed and replaced by /templates.
  • Log size configuration has changed: AP_MAX_FILE_SIZE_MB no longer controls flow run logs. Use AP_MAX_FLOW_RUN_LOG_SIZE_MB instead.

Do you need to take action?

  • If you are on the embed plan, update your implementation to redirect users to the /templates page.
  • Review the new endpoints documentation: Templates API Schema.
  • If you use a custom value for AP_MAX_FILE_SIZE_MB, be sure to also set AP_MAX_FLOW_RUN_LOG_SIZE_MB accordingly.

0.75.0

What has changed?

  • When you navigate to a flow run inside the builder the url will change to /runs, this is something embedding customers might need to consider in case they have a route guard that only allows users to navigate to /flows.
  • In development mode, loading piece translations are now off by default. Set AP_LOAD_TRANSLATIONS_FOR_DEV_PIECES=true to enable.

Do you need to take action?

  • Check your embedding navigation handler and see if it would be blocking the user from seeing the runs inside the builder or not.
  • If you want to load translations for pieces in development mode, set AP_LOAD_TRANSLATIONS_FOR_DEV_PIECES=true in your environment variables.

0.74.0

What has changed?

  • The default embedded database for development and lightweight deployments has changed from SQLite3 to PGLite (embedded PostgreSQL).
  • The environment variable AP_DB_TYPE=SQLITE3 is now deprecated and replaced with AP_DB_TYPE=PGLITE.
  • Existing SQLite databases will be automatically migrated to PGLite on first startup.
  • Templates are broken in this version. A migration issue changed template IDs, breaking API endpoints. This will be fixed in the next patch release.
  • The aiCredits feature per project has been removed. In the next version, it will be replaced by integration with the AI Gateway.

Do you need to take action?

  • If you are using AP_DB_TYPE=SQLITE3: Update your configuration to use AP_DB_TYPE=PGLITE instead.
  • If you are using templates: Wait for the next patch release to fix the template IDs.

0.73.0

What has changed?

Do you need to take action?

  • If you are currently using MCP, review the linked announcement for important migration details and upgrade guidance.

0.71.0

What has changed?

  • In separate workers setup, now they have access to Redis.
  • AP_EXECUTION_MODE mode SANDBOXED is now deprecated and replaced with SANDBOX_PROCESS
  • Code Copilot has been deprecated. It will be reintroduced in a different, more powerful form in the future.

When is action necessary?

  • If you have separate workers setup, you should make sure that workers have access to Redis.
  • If you are using AP_EXECUTION_MODE mode SANDBOXED, you should replace it with SANDBOX_PROCESS

0.70.0

What has changed?

  • AP_QUEUE_MODE is now deprecated and replaced with AP_REDIS_TYPE
  • If you are using Sentinel Redis, you should add AP_REDIS_TYPE to SENTINEL

When is action necessary?

  • If you are using AP_QUEUE_MODE, you should replace it with AP_REDIS_TYPE
  • If you are using Sentinel Redis, you should add AP_REDIS_TYPE to SENTINEL

0.69.0

What has changed?

  • AP_FLOW_WORKER_CONCURRENCY and AP_SCHEDULED_WORKER_CONCURRENCY are now deprecated all jobs have single queue and replaced with AP_WORKER_CONCURRENCY

When is action necessary?

  • If you are using AP_FLOW_WORKER_CONCURRENCY or AP_SCHEDULED_WORKER_CONCURRENCY, you should replace them with AP_WORKER_CONCURRENCY

0.66.0

What has changed?

  • If you use embedding the embedding SDK, please upgrade to version 0.6.0, embedding.dashboard.hideSidebar used to hide the navbar above the flows table in the dashboard now it relies on embedding.dashboard.hideFlowsPageNavbar

0.64.0

What has changed?

  • MCP management is removed from the embedding SDK.

0.63.0

What has changed?

  • Replicate provider's text models have been removed.

When is action necessary?

  • If you are using one of Replicate's text models, you should replace it with another model from another provider.

0.46.0

What has changed?

  • The UI for "Array of Properties" inputs in the pieces has been updated, particularly affecting the "Dynamic Value" toggle functionality.

When is action necessary?

  • No action is required for this change.
  • Your published flows will continue to work without interruption.
  • When editing existing flows that use the "Dynamic Value" toggle on "Array of Properties" inputs (such as the "files" parameter in the "Extract Structured Data" action of the "Utility AI" piece), the end user will need to remap the values again.
  • For details on the new UI implementation, refer to this announcement.

0.38.6

What has changed?

  • Workers no longer rely on the AP_FLOW_WORKER_CONCURRENCY and AP_SCHEDULED_WORKER_CONCURRENCY environment variables. These values are now retrieved from the app server.

When is action necessary?

  • If AP_CONTAINER_TYPE is set to WORKER on the worker machine, and AP_SCHEDULED_WORKER_CONCURRENCY or AP_FLOW_WORKER_CONCURRENCY are set to zero on the app server, workers will stop processing the queues. To fix this, check the Separate Worker from App documentation and set the AP_CONTAINER_TYPE to fetch the necessary values from the app server. If no container type is set on the worker machine, this is not a breaking change.

0.35.1

What has changed?

  • The 'name' attribute has been renamed to 'externalId' in the AppConnection entity.
  • The 'displayName' attribute has been added to the AppConnection entity.

When is action necessary?

  • If you are using the connections API, you should update the name attribute to externalId and add the displayName attribute.

0.35.0

What has changed?

  • All branches are now converted to routers, and downgrade is not supported.

0.33.0

What has changed?

  • Files from actions or triggers are now stored in the database / S3 to support retries from certain steps, and the size of files from actions is now subject to the limit of AP_MAX_FILE_SIZE_MB.
  • Files in triggers were previously passed as base64 encoded strings; now they are passed as file paths in the database / S3. Paused flows that have triggers from version 0.29.0 or earlier will no longer work.

When is action necessary?

  • If you are dealing with large files in the actions, consider increasing the AP_MAX_FILE_SIZE_MB to a higher value, and make sure the storage system (database/S3) has enough capacity for the files.

0.30.0

What has changed?

  • AP_SANDBOX_RUN_TIME_SECONDS is now deprecated and replaced with AP_FLOW_TIMEOUT_SECONDS
  • AP_CODE_SANDBOX_TYPE is now deprecated and replaced with new mode in AP_EXECUTION_MODE

When is action necessary?

  • If you are using AP_CODE_SANDBOX_TYPE to V8_ISOLATE, you should switch to AP_EXECUTION_MODE to SANDBOX_CODE_ONLY
  • If you are using AP_SANDBOX_RUN_TIME_SECONDS to set the sandbox run time limit, you should switch to AP_FLOW_TIMEOUT_SECONDS

0.28.0

What has changed?

  • Project Members:
    • The EXTERNAL_CUSTOMER role has been deprecated and replaced with the OPERATOR role. Please check the permissions page for more details.
    • All pending invitations will be removed.
    • The User Invitation entity has been introduced to send invitations. You can still use the Project Member API to add roles for the user, but it requires the user to exist. If you want to send an email, use the User Invitation, and later a record in the project member will be created after the user accepts and registers an account.
  • Authentication:
    • The SIGN_UP_ENABLED environment variable, which allowed multiple users to sign up for different platforms/projects, has been removed. It has been replaced with inviting users to the same platform/project. All old users should continue to work normally.

When is action necessary?

  • Project Members:

If you use the embedding SDK or the create project member API with the EXTERNAL_CUSTOMER role, you should start using the OPERATOR role instead.

  • Authentication:

Multiple platforms/projects are no longer supported in the community edition. Technically, everything is still there, but you have to hack using the API as the authentication system has now changed. If you have already created the users/platforms, they should continue to work, and no action is required.