Backwards Compatibility#
The following changes are considered backwards compatible and may be made at any time without advance notice:
- Adding new API endpoints
- Adding new properties to responses from existing endpoints
- Reordering properties returned from existing endpoints
- Adding optional request parameters to existing endpoints
- Altering the format or length of IDs (strings will never exceed 255 characters)
- Altering
messageattributes returned by validation failures or other errors - The number of and duration between retries for failed webhooks
- The behaviour of Scenario Simulators
- Sending webhooks for new event types
Any changes that are not backwards compatible will be released as a new API version and communicated in advance.