Backward compatibility

Backward compatible changes

All the changes listed below are considered to be backwards compatible by Datakeen. Make sure to set up your systems in such flexible manner that it is able to handle these changes :

• Adding new properties (e.g., strings, objects, arrays) to existing API responses
• Changing the order* of properties in existing API responses, i.e., the order of strings, objects, arrays
• Adding new API resources, e.g., adding new API endpoints
• Adding new optional request parameters to existing API endpoints
• Changing the length or format of opaque** strings, such as error messages, object IDs, etc.
• Adding new event types to webhooks
• Adding new properties (e.g., strings, objects, arrays) to webhook payloads
• Webhook listener should gracefully handle unfamiliar event types
• Token expiry time increase

*As a general note on the order of properties in the responses, keep in mind that the order is not static. This means that the order you see in your API call responses may differ from the order you see in Datakeen documentation.

** This means data that your system should be able to just transmit or store, not interpret.

Backward incompatible changes

On the contrary the following changes are not to be expected :

• Property deletion (a property can be marked as deprecated but will not be deleted)
• Property type change (i.e a string becomes an int or an array, etc.)
• Property structure change (i.e an object's keys change, etc.)
• API URL route change
• Authentication mechanism change
• Token expiry time reduction