Processes API Preview

The Connected Processes API allows users to create, modify and run processes. Key to understanding connected processes is understanding how processes are connected to actions and tasks.

• Process: A process refers to a collection of jobs that need to be performed to achieve a desired result. In Connected Processes, each process is associated with a tree structure defining the execution order for the process’ jobs.

• Process Instance: A process instance is an individual execution of a process. There is a 1:N relationship between a Process and a Process Instance.

• Job: Each process is defined as a collection of jobs that are organized in a tree structure.

• Job Instance: A job instance is an execution of a job. Similar to a Process, there is a 1:N relationship between a Job and a Job Instance.

• Argument: Each Job and Job Instance has arguments that define the input for each job / job instance. These arguments are associated with the Action that executes the Job.

• Action: An action is a unit of work. Actions are responsible for executing job instances.

Using This Preview

The Processes API Preview is released as a new version of the Workiva API (see Versioning). To use this feature preview, include an X-Version header with the value 2026-04-01.processes.preview on all requests. Then, fetch a bearer token using the POST /oauth2/token endpoint (see Authentication for details). You can then use that token to call any of the new endpoints documented in this API preview.

Preview Status

This API is a preview capability and may change before general availability. For preview terms, expectations, and lifecycle details, see API Previews at Workiva.