Workiva Connector commands use the Workiva Platform API. The current version is 2022-01-01, but this will be retired. To keep your chains working, we’re moving every Workiva connector command to version 2026-01-01.
Most Workiva connector commands move to 2026-01-01 automatically on 30 November 2026, and you won’t need to edit your chains. Inputs and outputs do not change.
Graph commands
These commands work the same as before:
- Recuperar uma lista de tipos
- Recuperar um único tipo
- Recuperar um único registro
- Recuperar uma lista de registros
- Get Reports
- Criar novas edições de registros
"Run Report" and "List Users" commands
These two commands have changes that require action on your part, so you choose when to switch them. You have until 31 October 2027 to make these changes. See Run Report and List Users command changes for the steps.
API version selection
Both commands now have an API Version field that allows you to specify 2022 or 2026. The default is 2022, so a step with no value uses 2022.
Other changes
- Run Report now exports the report before downloading it. This can take longer and fails if the export takes more than about 5 minutes. It should not run for more than 10 minutes.
- List Users needs the
organization:readscope to be included on your OAuth2 grant.
Note: Output names stay the same, so the rest of your chain keeps working.
Spreadsheet commands
These will also be automatically updated, and no chain edits are required. Inputs and outputs do not change, but a few things work differently:
- Delete Spreadsheet moves the spreadsheet to the trash instead of deleting it permanently.
- Get Sheet Data ignores the Revision value and returns the latest data with a warning.
- Write, Overwrite, Clear Sheet Data, Update Sheet Metadata, Publish Spreadsheet, and Delete Spreadsheet now wait until the change finishes, and ignore the Use Async setting. These commands will fail if the change takes more than about 5 minutes.
- Get Sheet Data, Write Sheet Data, and Overwrite Sheet Data ignore the Use Platform API setting.
How to switch to the new version
For explicit instructions, refer to the Workiva Support page Run Report and List Users command changes.
Perguntas? Contact Workiva Support.