Skip to content
Try STRYK

Concepts

Versioning and deprecation

The major version is part of the path: /api/partner/v1. Within v1, the API only changes in ways that existing integrations can absorb.

Changes without a new version

  • New endpoints, new optional parameters and new optional request fields
  • New fields in responses and webhook payloads
  • New webhook event types (you only receive the ones you subscribed to)
  • New values in fields that are documented as extensible, and new error codes listed on Errors

Breaking changes

Removing or renaming fields, changing types or meanings, or tightening validation happens only in a new major version (v2). The previous version keeps running in parallel.

Deprecation

Before something is removed, it is announced in the changelog at least six months in advance. Affected responses carry a Deprecation header and a Sunset header with the date after which the endpoint may stop working.

HTTP
HTTP/1.1 200 OK
Deprecation: @1798761600
Sunset: Wed, 30 Jun 2027 00:00:00 GMT
Link: <https://staystryk.com/developers/changelog>; rel="deprecation"

Log these headers in your integration so a deprecation does not go unnoticed.