Skip to main content

API Changelog

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

2026-06-15 Automation API

  • New optional evaluation_order (AFTER_SCHEDULE / BEFORE_SCHEDULE) and allow_failure fields added to flow condition items — evaluation_order controls how a condition combines with its schedule, and allow_failure lets execution continue past a condition block that errors

2026-06-15 Core Entities

  • The journey entity gained new relations to products, prices, and files; correspondingly, the product, price, and file entities each gained a new journeys relation

2026-06-15 Event: Meter Reading Added

  • New account field added carrying the full account entity related to the reading (company details, addresses, payment data, contacts, and related entities)

2026-06-12 Access Token API

  • New optional read_only field added when creating access tokens (POST /v1/access-tokens); a read-only token may only perform view, export, and download actions regardless of the roles it carries

2026-06-09 Calendar API

  • New endpoints added for managing calendars and events: POST /v1/calendar, PATCH/DELETE /v1/calendar/{calendar_id}, POST /v1/calendar/events, and PATCH/DELETE /v1/calendar/events/{event_id}, plus POST /v1/calendar/sources/outlook and GET /v1/calendar/sources/outlook/available for connecting Outlook calendars

2026-06-08 Workflows Execution API

  • New POST /v2/flows/executions/{execution_id}/tasks/{task_id}/reconcile-automation endpoint added for reconciling the status of a stuck automation task

2026-06-07 Event Catalog API

  • New GET /v1/events/{event_name}/versions endpoint added listing the available payload schema versions for an event, and a new optional Epilot-Event-Version header on the JSON-schema and example endpoints to request a specific version
  • New _downgrades field added to event history responses, describing how a payload was downgraded to an older schema version

2026-06-07 Webhooks API

  • New optional eventVersion field (MAJOR.MINOR format) added to webhook configuration to pin deliveries to a specific event payload schema version

2026-06-05 Targeting API

  • New POST /v1/campaign:setup endpoint added for atomically creating a campaign together with its related entities (e.g. a tariff-change campaign with its journey, portal widget, and email channel)

2026-06-04 Calendar Entity

  • New calendar entity introduced, with required name and source_type attributes and relations to its owning user and to files

2026-06-04 Calendar Event Entity

  • New calendar_event entity introduced, with a required calendar relation and required event_type, start_time, end_time, and source_type attributes

2026-06-03 Blueprint API

  • New POST /v3/blueprint-manifest/blueprint-instances/{blueprint_instance_id}:restore and POST /v3/blueprint-manifest/blueprints/{blueprint_id}/deployments/{job_id}:restore endpoints added for rolling back deployments, along with new snapshot_id, restore_status, and last_restore_job_id deployment fields

2026-06-03 Webhooks API

  • New optional retryPolicy object (enabled, maxAttempts) added to webhook configuration for automatic delivery retries, and a retry_attempt field added to webhook event records

2026-06-02 Workflows Definition API

  • Decision task condition statements now accept an attributes array and an attributes_match mode, allowing a single condition to evaluate multiple entity attributes at once

2026-05-29 Blueprint API

  • The blueprint install endpoint now accepts a source_blueprint_file as an alternative to source_org_id plus source_blueprint_id, and adds optional source_auth_token and destination_auth_token fields for cross-org installs

2026-05-27 File API

  • New POST /v1/files/{id}/summary:generate endpoint added for generating an AI summary of a file, alongside new preview_summary, short_summary, and summary_status response fields

2026-05-25 Pricing API

  • Provider search responses (POST /v1/public/integration/{integrationId}/providers:search) now include the required type and additionalData fields, the latter carrying grid operators, default suppliers, and market-area details
  • New optional external_location_metadata field added to line items on POST /v1/order, PUT /v1/order/{id}, POST /v1/pricing:compute, and POST /v1/public/cart:checkout

2026-05-25 Webhooks API

  • Multipart webhook delivery configuration was restructured: the metadataFieldName field was removed and replaced by fileSource (a JSONata expression selecting which attachments to send), fileFieldStrategy (single or multi), and extraFields (additional form fields populated from JSONata expressions) (breaking)

2026-05-25 Event Catalog API

  • New endpoints added for accessing event history: POST /v2/events/{event_name}:history to search past events and GET /v2/events/{event_name}/history/{event_id} to fetch a single event

2026-05-22 Email Settings API

  • New GET /v2/outlook/calendar/me and DELETE /v2/outlook/calendar/me endpoints added for inspecting and removing the current user's Outlook calendar connection

2026-05-22 User API

  • New endpoints added for managing per-user settings: GET /v2/users/me/settings (list available scopes and keys), GET /v2/users/me/settings/{scope}, and GET/PUT/DELETE /v2/users/me/settings/{scope}/{key} — scopes include calendar, navigation, and search

2026-05-21 Notes API

  • New POST /v1/note/{id}/archive and POST /v1/note/{id}/unarchive endpoints added, along with an _archived_at field and a filter query parameter for filtering notes by archive state

2026-05-20 Automation API

  • 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

2026-05-19 Query API

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

2026-05-15 File API

  • 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