How the Nanoru API changes

Most changes add things, and those can come at any time. A change that could break your integration is announced before it lands.

Changes that can come at any time

These don't break a client that ignores what it doesn't know:

  • a new endpoint, or a new optional request field or query parameter;
  • a new field in a response or a webhook body;
  • a new error code, webhook event, or value in a list such as a stage or a failure reason.

So read responses leniently: ignore fields you don't use, and treat an unknown value in a list as "other" rather than failing.

Breaking changes

Removing or renaming something, or changing what a field means, is announced first:

  • it's in the changelog, with the date;
  • responses that use it carry a Deprecation header, and a Sunset header with the date it stops working.

Webhooks

Each webhook endpoint keeps the body version it was created with (api_version in every delivery). A change to an event's body that isn't additive comes as a new version, which only endpoints that ask for it receive.