Skip to main content
  1. public-api.workchats.com/v1 changes only additively. Your integration must ignore fields, callback kinds, block types and error codes it doesn’t recognize, rather than treating them as errors.
  2. A breaking change ships as a new major version, /v2. Nothing breaking ever lands inside /v1.
  3. When /v2 becomes generally available, /v1 stays supported for at least 12 months afterward. Deprecation and Sunset response headers are added once the first deprecation is announced.
  4. Every public change — additive or a new major version — gets a dated entry on the Changelog.

​
What counts as additive

Safe to add without a version bump: a new endpoint, a new optional request field, a new field in a response, a new error code, a new callback event kind, a new block type. Not additive, and would need /v2: removing or renaming a field, changing a field’s type or meaning, making an optional field required, removing an error code, or changing what an existing endpoint does for the same input.

​
Build for this

  • Parse JSON leniently: don’t fail on an unrecognized field.
  • Treat an unrecognized error code as a generic failure (see Errors), not a crash.
  • Treat an unrecognized directory.changed kind or block type as “skip this, keep going” once callbacks and richer blocks ship.