On this page
CRM and ERP integration changelog
This log covers the public workspace API and tools for building integrations. Releases can reach hosted workspaces at different times. Before enabling a workflow, fetch the OpenAPI contract from the target workspace at /api/v1/openapi.json, then check the required module and scopes there.
November 15, 2026 — documentation checked against implemented behavior
- The API contracts now describe required accounting report dates, string-valued deal amounts, nullable timestamps, list limits and recovery for accounting writes without idempotency support.
- Own-deployment webhook payloads are visible in Swagger. Hosted and own-deployment event handling remain distinct.
- The connection guides clarify setup requirements and limits, including Odoo compatibility, hosted WeChat and Website Chat, freight rates, phone locking and credential handling. The website and in-app Help use the same guide text.
- Contract discovery identifies the installed deployment contract; enabled modules, permissions and configuration still determine whether a request succeeds.
- The customer kit and local development guide distinguish simulations, real API requests and prepared-request recovery. No API behavior changed in this documentation update.
November 14, 2026 — workspace region in URL examples
- URL examples use workspace and region placeholders. Copy the complete workspace URL from Admin → Integrations; the API docs, agent guidance and customer kit do not assume a region.
- The n8n example uses the same placeholders. Existing imported workflows retain their configured workspace URL.
November 14, 2026 — complete API reference by deployment
- The API reference now includes every public CRM, ERP and accounting operation implemented for own deployments, alongside the hosted contract.
- Choose the deployment in Swagger UI or download its OpenAPI contract. API search follows the same deployment filters.
- Own deployments now serve their matching contract at
/api/v1/openapi.json. This documents existing operations; it does not enable additional operations on hosted workspaces. - Operation counts have been removed from introductory copy so it remains accurate as the API grows.
November 14, 2026 — documentation domain, search and customer kit
- Documentation moves to
docs.terraminedesk.ai, with redirects from existing website docs links. Tenant API URLs remain unchanged. - Search covers the API documentation and connection setup guides, with filters for hosted workspaces and own deployments.
- The customer example kit runs with standard Python and no private repository access. It includes a synthetic local demo, a read-only tenant lookup, explicit draft creation and replay, webhook verification, OpenAPI and n8n files.
- Connection guides and in-app Help now consistently describe hosted WhatsApp limits and the different hosted and own-deployment API contracts.
November 14, 2026 — guides and workflow example
- The quickstart now begins with a read-only request and expected response, followed by CRM and ERP workflows, webhook handling and troubleshooting.
- The n8n example has a separate
quote_request_id. Keep it and the payload unchanged for retries; use a new request ID for another quotation, including one for the same deal. Existing imported workflows are unchanged; download the updated example to use this field. - Local development instructions now clearly require access to the private source repository. Customer integrations use their own workspace URL and service key.
- Documentation changes do not add or remove API operations or scopes.
November 14, 2026 — tenant URL examples
- Quickstart, n8n and agent examples use the customer’s own tenant address. Copy the workspace URL from Admin → Integrations.
November 13, 2026 — first-run tools
- The hosted workspace owner can configure service keys, make a first customer lookup and inspect webhook deliveries under Admin → Integrations.
- An owner can send a signed
integration.testto an existing active subscription. It carries no business record. Receivers should verify and acknowledge it without creating or updating an order or deal. - Agents can discover the published contract and guides through the documentation index.
November 12, 2026 — initial v1 contract
- The hosted API covers customer lookup, listing and reading orders, creating a draft order, reading a CRM deal and attaching an existing external ERP order.
- Two business events are available:
quote.sentandcrm.deal.stage_changed. Each subscription has its own signing secret. - The quickstart, agent guide, downloadable contract and sample n8n workflow share the same sources on the developer website and in the application.
Compatibility within v1
Existing operations keep their required inputs and the meaning of their documented responses. We can add operations, optional fields and opt-in business events within v1. Clients should read the fields they need, ignore unknown response fields, branch on HTTP status rather than error wording, and dispatch only event types they understand.
Removing or renaming a documented field, making an optional request field required, or changing the meaning of an existing operation requires a new API version and migration guidance. The public website describes the published contract; the customer's installed version, enabled modules and key scopes determine which requests succeed.
