Pexip Engage considers the following changes to be backwards-compatible. Implementations consuming webhooks or making requests to an API endpoint should be able to handle the following API upgrades, without the need to make changes to the implementation.
- Addition of new resources.
- New optional request parameters to existing API methods.
- Additional properties added to existing resources.
- Change in the length or format of opaque strings. For example, adding or removing fixed prefixes to IDs.
- Change in the order of properties on existing responses.
- Addition of new values to existing enums.
- Addition of new event types.
- Undocumented API methods can have breaking changes at any point