clsOAuthREST Step

Use this step to make REST API calls using the OAuth Token.

Last published at: January 19th, 2026

Description:

This step makes the REST API calls using the OAuth token.  

 

Inputs

  • selOAuthProvider - Select OAuth provider from the drop-down list
  • restCallURI - Rest call URL
  • httpMethod - Select HTTP method to use (get, put, post, patch, delete)
  • headers - Define headers information
  • payloadType - Select Payload Type (FORMURL, XML, JSON)
  • payloadData - Define payload information key & value pairs 
  • payloads - Define payload raw data 
  • sourceFilePath - Path of the source file to be uploaded
  • resultJson - Store result values in variables or global
 

 

Returns

  • True – step executed successfully
  • False - step failed to execute
 

 

 

Usage:

 

 

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. 

 

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.
  • 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 the 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 properties of the figure.

 

  • 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. 

 

 

Definition Sample:

You may download the sample definition(s) from the link provided and later import them (drag-and-drop) into your FlowWright Process Definition (XML file) or Form Definition (HTML file) page. 

Note: Please verify and complete the process steps for any missing configurations, such as file path references and database connections, after the import. Then, save the definition to confirm the changes. 

Click here to download the sample file.