Backward Compatibility

What backward compatibility means

Backward compatible changes do not require existing integrations to modify their code. New capabilities may be introduced, but previously supported behavior will continue to function as documented.

The following changes are considered backward compatible:

• Adding a new SDK method or capability.
• Adding a new optional parameter to an existing SDK method.
• Adding a new enum value (accepted in inputs or returned in outputs).
• Relaxing constraints on an existing request parameter (for example, changing a required request field to optional).
• Adding a new field to a returned object.

The following changes are not backward compatible unless explicitly versioned or communicated as breaking changes:

• Changing a previously required response field to optional, if integrations were documented to expect that field to always be present.

Forward Compatibility Guidance

To help ensure forward compatibility, integrations should:

• Ignore unknown fields or enum values returned in responses.
• Tolerate the absence of optional response fields.
• Treat opaque identifiers as stable strings and avoid inferring meaning beyond their documented format.