Workflow APIs

Introduces the available Workflow API operations.

Available API operations

You can use Workflow REST APIs to complete most of the basic tasks for Workflow. Workflow REST APIs are part of the Zuora REST APIs and use OAuth to authenticate to the API gateway.

To learn about how to make authenticated calls, see Get started tutorial in the Developer Center.

The following API operations are supported. For details about these operations, see the Workflows section in the API Reference.

API operation	Required access permission
List workflows	Workflow View Access
Retrieve a workflow	Workflow View Access
Delete a workflow	Workflow Manage Access
Update a workflow	Workflow Manage Access
Run a workflow	Workflow Run Access
Export a workflow version	Workflow Manage Access
Import a workflow definition	Workflow Manage Access
Import a workflow version	Workflow Manage Access
Delete a workflow version	Workflow Manage Access
List all versions of a workflow definition	Workflow View Access
Retrieve a workflow run	Workflow View Access
List workflow tasks	Workflow View Access
Retrieve a workflow task	Workflow View Access
Rerun a workflow task	Workflow Run Access
Update workflow tasks	Workflow Run Access
Retrieve workflow task usage	Workflow View Access
Stop a workflow run	Workflow View Access

Find workflow ID or task ID

To find a workflow ID, you can make a request to the List workflows operation. In the data payload of the response, you can find the ID for your workflow.

Finding the ID of a task is similar. Make a request to the List workflow tasks operation and locate the ID of the task in the data payload of the response.

Workflow id in response