Task Engine state in Circuit | Qntrl | Circuit | Online Help

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.
 

Prerequisite

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

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

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

For associating a Task Engine state to a circuit:

  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. The Bridge ID field should capture the details of the Bridge to be used for this task. Click and select the appropriate bridge from the drop-down list.  

  4. Under Add Configuration section, fill in the following fields:
    1. Credential ID - Click and 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.
    2. Request Method - Field select the method (GET/POST). 
    3. Request URL - Enter the API URL. 
  5. In Error Handling, you can optionally select and configure error handling options. Refer to Error Handling in circuit states for further information.          
      

      6. Under the  Input/Output section you can optionally fill in the following fields:
    • Enter the required Input Path, Output PathResult Path, and Result selector. To learn more about I/O paths, click here.
    • 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.
    • 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 retrieve data using an API is given below:

"Update Onboarding Status": {
      "type": "task_engine",
      "next": "End",
      "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-employee onboarding"
}





Next : DB  

      Create. Review. Publish.

      Write, edit, collaborate on, and publish documents to different content management platforms.

      Get Started Now


        Access your files securely from anywhere

          Zoho CRM Training Programs

          Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.

          Zoho CRM Training
            Redefine the way you work
            with Zoho Workplace

              Zoho DataPrep Personalized Demo

              If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.

              Zoho CRM Training

                Create, share, and deliver

                beautiful slides from anywhere.

                Get Started Now


                  Zoho Sign now offers specialized one-on-one training for both administrators and developers.

                  BOOK A SESSION





                              Quick Links Workflow Automation Data Collection
                              Web Forms Enterprise Begin Data Collection
                              Interactive Forms Workplace Data Collection App
                              CRM Forms Customer Service Accessible Forms
                              Digital Forms Marketing Forms for Small Business
                              HTML Forms Education Forms for Enterprise
                              Contact Forms E-commerce Forms for any business
                              Lead Generation Forms Healthcare Forms for Startups
                              Wordpress Forms Customer onboarding Order Forms for Small Business
                              No Code Forms Construction RSVP tool for holidays
                              Free Forms Travel
                              Prefill Forms Non-Profit

                              Intake Forms Legal
                              Mobile App
                              Form Designer HR
                              Mobile Forms
                              Card Forms Food Offline Forms
                              Assign Forms Photography
                              Mobile Forms Features
                              Translate Forms Real Estate Kiosk in Mobile Forms
                              Electronic Forms Banking 
                              Notification Emails for Forms Alternatives Security & Compliance
                              Holiday Forms Google Forms alternative  GDPR
                              Form to PDF Jotform alternative HIPAA Forms
                              Email Forms
                              Encrypted Forms
                              Embeddable Forms
                              Secure Forms
                              Drag & drop form builder
                              WCAG

                                      Create. Review. Publish.

                                      Write, edit, collaborate on, and publish documents to different content management platforms.

                                      Get Started Now




                                                        You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.




                                                            Manage your brands on social media


                                                              • Desk Community Learning Series


                                                              • Digest


                                                              • Functions


                                                              • Meetups


                                                              • Kbase


                                                              • Resources


                                                              • Glossary


                                                              • Desk Marketplace


                                                              • MVP Corner


                                                              • Word of the Day


                                                              • Ask the Experts


                                                                Zoho Sheet Resources

                                                                 

                                                                    Zoho Forms Resources


                                                                      Secure your business
                                                                      communication with Zoho Mail


                                                                      Mail on the move with
                                                                      Zoho Mail mobile application

                                                                        Stay on top of your schedule
                                                                        at all times


                                                                        Carry your calendar with you
                                                                        Anytime, anywhere




                                                                              Zoho Sign Resources

                                                                                Sign, Paperless!

                                                                                Sign and send business documents on the go!

                                                                                Get Started Now




                                                                                        Zoho TeamInbox Resources





                                                                                                  Zoho DataPrep Demo

                                                                                                  Get a personalized demo or POC

                                                                                                  REGISTER NOW


                                                                                                    Design. Discuss. Deliver.

                                                                                                    Create visually engaging stories with Zoho Show.

                                                                                                    Get Started Now









                                                                                                                        • Related Articles

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

                                                                                                                          SSH Engine module in Bridge is used to perform actions in clients network/client's machine by executing a command/script in Linux/UNIX OS. Prerequisite While creating Credentials for SSH Engine, choose the credential type as SSH. Click here to learn ...
                                                                                                                        • PowerShell Engine

                                                                                                                          In Bridge, the PowerShell Engine module is used to perform actions in any Windows machines in the client's network using PowerShell script. Prerequisite While creating Credentials, select the type Powershell and provide the User Name and Password of ...
                                                                                                                        • 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 ...
                                                                                                                        • SSH Engine

                                                                                                                          SSH Engine state is configured to connect to a client's machine or network and remotely execute commands or scripts on the client's Linux/UNIX operating system. Prerequisite Bridge must be installed and should be active. To learn how to install and ...
                                                                                                                          Wherever you are is as good as
                                                                                                                          your workplace

                                                                                                                            Resources

                                                                                                                            Videos

                                                                                                                            Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                                                                                                            eBooks

                                                                                                                            Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                                                                                                            Webinars

                                                                                                                            Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                                                                                                            CRM Tips

                                                                                                                            Make the most of Zoho CRM with these useful tips.



                                                                                                                              Zoho Show Resources