Versions and changes
What may change in version 1 of the API without notice, and what will not.
The version is part of the path: https://api.nessflow.com/v1/….
What may happen in v1
Additive changes, without a new version:
- new operations, new fields in a response, new optional parameters;
- new values in an open list: a new webhook event type, a new error code, a new report
status.
Your integration must therefore ignore unknown fields and treat an unknown value as a case of its own, without crashing.
What does not change in v1
An existing field changes neither its name, nor its type, nor its meaning; an error code keeps its meaning; an operation keeps its path. An incompatible change would go through a new version, announced in the API changelog.
Check against the specification
The OpenAPI 3.1 specification is published with this documentation, and NessFlow's tests validate every response against it. Generating a client from it is the safest way to stay aligned.