API Version Update & New Versioning Process Launch on January 26
On January 26, we are releasing a significant upgrade to our public API and launching a new, long-term API versioning policy to ensure stability, reliability, and continuous innovation.
API release and new versioning policy
On January 26, 2026, a new version of our public API will be made available. Please note the following critical information:
- No immediate breaking changes: This is an opt-in upgrade. Your existing API integrations and setups will not break on January 26. We encourage you to adopt the new version at your convenience, but your current setup is supported for years to come.
- New versioning policy: This date marks the launch of our new API versioning process, which ensures that all major API versions will have a three-year support window from their release date, giving you ample time to plan and migrate.
- Why should I make plans to upgrade? Future upgrades will only be released in the new version. Develop plans to adopt the new API version to take advantage of the latest capabilities, enhanced security, and greater stability.
Prototype API deprecation
The existing prototype API will begin its deprecation process on January 26, but there will not be any interruption to any prototype API setups for several months.
- Functionality: The prototype API will continue to function for your existing integrations. The tentative sunset date is January 2027. New features that were in prototype previously are now stable and fully supported in the new version, releasing in January.
- Documentation: We will remove support content for the prototype API from the Developer Site to encourage the adoption of the new, fully supported version.
Resources
To help you with this transition, we have updated the Developer Site and Community with comprehensive self-service resources:
- We’re glad you’re on the Workiva Community! Follow the Workiva APIs and Scripting topic to find FAQs about the upcoming changes, connect with other Workiva Developers, and be the first to hear about future API updates.
- Workiva Platform API Upgrade FAQ
- Upgrade kit: A dedicated guide to walk you through the adoption process, including clear instructions on how to opt-in to the new version.
- API versioning best practices: Review the article for best practices about scripting and API versioning.
0
U moet u aanmelden om een opmerking te plaatsen.
Opmerkingen
0 opmerkingen