Configure Webhook in Circuit | Circuit | Qntrl | Online Help

Webhook

Webhook promotes communication between Circuit and third-party applications. With webhooks, you can make API calls and trigger notifications when a predefined action is performed as per the business requirement.
 
Prerequisite
Create a webhook that has to be executed in bridge by giving relevant field details. Click here to learn how to create a Webhook in Qntrl.

Example Use Case: When it comes to the employee onboarding process, the Webhook state can be employed for electronic document verification procedures. This is accomplished by establishing a connection between the verification service provider and configuring it to transmit verification results or updates to your webhook endpoint. By analyzing the response received, the subsequent course of action can be configured.

Builder View

In Builder View, to integrate a Webhook in Circuit:
  1. Drag and drop the Webhook state from the left pane into your circuit or click the required Webhook state in your circuit.

  2. Under Configuration, update the common state field attributes.

  3. Type Webhook is selected by default. Select the Webhook Name to be added to the circuit from the drop-down list.

  4. Specify the Error Handling options for the state. To learn more about Error Handling, click here.   

      

  1. Under Input / Output on the right pane, you can optionally fill in the following details: 
    1. Enter the Input Path, Output Path, Result Path, and Result selector. To learn more about I/O paths, click here.
    2. In the Body, the data bytes required to send the request data are given.
    3. Besides the custom parameters and custom headers configured for the Webhook, define dynamic parameters and headers specific to this webhook state and this circuit using Add Parameter and Add Header.
    4. Add Parameter - Specify the parameter name and parameter value. These parameters will be sent to the third-party application while triggering the webhook.
    5. Add Header - Specify the header name and header value. The configured headers will be appended to the API request while triggering the webhook.  

      

  1. Click Save and Execute.
  2. Specify the test data as Input JSON for your test run, then click Next.
  3. Name your test run by providing a unique name for this execution. Click Run.
  4. Check for the data received from Qntrl Circuit through the webhook notification in your application.
  5. If there is a failure or data mismatch, modify your webhook settings in Qntrl Circuit.
  6. Repeat this test until you get the required data from circuit to your application.

Code View

The JSON for configuring a webhook in code view is given below:
"Verify Employee Documents": {
      "type": "webhook",
      "next": "Action - Approve or Reject",
      "webhook_id": "employee_document_verification_1",
      "parameters": {
            "pan_number": "pan.number"
      },
      "headers": {
            "AuthorizationKey": "$.APIkey"
     }
}







Next : Circuit state

      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 LinksWorkflow AutomationData Collection
                              Web FormsEnterpriseOnline Data Collection Tool
                              Embeddable FormsBankingBegin Data Collection
                              Interactive FormsWorkplaceData Collection App
                              CRM FormsCustomer ServiceAccessible Forms
                              Digital FormsMarketingForms for Small Business
                              HTML FormsEducationForms for Enterprise
                              Contact FormsE-commerceForms for any business
                              Lead Generation FormsHealthcareForms for Startups
                              Wordpress FormsCustomer onboardingForms for Small Business
                              No Code FormsConstructionRSVP tool for holidays
                              Free FormsTravelFeatures for Order Forms
                              Prefill FormsNon-Profit

                              Intake FormsLegal
                              Mobile App
                              Form DesignerHR
                              Mobile Forms
                              Card FormsFoodOffline Forms
                              Assign FormsPhotographyMobile Forms Features
                              Translate FormsReal EstateKiosk in Mobile Forms
                              Electronic Forms
                              Drag & drop form builder

                              Notification Emails for FormsAlternativesSecurity & Compliance
                              Holiday FormsGoogle Forms alternative GDPR
                              Form to PDFJotform alternativeHIPAA Forms
                              Email FormsFormstack alternativeEncrypted Forms

                              Wufoo alternativeSecure Forms

                              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

                                                                                                                          • Events

                                                                                                                            Early Access Events module is not enabled for all users. If you’d like to try it out, please email our support team for early access. In instances when your bridge is successfully connected and operational or faces unexpected issues causing ...
                                                                                                                          • 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. ...
                                                                                                                          • Parameters

                                                                                                                            Parameters provide the ability to customize JSON input by adding a collection of key-value pairs as input to a task. These values can either be static or dynamically selected from the JSON input or the context object using specific paths. Context ...
                                                                                                                          • Batch

                                                                                                                            Batch state allows you to execute a Function, Webhook, or Circuit in batches as multiple jobs in an iterative manner. While the Parallel state executes multiple states simultaneously using the same input, the Batch state executes the (same set of) ...
                                                                                                                          • Error Handling

                                                                                                                            In Qntrl Circuit, you can configure error handling while building a circuit. In most cases, state definition errors are detected even before saving the circuit, i.e. when you save the circuit, it runs a compilation check and lists out errors related ...
                                                                                                                            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