Skip to main content

API Changelog

Breaking changes, new features, and significant updates to epilot APIs. Subscribe via RSS

Showing changes to all APIs. This includes APIs for specific platform features, which are not part of the core APIs integrations are built on and change more often. Show core APIs only

May 20, 2026

Automation API

New New loops field added to automation flows (POST /v1/automation/flows) defining loop scopes that resolve an array from the trigger entity; actions opt into a loop via a new loop_id property and then run once per resolved item

May 19, 2026

Query API

New New nextCursor and total response fields added, enabling keyset pagination for chart-config row queries and total-count reporting for paginated raw-SQL queries

May 15, 2026

File API

New New asynchronous file zip export endpoints added: POST /v1/files:zipJob bundles multiple files into a downloadable archive and GET /v1/files:zipJob/{job_id} polls the job status; the optional notify_email field accepts an email address to notify on completion

May 13, 2026

Entity API

New New optional org_id field added to created_by user objects on saved views (POST /v1/entity/view, GET/PUT/PATCH /v1/entity/view/{id}, GET /v1/entity/views, GET /v1/entity/views/favorites) for partner access control across organizations

Integration Toolkit API

New New portal_ref and env_var_ref config options added to inbound use case field mappings โ€” portal_ref resolves to a property (portal_id, origin, domain, name) of one of the calling organization's portal configurations at runtime by filter, and env_var_ref resolves to an org-scoped non-secret environment variable from the environments-api service, replacing hardcoded environment-specific portal UUIDs and config values in inbound mappings

Metering API

New New endpoints added for managing pending reading changesets: GET /v1/metering/reading/{meter_id}/{counter_id}/changesets (list pending), PATCH /v1/metering/reading/{meter_id}/{counter_id}/changesets/{changeset_id} (edit the proposed value), POST .../changesets/{changeset_id}:apply (approve and commit to ClickHouse), and POST .../changesets/{changeset_id}:dismiss (reject)

New New optional direct query parameter added to all reading-write endpoints (POST /v1/metering/reading, POST /v1/metering/readings, POST /v1/metering/readings/{meter_id}, POST /v2/metering/readings) โ€” when true, bypasses changeset interception and writes directly to ClickHouse, auto-clearing matching pending changesets; the same effect is triggered automatically when source: 'ERP' is set in the request body

New New optional include_pending_changesets query parameter added to GET /v1/metering/meter and GET /v1/metering/reading/{meter_id}/{counter_id}, including pending reading changesets in the response alongside confirmed readings

Event: Meter Reading Added

New New activity_type field added identifying the lifecycle action that triggered the event: MeterReadingsAdded (direct commit), ChangesetCreated (pending), ChangesetApplied (pending โ†’ committed), or ChangesetDismissed (pending rejected)

New New changeset_id and changeset_edit_mode (direct / external / approval) fields added, carrying the originating changeset's identifier and mode

New New dismissed_reason and dismissed_at fields populated on ChangesetDismissed events

May 7, 2026

Event: Service Meter Reading Added

New New event_attachments array added carrying file metadata (entity_id, filename, mime_type, size_bytes, s3ref, version_index, readable_size, _tags, relation_tags, category, file_date, _created_at) for every file related to the ticket โ€” consumers should filter by relation_tags, _tags, mime_type, or _created_at proximity to reading_timestamp to identify the meter reading photo

New New ticket_files array added on the hydrated entity graph carrying the full file entity objects

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

User API

New New optional abbreviation field (up to 2 characters, nullable) added to user groups across GET /v1/groups, POST /v1/groups, GET/PATCH /v1/groups/{id}, POST /v1/groups/{id}/user:next, and GET /v2/users/{id}/groups

May 5, 2026

Automation API

New New optional mark_as_read field added to ForwardEmailAction, ReplyEmailAction, and SendEmailAction configurations, controlling whether the email thread is automatically marked as read after the action completes

May 4, 2026

Pricing API

New New optional availability_address and variable_inputs fields added to the external catalog request context on POST /v1/public/external-catalog/products, POST /v1/public/external-catalog/product-recommendations, and POST /integration/external-service, enabling availability filtering by address and variable-amount price computation

New New optional cashback_name field added to CashbackAmount items across order, pricing, cart, and external-catalog responses

May 2, 2026

Message API

New New optional mark_thread_as_read field added to POST /v1/message/messages and POST /v1/message/drafts, controlling whether sending a reply marks the thread as read for the sender's org/user (defaults to true)

May 1, 2026

Core Events

Changed Four new pending-changeset metadata fields added across all built-in events: _has_pending_changesets, _changeset_edit_modes, _changeset_attributes, and _changeset_edit_modes_by_attribute โ€” enabling fine-grained webhook conditions based on whether the triggering entity has pending changesets and which attributes/edit modes are involved

Event: Meter Reading Added

New New proposed_meter_readings array added carrying pending reading-changeset context (counter ID, value, direction, status, edit_mode, changeset_id, and previous values being overwritten); populated only when the event represents a pending reading-changeset creation

New New unit field added to individual items in the existing meter_readings array

April 30, 2026

Integration Toolkit API

Breaking slug request property is now required on all use-case create variants (POST /v1/integrations/{integrationId}/use-cases) โ€” file proxy, inbound, managed call, outbound, and secure proxy

New New optional allowed_origins array field added to FileProxy use case configuration, listing additional origins permitted to call /download (CORS); portal origins remain always allowed

Journey Config API

New New optional version query parameter added to GET /v1/journey/configuration/{id} and GET /v2/journey/configuration/{id} for fetching historical snapshots; 0 (default) returns the live row, positive integers return earlier saved versions

New New optional settings.isActive boolean field added to journey configurations

April 28, 2026

Entity API

New New optional edit_mode and edit_mode_config fields added to all entity schema attribute types in schema responses

Changed _changesets field now included on entity objects returned from activity log responses

Notes API

Breaking created_by field type changed from a single object to an array of objects across all note endpoints โ€” consumers reading created_by fields must handle arrays

Breaking POST /v1/notes:search now requires at least one entry in the contexts array; previously empty arrays were silently accepted

New New optional edited_at timestamp field added to notes and comments

New New optional include_related_schemas array field added to note search requests for including notes on related entity schemas

Entity Mapping API

New New iteration operations added to entity mapping rules: _each (path to the source array to iterate), _as (variable name for each item, accessed as $<name> in _copy paths within _map), and _map (operation applied per iteration item), enabling array-to-array entity transformation

Webhooks API

New New optional apply_changesets boolean field added to webhook payloadConfiguration; when true, entity fields in the webhook payload reflect proposed changeset values instead of current persisted values

Changed Webhook auth credential fields (password, clientSecret, keyValue) are now nullable; passing null explicitly clears the stored value, omitting the field preserves the existing value

April 21, 2026

Core Events

New New remarks array field added to MeterReadingAdded and ServiceMeterReadingAdded events, containing free-text remarks from the submitter in reading order (one per counter for multi-counter meters; empty or whitespace-only remarks are omitted)

New New remark field added to individual counter reading items within ServiceMeterReadingAdded

April 17, 2026

Pricing API

Breaking context.contract.billing_account and context.contract.payment request fields on POST /v1/public/external-catalog/products and POST /v1/public/external-catalog/product-recommendations changed from string relation IDs to objects

Changed context.contract.branch enum constraint removed on the same endpoints; the field now accepts any string instead of only the previous fixed values (power, gas, water, waste_water, district_heating)

Permissions API

New New equals_current_user grant condition (EqualsCurrentUserCondition) added, checking whether any relation_user attribute on the entity contains the currently authenticated user; an optional attribute path restricts the check to a specific field

New New optional vendor_created boolean field added to user, partner, and sharing role responses, indicating the role was created by a vendor organization on behalf of a partner organization

April 16, 2026

Design Builder API

Changed Many new design token fields added to Journey design objects for fine-grained styling: button variants (primary, ghost, outlined), input fields, cards, chips, dropdowns, datepicker, toggles, topbar, font size scale, and more; IMAGE added as a new file_type option for design logos