Description:

The OAuth REST Call workflow step performs REST API calls using an OAuth token. It allows a workflow to select an OAuth provider, specify the REST endpoint and HTTP method, optionally define request headers and payload information, optionally upload a source file, and store the result in a Variable or Global.

The step supports:

• Selecting an OAuth provider.
• Specifying the REST API URL.
• Selecting the HTTP method.
• Defining request headers.
• Selecting a payload type.
• Supplying raw payload data.
• Mapping structured payload information.
• Supplying a source file for upload operations.
• Storing the REST response in a Variable or Global.
• Routing workflow execution through True or False return paths.

Usage:

Use the OAuth REST Call step when a FlowWright workflow needs to communicate with a REST API that requires OAuth-based authentication.

A typical workflow pattern is:

Prepare Data → OAuth Rest Call → Process Response

For example:

Prepare Request
      ↓
oAuth Rest Call
      ↓
Process Response
      ↓
Continue Workflow

To use this step, you must configure an OAuth source (e.g., Google Drive, Facebook, or Hotspot) in the FlowWright application, then navigate to the Integration > Connections > OAuth Connections page. 

A sample OAuth configuration is provided for reference. 

Typical Workflow Suggestions:

Invoke an OAuth-Protected REST API

Use OAuth REST Call when a workflow needs to call a REST API that uses an OAuth provider.

Example:

Start
  ↓
Prepare Request
  ↓
oAuth Rest Call
  ↓
Process Response
  ↓
Complete

OAuth Provider:
[Select configured provider]

REST Call URL:
https://api.example.com/customers

HTTP Method:
[Select method]

Store Result:
CustomerApiResponse

Retrieve Data from an OAuth-Protected API

Use the step to retrieve information from an external REST service and store the response for subsequent workflow processing.

Example:

Start
  ↓
oAuth Rest Call
  ↓
Store API Response
  ↓
Evaluate Response
  ↓
Continue

REST Call URL:
https://api.example.com/customers/12345

Store Result:
CustomerResponse

Send Data to an OAuth-Protected REST API

Use the step when workflow data needs to be submitted to an external REST API.

Example:

Collect Order Data
      ↓
Prepare Payload
      ↓
oAuth Rest Call
      ↓
Process Response

For example:

{
  "orderId": "{{OrderID}}",
  "amount": "{{OrderAmount}}"
}

Upload a File Through an OAuth-Protected REST API

Use the optional Path of the source file to be uploaded property when the REST operation requires a source file.

Example:

Prepare File
     ↓
oAuth Rest Call
     ↓
Process Upload Response

Source file:
C:\Documents\CustomerDocument.pdf

REST URL:
https://api.example.com/documents

Route Processing Based on the REST Call Result

Use the True and False return paths to separate successful REST processing from an alternate or error-handling path.

Example:

                  ┌── True ──→ Process API Response
                  │
oAuth Rest Call ──┤
                  │
                  └── False ─→ Handle REST Failure

Example:

Let’s build and execute the “clsOAuthRESTDef” Step example.             

• Create a new process definition named “clsOAuthRESTDef” and open it in designer mode. 
• Drag a "clsOAuthREST" step to the canvas.
• Connect the dots between the “Start” and "clsOAuthREST" steps, as shown above.
• Select the line between the steps to configure the “Connection Properties”. The default property values are “None, True, False, Error, and Evaluate”. Depending on the step’s purpose, you can configure additional values.
• Define a variable or a global to store the execution result.
• Click the "clsOAuthREST" step to configure its “Required” properties. Enter the step name. Select the OAuth Provider from the drop-down list. Enter the REST call URL. Select the HTTP method from the drop-down list. Select the payload type from the drop-down list. Enter the variable or global reference to store the result. Click the Save button. Note: Click the "AI Predict" button for Copilot to add new process steps that match your process description. 

• Click the "clsOAuthREST" step to configure its “Optional” properties. Click the button to define the headers. In the text box, enter the raw payload data. Click the button to specify the payload information. Provide the source file path on the app server where the raw payload data will be uploaded. Click the Save button. 

• Click the button to define the headers. A pop-up window appears for configuration. Click the Add Row button to insert an empty row. Enter the header key and value. Click the Save button. You may insert multiple header rows by using the Add Row button.  

• Use one of the following methods to pass the payload information to the service. The raw payload body refers to the figure's properties.

• The “Logging” configuration is necessary for documentation and also measures workflow progress and percent complete. This is achieved by configuring the step state and percent fields individually, as shown below. Configure the “Logging” using the following properties.

• Save the process definition, create a new instance, and execute it. Render the process instance. Click the process step to view its properties. The step should send an email and store the URL response in a variable or global, as configured. 

Tips:

• Select the correct OAuth provider for the target REST API.
• Verify that the selected OAuth provider is configured correctly in the target FlowWright environment.
• Use the exact REST URL required by the API.
• Select the HTTP method appropriate for the REST operation.
• Configure request headers only when required by the API.
• Verify the payload type before configuring payload information.
• Use Define Payload raw data when the API requires raw request content and that option is appropriate for the selected payload configuration.
• Use Define Payload information when the request is configured through the structured payload-mapping mechanism.
• Use workflow Variables when constructing dynamic URLs or request payloads.
• Store the REST response in a clearly named Variable or Global, such as CustomerApiResponse.
• If uploading a file, verify that the specified source file exists and is accessible to the workflow execution environment.
• Do not expose OAuth tokens or other credentials in workflow messages, payloads, or logs.
• Test the REST call using representative API data before deploying the workflow.
• Test both successful and unsuccessful REST-call scenarios.
• Connect the False path to appropriate error-handling or recovery logic.
• Verify the stored response before using it in downstream processing.
• Confirm that the configured request headers and payload match the requirements of the target API.
• Review environment-specific OAuth and REST configuration before moving the workflow between environments.

Definition Sample:

You may download the sample definition and later import it into your FlowWright Process Definition (XML file) or Form Definition (HTML file).

Note: Verify and complete any missing configuration after importing the sample, including:

• OAuth provider.
• REST call URL.
• HTTP method.
• Request headers.
• Payload type.
• Payload data or payload mappings.
• Source file path, if applicable.
• Variable or Global used to store the result.
• Environment-specific OAuth configuration.
• Downstream True and False workflow paths.

After verifying the configuration, save the Process Definition before execution.

Click here to download the sample file.