Task Engine | Qntrl | Bridge | Online Help | Execute API's hosted in private network

Task Engine

In Qntrl, while public APIs can be configured and executed directly through Webhooks, the client's internal APIs that are exposed only to the local network can be executed using the Task Engine module in Bridge. The Task Engine configured in Bridge can be utilized in the following two modules within Qntrl.

  1. API Lookup field - Search for specific information in a large amount of API response data and extract the desired information. Check API Lookup for more details. 
  2. Circuit - Within the Circuit workflow, the Task Engine is utilized to execute tasks that necessitate access to APIs within a restricted environment. Check Task Engine for more details. 
Prerequisite

While creating Credentials for Task Engine, choose the credential type as API key. Click here to learn how to create a credential.

 

Request data  

{
      "task_name": "api_task",
      "credential": {
             "name": "<CREDENTIAL_NAME>"
       },
       "task_details": {
             "method": "<METHOD_NAME>",
             "url": "<API_URL>",
             "parameters" : {
                     "<PARAMETER_NAME>" : "<PARAMETER_VALUE>"
             },
             "headers" : {
                    "<HEADERS_NAME>" : "<HEADERS_VALUE>"
            }
       }
}

where,
Keys
Description
 task_name
 
A system-defined name for the respective modules. 'api_task' is the task name for
Task Engine.
 credential
 
 JSON object that contains the name of the API credential. 
 name
 (optional)
 Name of the API credential.
 task_details
 A JSON object that contains details of the task.
 method
 API method used - GET/POST/DELETE.
 URL
 API URL to be invoked.
 parameters
 (optional)
 JSON that contains the name and values of API parameter.
 headers
 (optional)
 JSON object that contains header name and values for API.



    • Related Articles

    • Task Engine

      Circuit's Task Engine state is used to connect with other applications and access APIs from a closed space. To retrieve data from a private network, the required API must be accessed from the local machine's network for the required conditions. ...

    • Credentials

      The Credential module provides a streamlined solution for storing and managing authentication credentials for databases, remote machines, and application servers. Organizations dealing with multiple databases or APIs often face repetitive credential ...

    • Manage Webhooks

      Webhooks Overview Webhooks facilitate automated HTTP notifications. Notifications are triggered in third-party applications as per the business requirements when a predefined action is performed by the user in the organization. Business Use Cases of ...

    • Bridge agent settings

      Once the Bridge agent is set up, you can log in to the bridge agent to view and modify the allowed configuration as needed. To do this: In Qntrl, navigate to (settings) >> Advanced >> Bridge, then select your bridge. Hover your cursor over the bridge ...

    • DB Engine

      DB Engine is used to connect with the database in the client's machine or client's network and perform READ/INSERT/UPDATE operations in the database. The DB Engine configured in Bridge can be utilized in the following two distinct modules within ...

    You are currently viewing the help articles of Qntrl 3.0. If you are still using our older version and require guidance with it, Click here.