Skip to content
SAEIv1
View as Markdown

Versioning & changes

The API version is in the path: https://api.saei.automize.sa/v1. Within v1 we only make changes that do not break a correct integration:

  • new endpoints, new optional request fields, new response fields, new event types, new error codes, new enum values on fields documented as extensible (such as type);
  • clearer error messages (branch on code, not message).

Write your integration to tolerate these: ignore fields you do not know, and handle an unknown status or event type without crashing.

A breaking change goes into a new version (v2) and v1 keeps working. Before anything in v1 is removed you get at least six months' notice, a Deprecation and Sunset header on the affected responses, and an entry in the changelog.

Webhook payloads carry their own version (currently "2"). Within a version, fields are only ever added.

Every change to the API is listed in the changelog.