Adapter quickstart
Start from the current adapter implementation path.
Adapter reference
Adapter Changelog
Adapter contract version history.
v1.0Current version
The current adapter contract version is:
1.0
Every ChartHero request to partner adapter endpoints includes this value in X-ChartHero-Contract-Version.
Releases
| Version | Change |
|---|---|
| 1.0 | Initial stable release of the adapter contract: launch context, provider directory, checklist recommendations, verified-email lookup, and validate-connection. |
Changes within 1.0
| Date | Change |
|---|---|
| 2026-08-07 | Clarified the 1.0 error-diagnostics receiver contract: ChartHero still sends a fixed catalog message, while receivers validate only that it is a JSON string from 1 through 512 characters and must not compare it with the catalog. |
| 2026-08-06 | Added the optional error-diagnostics receiver POST , the optional error_diagnostics.enabled setting, and the optional X-ChartHero-Diagnostic-Id header on adapter calls. |
The error-diagnostics endpoint ships inside 1.0 rather than as a version bump.
This is a specific product decision for this endpoint: it is disabled by
default, sends no traffic until an organization explicitly enables it, and
changes no existing endpoint's request body, response body, or default
behavior. Adapters that do not implement it are unaffected and need no change.
This decision applies only to this endpoint. It does not change how ChartHero versions other adapter contract changes, and it introduces no version negotiation.
Versioning
Contract versions follow MAJOR.MINOR.
- Minor (for example
1.0→1.1) — additive or clarifying changes an existing adapter keeps working against, such as new optional response fields, new capabilities, or documentation clarifications. - Major (for example
1.0→2.0) — breaking request, response, schema, or semantic changes. ChartHero ships these under a new major version (and, where the endpoints move, a new/vN/contract path) rather than altering1.0in place.
The X-ChartHero-Contract-Version header always names the exact version ChartHero is calling against.
Next steps
Adapter reference
Inspect the exact bundled adapter OpenAPI contract.
Testing checklist
Use readiness checks before activating an installation.