oAuth REST Call

Use this step to perform REST API calls using the oAuth token

Last published at: March 6th, 2025

clsOAuthREST Step

Description:

This step performs 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 any OAuth source (e.g., Google Drive, Facebook, Hotspot, etc.) in the FlowWright application and navigate to the Integration—Connections—OAuth Connections page. 

 

Example:

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

  • Create a new process definition called “clsOAuthRESTDef” and open the definition 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. Provide the step name. Select the OAuth Provider from the drop-down list. Provide the REST call URL. Select the HTTP method to use from the drop-down list. Select the payload type from the drop-down list. Provide 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, provide the raw data for the payload. Click the button to specify the payload information. Provide the source file path on the app server to upload the raw payload data. Click the Save button. 

 

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

 

  • Use either one of the following ways to pass the payload information to the service. Payload raw body refers to the properties of the figure.

 

  • The “Logging” setting configuration is necessary for documentation and also measures the workflow progress and the 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 then 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 here and later import them (drag-and-drop) to 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 import. Then, save the definition to confirm the changes. 

Click here to download the sample file.