Skip to main content

API Changelog: Deprecations

Entries that deprecate part of a core epilot API, newest first. Other changes of the same entry are listed with it. Subscribe via RSS

Showing the core APIs: the APIs integrations are built on, which we keep stable and backwards compatible, together with the core entities and events. APIs for specific platform features change more often and are left out here. Show all APIs

November 3, 2026

Design Builder API

Deprecated Consumer and parse endpoints โ€” The endpoints for adding and removing design consumers and for parsing a design are deprecated.

API details
  • PUT /v1/designs/addConsumer/{application}/{designId}
  • PUT /v1/designs/removeConsumer/{application}/{designId}
  • GET /v1/designs/{designId}/parse

New Safe concurrent design updates โ€” Send If-Match when updating a design so you don't overwrite a change made in the meantime; the update then fails with 409 instead.

API details
  • PUT /v1/designs/{designId} accepts a new optional If-Match header and can respond with 409

October 30, 2026

Entity Mapping API

Deprecated Mapping history โ€” GET /v1/mappings/history is deprecated.

October 20, 2026

Integration Toolkit API

Deprecated v1 monitoring endpoints โ€” Use the /v2 counterparts instead.

API details
  • POST /v1/integrations/{integrationId}/monitoring/inbound-events, outbound-events, stats, and timeseries

October 13, 2026

Automation API

Deprecated actions[].config.candidate_group on automation flows is now deprecated in favour of the new optional actions[].config.candidate_pool field โ€” accepted on POST /v1/automation/flows and PUT /v1/automation/flows/{flow_id} and returned wherever flows and executions are read

Changed Automation bulk jobs can now be restarted: PATCH /v1/automation/executions/bulk-jobs/{job_id} accepts the new RESTART value for action and no longer requires task_token, and bulk jobs report their restarts through new optional restart_count, restarted_at, and last_error fields

Changed Bulk jobs now report execution statistics through new optional execution_stats and execution_summary_truncated fields, and GET /v1/automation/executions/bulk-jobs/{job_id} accepts a new optional include_execution_summary query parameter

October 12, 2026

Workflows Execution API

Deprecated Loop details on flow executions were extended with new optional loop_source, phases[].loop_membership, tasks[].loop_membership, tasks[].conditions[].loop_outcome, and tasks[].loops.*.depth/outer_loop_ids/target_id fields, and tasks[].loop_config on flow executions and tasks is now deprecated in favour of tasks[].loops

Changed Flow executions now carry advanced loops: tasks report their loops through a new optional tasks[].loops field and edges their loop through a new optional edges[].loop_id field โ€” returned wherever flow executions and tasks are read

October 5, 2026

Event Catalog API

Deprecated Catalog events now report when they were deprecated through a new optional deprecated_at field, and event mappings support a new optional mapping.payload field, accepted on POST /v1/events and PUT /v1/events/{event_name}

Changed Catalog events can now be changed through a draft version before publishing: new GET, PUT, and DELETE /v1/events/{event_name}/version_draft endpoints for managing the draft and POST /v1/events/{event_name}/version_draft:publish for publishing it

Workflows Definition API

Deprecated tasks[].loop_config on flow templates is now deprecated in favour of tasks[].loops

Changed Flow templates now support advanced loops: tasks can define loops through a new optional tasks[].loops field and edges can belong to a loop through a new optional edges[].loop_id field. Both are accepted on POST /v2/flows/templates and PUT /v2/flows/templates/{flowId}, which also take a new optional client_supports_adv_loops query parameter, and both are returned wherever flow templates are read

September 24, 2026

Workflows Execution API

Deprecated loop_config.crt_iterations and loop_config.max_iterations on phases and tasks are now deprecated and will be removed in a future version โ€” affecting everywhere flow executions, phases, and tasks are read

September 10, 2026

Integration Toolkit API

Deprecated Monitoring statistics follow the same move: POST /v2/integrations/{integrationId}/monitoring/stats and POST /v2/integrations/{integrationId}/monitoring/time-series now report an info_count per bucket and breakdown, while skipped_count is deprecated and will be removed in a future version

Changed Monitoring events are no longer reported as skipped: their level takes the new info value instead, accepted on POST /v2/integrations/{integrationId}/monitoring/events and returned by the monitoring event, associated event, and trace endpoints

August 27, 2026

Entity API

Deprecated POST /v1/entity/schemas/{slug}/freeze and POST /v1/entity/schemas/{slug}/unfreeze are deprecated and will be removed in a future version

Deprecated The latest query parameter of the schema read and list endpoints is deprecated, as are the frozen, latest, and frozen_version fields of schema responses

August 26, 2026

App API

Deprecated The secrets field of app functions is deprecated and will be removed in a future version

New New POST /v1/app/{appId}/options/resolve endpoint added for resolving the configured option values of an app

Changed App event search (POST /v1/app-configurations/{appId}/events) now accepts an optional filters.search term for searching events and an optional pagination.before cursor for paging backwards; both are echoed back in the query of the response

Changed Apps can now be configured through options: a new optional options list accepted on PATCH /v1/app-configurations/{appId}/versions/{version} and returned wherever apps and app configurations are read, where every returned option reports whether it is configured, lifted, sensitive, and when its value was last changed (value_updated_at); components declare through a new optional uses_options flag that they read those options, and accept options.sensitive on POST/PATCH /v1/app-configurations/{appId}/versions/{version}/components

May 6, 2026

App API

Deprecated intervals field on PortalExtensionHookConsumptionDataRetrieval, PortalExtensionHookCostDataRetrieval, and PortalExtensionHookPriceDataRetrieval deprecated โ€” prefer declaring a sibling visualizationMetadata hook so supported intervals can vary per meter/contract

Deprecated use_static_ips field deprecated on all portal extension hook types โ€” prefer secure_proxy

New New PortalExtensionHookDataExport portal extension hook type added โ€” when configured on export-capable portal blocks, the portal delegates the export action (CSV/Excel/PDF download) to the external source instead of generating the file itself

New New PortalExtensionHookVisualizationMetadata portal extension hook type added โ€” invoked before fetching data with the same portal context as the data hook, returns per-meter/contract visualization metadata (type_options, intervals, data_range)

New New object enum value added to portal extension component option type, plus new fields (primitive sub-field declarations) and repeatable (array-of-entries flag) properties โ€” enables structured object-typed and list-typed component options

March 25, 2026

Entity API

Deprecated New New frozen and latest boolean fields added to schema responses; draft field is now deprecated

Deprecated New New frozen_version field added to schema versions response; unpublished query parameter deprecated in favour of the new latest parameter

New New POST /v1/entity/schemas/{slug}/freeze and POST /v1/entity/schemas/{slug}/unfreeze endpoints added for managing schema version lifecycle

February 11, 2026

ERP Integration API

Deprecated POST /v1/erp/updates/events (v1) and POST /v2/erp/updates/events (v2) are now deprecated โ€” migrate to POST /v3/erp/updates/events

New New ignored and warning status values were added to event processing and monitoring responses

December 2, 2025

Webhooks API

Deprecated GET /v1/webhooks/configs/{configId}/events was deprecated

New New POST /v1/webhooks/configs/{configId}/events/replay-batch endpoint was added for batch event replay