Run a Workflow in Synchronous Mode

Knowledge Center > Workflow > Using Workflow > Run a Workflow in Synchronous Mode

Run a Workflow in Synchronous Mode

Workflows run asynchronously by default. If you want to run a workflow and get results immediately, you can consider using the synchronous mode. Not all workflows are suitable for running in the synchronous mode. You may need to revise the tasks in the workflow or redesign the workflow.

The synchronous mode of Workflow is in Limited Availability. If you wish to have access to this mode, submit a request at Zuora Global Support.

The synchronous mode can only be triggered via API callouts.

Synchronous Mode Requirements

The synchronous mode has a timeout value of 110 seconds. If a synchronous workflow does not complete within the time frame, the workflow will switch to the asynchronous mode and continue to run. Because of the timeout, you need to use a query task for data retrieval. 

In addition, if you do not want the whole data payload in the response to be directly fed into your system, you need to reformat and filter the data in the response before pushing it to your system, or add a response formatter task at the end of your workflow.

Run a Workflow in Synchronous Mode

To run a workflow in synchronous mode, ensure that API callout is enabled as a trigger of the workflow, and send a request to the synchronous API endpoint of the workflow. You can use either API token or basic authentication (username and password) to authenticate to the workflow.

The synchronous API endpoint of a workflow is replacing "run" in the standard API endpoint with "sync". The standard API endpoint of a workflow can be found in the Settings tab of the workflow.

Synchronous API endpoint

https://workflow.apps.zuora.com/api/v1/workflows/{workflow_id}/sync
Note: {workflow_id} is different for each workflow.

Authentication
  • Option 1: API Token in Headers
    API-Token: {token_shown_in_settings}
    workflow_callout_config_token.png
  • Option 2: Basic Authentication
    Use the username and password shown in the Basic Auth section of the settings.
    workflow_callout_config_basic.png
 
Last modified

Tags

Classifications

(not set)