Changelog

The PeakCommerce Agent API is versioned so your integrations stay stable as the platform evolves. The current version is v1, served under /api/v1.

How versioning works

• Additive, backward-compatible changes ship continuously within v1 — new endpoints, new optional request fields, new response fields, new event types, and new nextActions. These never require a change on your side.

• Breaking changes would be introduced under a new version path (for example a future /api/v2), not applied to v1 in place, so existing integrations keep working.

Track what your tenant supports

Rather than reading a static list, query the live shape of the API:

• GET /api/v1/manifest returns the capabilities your tenant currently exposes, including capabilities.eventTypes — the complete, live list of webhook events.

• The API Reference and the OpenAPI spec always reflect the current contract.

Build defensively

Because v1 changes are additive, integrations that ignore unknown fields, avoid hard-coded enum lists, and follow nextActions rather than constructing URLs by hand absorb new capabilities automatically — no code change needed when the API grows.

Related

• API Reference

• Webhooks overview

• SDKs & Tooling