Versioning and changelog
What Quotometry promises not to break: stable wire names, pinned webhook API versions, versioned engines and prices, and how deprecations are announced.
This page sets out what Quotometry promises not to change under your integration, what may change without notice, and how you hear about the rest. Write your client to these rules and an upgrade on our side never breaks it.
Wire names never change
A ProcessId, a DFM code, a breakdown line id, a settings key, an event type and an error code all appear in
stored configuration snapshots and in quotes that were already sent. Renaming one would silently change the
meaning of a document that may be years old, so we never rename them. New names are added; old ones stay.
API versions
The REST APIs are versioned by path (/v1/…).
Webhook payloads also carry a dated API version, such as 2026-01. Each webhook endpoint is pinned to the version
it was created with, which arrives as Quotometry-Api-Version on every delivery, and it keeps receiving that
payload shape until you move it. A breaking change to a payload shape ships behind a new dated version.
What we consider non-breaking, and may ship without a new version:
- a new field in a response;
- a new optional field in a request;
- a new value in an enum that is documented as open (
status, DFM codes, issue codes); - a new endpoint.
Write your client so these are uneventful: ignore fields you do not know, and do not model an open enum as a closed one.
Numbers are versioned too
The geometry and pricing engines carry an ENGINE_VERSION. A change that moves a number, such as a better nesting
estimate or a corrected support model, increases it, and every quote records the version that priced it. A quote
never re-prices itself because we released new code; it explains itself with the config version and the engine
that produced it.
Your own config versions are separate and are yours: publishing creates a new one, and a quote points at the version that priced it.
Deprecation
When something must go, it is announced, then it warns, then it is removed, in that order, with at least one full quarter between the announcement and the removal. Everything removed appears in the changelog with the date and its replacement.
Changelog
The changelog lives on this site. Announcements that affect your integration are also e-mailed to the addresses on your account’s notification list.
Next steps
- Webhooks: the envelope and the
Quotometry-Api-Versionheader. - Errors: the stable codes and where they are registered.
- Drafts, versions and publishing: config versions in the console.