Centro de suporte da Workiva

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 will move to 2026-01-01 automatically on 30 November 2026, and you won’t need to do anything. See Workiva Connector: Commands moving to Platform API 2026-01-01 for the full list. The Run Report and List Users commands have changes that require action on your part, so you will have to choose when to switch them. You have until 31 October 2027 to make these changes. On that day, these commands will be changed to the new API, and will not work until they are configured correctly.

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 command with no value uses 2022.

Other changes

Note: Output names stay the same, so the rest of your chain keeps working.

• 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:read scope to be included on your OAuth2 grant.

For more information on the API changes, including spreadsheet command changes, refer to the Workiva Support page Workiva Connector: Commands moving to Platform API 2026-01-01.

Executar relatório

O que permanece o mesmo

• Inputs: Report Id, Preview Content.
• Output: the Report CSV file.
• The command finishes only after the file is ready.

What changes in 2026-01-01

• The command starts an export of the report, checks its status about once a second, then downloads the CSV.
• The chain log will show "Checking operation status...", a status of acknowledged, queued, or started, and "Operation completed successfully." if the command completes correctly. If the command does not complete correctly, the message "Operation failed" is recorded in the log.
• This command can take longer to run than it did in the 2022-01-01 version, as the connector checks the export up to 300 times or a maximum of 10 minutes, whichever comes first. At one check per second, that is about 5 minutes. If the export is not finished by then, the command fails.
• Tip: If the chain command timeout is shorter than the export, raise it so the file can arrive.
• A wrong Report Id usually fails with "operation failed".
• No new permission is needed. The OAuth2 grant still needs graph:read.

Switch a command to 2026

1. Open the chain and select the Run Report command.
2. Set API Version to 2026.
3. Save and run the chain.
4. Check that the Report output has the data you expect.

Solução de problemas

List Users

O que permanece o mesmo

• Input: Organization ID.
• Outputs: the Users Report JSON file and Record Count.
• The OAuth2 grant user must be an organization admin.

What changes in 2026-01-01

• The OAuth2 grant used by the connection needs to have the organization:read scope.
• Without that scope, the command will fail with an "Unauthorized (401)" or "Forbidden (403)" HTML error instead of returning a list of users.

Switch a command to 2026

1. An Org Security Admin adds organization:read to the API grant whose client ID is saved on your Workiva connection:

   1. In the top right, click the user icon, select Admin, then Organization admin.
   2. In the left menu, select Security, then the Provisioning tab.
   3. Find that grant and open it from the Actions menu.
   4. In Scopes, select organization:read and save. The client secret stays the same.

   Note: organization:read is an organization scope. It is not assigned from Workspace Settings. 
   For more information, see the Workiva Support page Create and manage API grants in Organization Admin.

2. Open the chain and select the List Users command.
3. Set API Version to 2026.
4. Save and run the chain.
5. (Optional, but recommended) Record the Record Count value. 
   1. Change the API Version value back to 2022, and run the chain again. 
   2. Confirm that the Record Count value is the same for both runs.

Notas

• The default API version is 2022-01-01, which is what a command with no value will use.
• New commands should be set to 2026.
• You can choose 2022 or 2026 for each Run Report and List Users command instance.
• The 2022-01-01 version will stop working on 30 November 2027. You will need to move your commands to 2026 before that date.
• Other Workiva Connector graph commands will move to 2026-01-01 automatically on 30 November 2026, and you don't need to change them. 
• Their JSON outputs can list fields and items in a different order. The values are the same.

Solução de problemas

E se eu não fizer nada?

Commands using these commands will keep using 2022-01-01 until 31 Oct 2027. After that date, commands set to 2022-01-01 will stop working.

Precisa de ajuda?

Contact Workiva Support.