Prerequisite

• An active Bridge agent. Refer here to install and configure Bridge.

• Create the necessary Credentials for the applications to be connected by Task Engine.

For more details about the Task Engine module in Bridge, the keys, and its description, click here.

Example Use Case: During the employee onboarding process, after all the necessary employee provisioning is done, it is important to update the status in the HR team's recruitment software. To accomplish this, the Task Engine state can be utilized, and the provided API can be consumed to update the onboarding status.

Let us see how to configure Task Engine in Builder View and Code View.

Builder View

1. In Builder View, drag and drop the Task Engine state from the left pane into your circuit or click the required Task Engine state in your circuit.
2. Under the Configuration tab, update the common state field attributes.

3. Bridge/Cluster ID: Select the appropriate bridge or cluster from the drop-down list to execute the task. 

4. Under the Add Configuration section, fill in the following fields:
   
• Credential ID: Select the credential from the dropdown list. The Credential IDs of all the credentials created for the Task Engine module type will be displayed in the list.
• Request Method: Choose one of the methods: GET, POST, PUT, or DELETE.
• Request URL: Enter the API URL. 
  
• For GET and DELETE methods, enter the API URL only.
  
• For POST and PUT methods, enter the API URL and choose the Body Type:
  
• Text, JSON, XML, HTML, JavaScript: Enter the data directly in the Content section.

• URL Encoded, Form Data: Click Add in the Body section and enter data as key-value pairs.
5. Error Handling (optional): Select and configure error handling options. For detailed information, refer to Error Handling in Circuit states.     
   

     

6. In the Input /Output section, you can optionally fill in the following fields:
   
1. Enter the Input Path, Output Path, Result Path, and Result selector. Learn more about I/O paths.
   
2. Parameters: Click Add Parameter and specify the parameter name and parameter value. These parameters will be sent to the third-party application while triggering the webhook.
   
3. Headers: Click Add Header and specify the header name and header value. The configured headers will be appended to the API request while triggering the webhook.    
   

    

Code view

In Code View, the JSON to configure the Task Engine state to update status using an API is given below:

"Update Onboarding Status": {
    "type": "task_engine",
    "next": "Onboarded Successfully",
    "payload": {
        "credential_id": "api_cred_1",
        "method": "POST",
        "url": "https://recruitapp.com/update_status",
        "parameters": {
             "employee_name": "John Mathew",
             "employee_email": "john_mathew@sweriomail.com",
             "onboarding_status": "onboarded"
        },
        "headers": {
             "AuthorizationKey": "$.APIKey"
        }
     },
  "bridge_id": "bridge-1369_1"
}