Staffbase continuously enhances its APIs to keep pace with platform growth, expanding feature sets, and evolving security requirements. In some cases, this means older APIs or endpoints need to be phased out. The deprecation policy provides clear guidance on what to expect and gives you enough time to migrate to available alternatives. This ensures that your integrations remain stable and user experiences are not disrupted.
Deprecation is considered only when an API or endpoint is no longer in active development and has entered into maintenance or retirement mode of its lifecycle. During the deprecation period, the API remains fully functional and continues to work with your integrations. However, it is no longer actively maintained, and no new improvements are introduced. Staffbase recommends migrating to the latest version as early as possible.
Staffbase strongly discourages new adoption of deprecated APIs or endpoints.
Deprecation timeline and communication
The deprecation process is designed to give developers predictability and sufficient time to migrate. The exact timeline may vary depending on factors such as the usage of the API or endpoint, and the stability of the available replacement. In most cases, the deprecation period lasts 6 months from the announcement date.
You can continue using the deprecated version until its scheduled removal date. This allows you to plan, test, and roll out an update at your own pace. To avoid disruption, ensure that you complete your migration before the API or endpoint is removed. Deprecations are announced in the Developer Portal Changelog, and the corresponding documentation is marked as deprecated with the scheduled removal date.