Developers
Deprecation policy
Nothing in the public API or webhooks has been removed since this reference was written. This page states the policy in advance, so you know what to expect if that ever changes rather than finding out from a broken integration.
- When something in the public API or webhooks has to change in a way that could break an integration, the old behavior keeps working alongside the new one for a transition window, instead of switching over without warning.
- Where possible, the change carries a signal you can detect in code, not only prose in release notes: a webhook delivery that still carries an old, deprecated header also carries an X-WorkBOS-Deprecation header naming the date that old header stops being sent, on every single delivery, so a script can watch for it without a person reading anything.
- Announcements are posted to Updates & release notes, the same feed that lists every release, so you do not need a separate mailing list to hear about one.
This page does not promise a fixed number of days for every future change: the transition window is sized to the change. What is fixed is the shape of the warning: a working alternative exists before the old path is retired, and where the change touches a request or a response you can check in code, a header tells you so.
Was this page useful?