Key Capabilities

• Send REST API requests using GET, POST, PUT, or DELETE methods.

• Include parameters, headers, and body content in your requests.

• Use variables to pass values dynamically at runtime.

• Parse API responses to extract specific data for further use in workflows.
  

Create an API 

To create a REST API configuration in Qntrl:

1. Navigate to (settings) >> WEB SERVICES >> Outbound >> Click REST.

2. Click Create API in the top-right corner.

3. Enter a name for the API in the left sidebar.

4. Select the HTTP method: GET, POST, PUT, or DELETE.

5. Enter the API URL (endpoint) of the service to which the request should be sent.
   

6. Enable Connection (Checkbox): Select this checkbox to send the request through a DRE connection.
• Once selected, a dropdown appears with available connections.
• Choose an existing connection or create a new one.
• The connection status is shown with a color indicator:
  
1. Green means the connection is active.
2. Red means it’s inactive.
   

Request Configuration 

For all sections—Query Parameters, Headers, and Body—you can use static or dynamic values in the following formats:

• {{variableName}} for runtime values.
• ${configstore-name} to use values from the Config Store.
• Directly entered literal values.
  

Use the + icon to add fields or – to remove them as needed.

1. Query Parameters  : Define key-value pairs to be appended to the API URL.
   

• KEY: Name of the query parameter.

• VALUE: Input based on the formats mentioned above.

2. Headers  : Set required HTTP headers for the request.

• KEY: Header name (e.g., Authorization)

• VALUE: Input based on the formats mentioned above.

3. Body (POST & PUT Only)  : Select the format and provide the data.

• None: Select this if the request does not require a body.

• form-data: Enter the keys and values.

• x-www-form-urlencoded: Enter the keys and values.

• Raw: Supports Text, JSON, or XML for complex payloads.

4. Test API with variable values: Use the refresh icon to load the available variables. Enter sample values for each variable to test the API request. This helps you verify the configuration before saving. After sending the request, you can view the test response in the Response tab.

• The test feature is for validation purposes only and does not affect the actual saved configuration.                        
  

• You can add up to 20 key-value pairs in the request configuration.

• A maximum of 20 JSON paths can be defined in the Response Parser.
  

Using Variables in REST Requests  

You can insert variables anywhere in the request configuration using the {{variableName}} syntax.

• Static Values: Entered manually in the UI (via "Test API With Variable Values").

• Dynamic Values: Passed at runtime using scripts or Codex.

When triggering from Codex, provide variables as a JSON object:

{
  "jobId": "1123",
  "email": "john.doe@swerio.com"
}

These values will replace the placeholders {{jobId}} and {{email}} across Query Params, Headers, and Body.

Response Parser  

After execution, use the Response Parser to extract specific data from the JSON response.

• Qntrl automatically filters the response and suggests commonly used JSON paths.

• From the suggestions, click ADD next to a path, give it a name, and click SAVE to store it.

• You can add multiple fields to extract the data you need.

      

The extracted values will appear as the Applied Response during the next execution, displayed alongside the full original response.

Scripts to Modify the Outbound REST Request or Response 

Pre Script  

function beforeSend() {
    try {
        
        var queryParams = webservice.outboundREST.getQueryParameter();
        console.log("Query parameters "+queryParams);
        // Add a new query parameter.
        var timestamp = new Date().toISOString();
        webservice.outboundREST.addQueryParameter("timestamp", timestamp);
        // Replace variable values.
        var variables = {};
        variables["user_id"] = "21499000000115251";
        webservice.outboundREST.replaceVariableValues(variables);
        // Add a custom header
        webservice.outboundREST.addHeader("x-tracking-id", "track-" + Date.now() );
        console.log("Modified query params --> " + webservice.outboundREST.getQueryParameter());
        console.log("Modified headers --> " + webservice.outboundREST.getHeader());
    } catch (e) {
        console.log("Error in beforeSend: " + e.message);
        webservice.outboundREST.setResponseCode(500);
    }
}

Post Script  

• You can modify the response code, headers, or data.
• The defined response parser will automatically run on the response, and its output will be available as the applied response.
• The modified response from the Post Script will be got as the final response.

function afterSend()
{  
    var appliedResponse = JSON.parse(webservice.outboundREST.getAppliedResponse());
    console.log("appliedResponse -->" + appliedResponse);
    var variables = JSON.parse(webservice.outboundREST.getVariableValues());
    var varJson = {};
    varJson['account_id'] = appliedResponse.CRM_Account_ID;
    varJson['oauth_token'] = variables.oauth_token;
    var crmResponse = OutboundREST.executeByName("GetAccountDetailsCRM", varJson);
   if (!crmResponse || Object.keys(crmResponse).length === 0)
   {
     webservice.outboundREST.setResponseCode(500);
     webservice.outboundREST.addResponseHeader("crm_error","unable to fetch CRM data.");
   }
  else
  {
    appliedResponse['crmResponse'] = crmResponse;
    webservice.outboundREST.setAppliedResponse(JSON.stringify(appliedResponse));
    console.log("appliedResponse -->" + JSON.stringify(appliedResponse));
  }  
}

Configure Additional Settings 

1. Connection Timeout: The maximum time allowed to establish a connection between the client and the server (default: 5 seconds).
2. Scope: Define the scope or permission level.
   
3. SSL Certificate Verification: Enable this option if your server requires SSL certificate validation. 
1. Qntrl will verify the server’s SSL certificate when sending requests to ensure secure communication.
2. The certificate is fetched based on the host and port in the URL.
3. If multiple certificates are available for the same host and port, the most recently added one will be used.
4. If the port is not specified in the URL, Qntrl will default to port 443 (standard for HTTPS).

      

Save and Execute the Request     

To save the configuration:

• Click Save. The API will now be listed in the left sidebar.

• Click Send to execute and test the API. This also saves the API configuration.

• After execution, view results under the Response tab.

Editing test results does not change the actual configuration. Always save updates before re-testing.

OutboundREST.execute("<api_id>", <variables>);

let requestData = {};
requestData["approvalStatus"] = "Approved";
OutboundREST.execute(31453000002078039, requestData);

OutboundREST.executeByName("api_name", <variables>);

let requestData = {};
requestData["approvalStatus"] = "Approved";
OutboundREST.executeByName("TaskApprovalAPI", requestData);

Other Actions 

You can manage your Outbound REST API using the available options in the left panel.

• Enable or Disable: Use the toggle switch next to the API name to activate or deactivate the API.

• Rename or Delete: Click the more actions (...) icon next to the API and choose Rename or Delete as needed.