Skip to content

Versioning

The version is part of the URL:

https://api.connectato.com/v1

Only additions that do not break an existing client:

  • new fields in responses;
  • new endpoints;
  • new webhook event types.

What does not change within v1: the names and types of existing fields, existing codes, the shape of errors, the behaviour of existing endpoints.

  • Ignore unknown fields. A new field in a response must not break parsing.
  • Do not validate responses against a schema that rejects extra fields.
  • Treat identifiers and cursors as opaque text (conventions).

A change that would break a client becomes a new version, for the affected resource only, while v1 stays as it is. Every change is listed in the changelog.