Skip to contentVersioning and compatibility
- Path version.
/api/v1 is stable. A breaking change ships under /api/v2, and v1 keeps working for at least 12 months after v2 is announced in the changelog.
- Non-breaking changes happen within
v1 without notice: new endpoints, new optional request fields, new response fields, new enum values in responses, new webhook event types, new scopes. Ignore fields you don't know.
- Breaking (needs a new version): removing or renaming fields, changing types or meaning, making optional input required, removing enum values you send.
- Webhook envelopes carry
apiVersion (currently 2026-11-01). A change to an event's data shape gets a new apiVersion; you can rely on the shape for a given version.
- SDK follows semver.
0.x minor releases may break; pin the version in your manifest's connector.sdk.
- Manifest
manifestVersion: 1; posApiVersion: "v1".
