Deprecation
When Bridge marks an API as deprecated, it means we’ve found a better way to accomplish the same thing. The deprecated endpoint still works today, but a superior alternative exists — and you should plan to migrate.Deprecated APIs are subject to removal in a future breaking change. We will always provide sufficient advance notice before removing a deprecated API.
What Deprecation Means
- A better path exists. Every deprecated API has a recommended replacement. You’ll find migration guidance documented directly on the deprecated method itself.
- It still works — for now. Deprecation is not removal. Your existing integrations will continue to function, giving you time to migrate on your own schedule.
- It will eventually go away. Deprecated APIs are candidates for removal in a future breaking change. When that happens, we’ll communicate a timeline and provide support for the transition.
Best Practices
- When you encounter a deprecated API, review the in-line migration guidance and plan your move to the recommended alternative.
- Avoid building new integrations on deprecated APIs. Use the recommended replacement from the start.
- Subscribe to the Changelog to stay informed about deprecations, removals, and breaking changes.