Skip to content

Changelog

All notable changes to the CX Platform developer documentation will be documented in this file.

Looking for API release details?

For API-related releases, behavior changes, and rollout notes, use the public CX API Release Notes as the authoritative source.

Looking for Java SDK release details?

For published Java SDK versions and artifact availability, use Maven Central for us.cxgp:cx-sdk-client.

The format is based on Keep a Changelog.

[2026-07-15]

Added

  • API Versioning — New public guidance for calling partner REST endpoints with the /cx/v2/ path prefix, including migration and SDK configuration notes
  • SDK Quick Start — Added a Java SDK Core Javadoc link alongside the existing Java SDK Client Javadoc link
  • SDK Error Handling — Support context guidance now recommends including relevant identifiers (location, customer, etc.) when contacting CX Support

Changed

  • REST API examples — Updated onboarding and API reference examples to use explicit /cx/v2/ paths for partner API calls
  • Navigation — Added the new API Versioning page under the API Reference section
  • API Key Hierarchy — Documented API keys as a two-level hierarchy (Implementation, Location) across the Authentication guide, REST API Overview, and Home page; clarified that keys do not inherit across levels and that Location keys inherit configuration from the Implementation level
  • Production host references — Replaced hard-coded production URLs with "provided by your CX representative" wording on the Home page, REST API Overview, and Authentication & Environments pages
  • Authentication & Environments — Renamed "PIT (Test)" section to "Test (sometimes called PIT — Partner Integration Testing)" and updated the environments table accordingly
  • Home page capabilities — Removed the Payments row from the capabilities table to reflect the currently documented endpoint set
  • REST API Overview — Removed "payments" from the intro line and simplified the supported-currencies note to list USD and CAD explicitly (dropped the C$ display example)
  • SDK version — Bumped documented Java SDK version from 0.2.1 across Quick Start, FAQ, and the initial launch changelog entry (was 0.1.0)
  • SDK Quick Start — Clarified that the service location only needs to be set at least once before location-scoped calls
  • Usage Examples — Reordered SDK examples so "Managing API Keys" appears before "Working with Service Locations" to match the recommended onboarding flow

Removed

  • Home page — Removed the "Status Page — Coming Soon" badge, the "What's New" highlights carousel, the Sample Projects & Integration Templates section, and the outstanding TODO checklist
  • REST API Overview — Removed the "API Collections (Postman / Insomnia)" section and dropped the Platform key tier from the API Key Hierarchy diagram and table
  • Swagger UI — Removed the embedded Swagger UI iframe section; users should use the direct PIT link instead
  • SDK Error Handling — Removed the "Accessing Response Headers for Rate-Limit Metadata" example and the internal "To Do Review" checklist
  • SDK FAQ — Removed the "Where do I report bugs or request documentation updates?" entry that pointed to the Bitbucket consumer repo and issue tracker
  • SDK Quick Start & Usage Examples — Removed the Java SDK Consumer sample project / ZIP download references and the outstanding TODO checklist

[2026-04-07]

Added

  • Documentation Portal — Initial launch of the CX Platform developer documentation site built with MkDocs and Material for MkDocs
  • SDK Quick Start — Step-by-step guide to integrating with the Java SDK (us.cxgp:cx-sdk-client:0.2.1), including Maven/Gradle setup, client initialization, and first API call
  • API Overview — REST API integration guide covering base path (/cx/), authentication, request/response formats, and endpoint categories
  • Authentication & Environments — Comprehensive guide to CX-API-KEY header authentication, key hierarchy (Super Admin → Implementation → Location), and environment configuration
  • API vs SDK Comparison — Side-by-side comparison of the REST API and Java SDK to help developers choose the right integration path
  • Usage Examples — Code samples for common operations (Customers, Payments, Statements) in both REST and SDK formats
  • Error Handling Guide — Reference for HTTP error codes, CxSdkClientException handling, and troubleshooting common issues
  • FAQ — Frequently asked questions covering authentication, SDK setup, environments, and common pitfalls
  • Interactive API Reference — Embedded Swagger UI for exploring and testing CX Platform API endpoints in the browser
  • OpenAPI Specification — Bundled OpenAPI spec (cx-oas.json) synced from the CX Platform API