Breaking Changes
We give at least 30 days’ notice before a breaking change to the Sessionboard Public API or to Sessionboard embeds takes effect. This is our standard for every customer and integration partner.
How you hear about it
Section titled “How you hear about it”- Release notes. The change is listed in the Changelog, marked Breaking, with the date it takes effect. That date is at least 30 days after the entry is published.
- Email. We email the technical contacts we have on file for organizations that use the affected endpoint, field or embed option.
- Side by side where we can. Where possible, the new behavior ships alongside the old one during the notice period, so you can switch over before the old one is removed.
What counts as a breaking change
Section titled “What counts as a breaking change”A change is breaking when an integration that works today could fail or misbehave after it, without any change on your side. That includes:
| API | Embeds |
|---|---|
| Removing or renaming an endpoint, field or query parameter | Removing or renaming an embed type or a documented attribute |
| Changing a field’s type, format or the response envelope | Changing the default behavior of a documented attribute |
| Changing the status code returned for an existing case | Removing or renaming a documented CSS custom property |
| Making a request that succeeds today fail | Changing the script URL or loading method you were told to use |
| Requiring a new token scope for an existing endpoint | Requiring new attributes to keep an existing embed working |
When a bug fix changes behavior an integration could depend on, we treat it as breaking and give the same notice.
What ships without notice
Section titled “What ships without notice”These changes are additive, and we ship them as soon as they are ready:
- New endpoints, new optional parameters and new response fields
- New values in fields that already hold a set of values. Build your client to ignore values it does not recognize.
- New embed types, new optional attributes and visual refinements that keep documented attributes working
- Corrections to this documentation that do not change the API
Exceptions
Section titled “Exceptions”A fix for a security or data-protection issue may take effect with shorter notice when waiting would put customers or their data at risk. We announce it in the Changelog and by email as soon as we can, and explain what changed.