Webhooks | Configuring a Webhook - Zoho Forms

Configuring a Webhook

In simple terms, a webhook is a way for one system or application to send real-time data to another system or application as soon as an event occurs. A webhook is basically a notification that is sent to a destination (URL) when an event occurs. With Zoho Forms, you can send a form submission to a URL or a third party web application of your choice as soon as a form entry is received.

If you are looking to process the data collected through Zoho Forms in your web application or use it in your business workflows, you can use Webhooks. You can receive form submissions as soon as it's collected without having to use APIs.
For example, you can directly store the collected data in your database, display it on your website, and do a lot more.

To configure a Webhook, 
  1. Click the Integrations tab from the form builder and select Webhooks from the left menu.

  2. Click Configure Webhook and fill the following details:

    Webhooks configuration

    • Webhook URL: The URL to which the form submission should be sent.

    • Content Type:  We send notifications to your Webhook URL through an HTTP POST request. The request body, containing the form data will be sent in one of these content formats:
      Content-Type
      Data Transferred
      application/json
      All except file attachments
      application/x-www-form-urlencoded
      All except form attachments and subform data
      multipart/form-data
      All except subform data

      See the response format for each content typhere

    • Authorization TypeSelect the desired Authorization type to be either General or one that is a configured connection in the Control Panel. If you choose Connections to be the Authorization Type, you can choose the appropriate connection from the list in Connection Name
      If a new connection is added, click the refresh icon next to the Connection Name dropdown list to select the newly added connection. Read more on creating connections.
      Note: The Connection Name will only list the existing active connections. Read more about Connections.

    • Payload Parameters: Under this section, choose the fields whose data should be transferred using Webhooks.

      1. Under Payload Parameters, define a parameter name and choose the relevant form fields under Parameter Value.
      2. When using application/json content type, you can also transfer data from Subform using Webhooks.
      3. When using Payment field in the form, you can transfer the payment details via Webhooks. The supported fields are: Payment Amount, Payment Status, Payment Currency and Payment Transaction ID. Zoho Forms typically passes the transaction status and the form submission asynchronously, since the form submission and the payment status isn't done at the same time.

        How do asynchronous payment transactions work? 
        After the form submission, the respondent is redirected to the payment site. Initially, a pending status via webhooks is sent for the payment transactions within a few seconds. The final response is known only when the merchant initiates the transaction.
Note: We recommend enabling the workflow option while setting up the Payment field. This ensures that the real-time Payment Status and Transaction ID are sent via webhooks, instead of the pending status.
  1. URL Parameters: If you would like to send additional information along with the collected data, you can specify it in this section. For example, you can include a secret key to every request being sent. This would help you in filtering out authenticate requests. These parameters will be added as query strings to the URL. Click on Add Parameters and enter the parameter name, value in the text boxes provided. 

  2. Custom Headers: You can set a custom header name and value to be passed with your collected data. 

    Example
    If you have set up basic authentication for your webhook URL, you can receive a corresponding header by setting up the custom header as follows:

    Custom Headers


    The custom header 'Authorization' will appear as:

    Authorization: Basic dXNicm5hbWU6cGFzc3dvcmQ= 

Note: The following must be noted while setting up a Custom Header :

  1. A standard (system) header cannot be redefined. 
  2. A custom header name must contain alphanumeric characters only. Only special characters allowed are underscore (_), period(.), and hyphen(-).
  3. Duplicate names are not allowed.
Click Save to save your settings and Webhooks will be enabled for this form.

How to re-push values into an integrated service after fixing the cause of integration failure?

  1. Go to the All Entries section of your form.
  2. Click the filter-by All Entries dropdown in the top-left corner.
  3. Scroll down and select Webhooks - Failed Entries option from the list.

    Failed entries

  4. Select the failed entries and click Re-push.
Note: You can re-push the failed entries only twice.

    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





                        Still can't find what you're looking for?

                        Write to us: support@zohoforms.com

                                                                       
                            



                            





                                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

                                      Zoho Desk Resources

                                      • Desk Community Learning Series


                                      • Digest


                                      • Functions


                                      • Meetups


                                      • Kbase


                                      • Resources


                                      • Glossary


                                      • Desk Marketplace


                                      • MVP Corner


                                      • Word of the Day


                                        Zoho Marketing Automation

                                          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 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







                                                                                            You are currently viewing the help articles of Sprints 1.0. If you are a user of 2.0, please refer here.

                                                                                            You are currently viewing the help articles of Sprints 2.0. If you are a user of 1.0, please refer here.



                                                                                                  • Related Articles

                                                                                                  • Welcome to Zoho Forms!

                                                                                                    Every business, big or small, needs to scoop up data at some point. Data helps businesses understand their customers, and figure out what's working and what's not. It's like having a map to guide you through the business journey. Transform the ...
                                                                                                  • How to build interactive forms online?

                                                                                                    What are interactive forms? Interactive forms are the ones which visitors can engage without any difficulty, providing them a user-friendly approach rather than the feel of paperwork. This is essential to make the form filling experience smooth and ...
                                                                                                  • Adding a new record to a Zoho CRM module

                                                                                                    Table of Contents Integration Setup Supported Modules, Attachment Fields, Field Types Trigger Actions in Zoho CRM while adding a new record Set Alert on Integration Failure Using the Zoho Forms - Zoho CRM integration, you can automatically push your ...
                                                                                                  • Creating your first web form in Zoho Forms

                                                                                                    This walkthrough is to help you get started with creating a form using Zoho Forms. Follow the simple step-by-step instructions given below to build forms that perfectly match your requirements. Creating a new account To build a form using Zoho Forms, ...
                                                                                                  • Understanding Card Forms

                                                                                                    Assume you meet a new person and want to get along with them, and you say: Hey, what is your name, phone number, address, likes and dislikes, and so on? Being bombarded with questions before they have finished answering the first can frighten the ...
                                                                                                    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