Configure a Webhook With Zoho Survey - Online Help Guide

Webhook

Trigger a webhook whenever someone responds to your survey. You can send the data you received in the callback URL to various other services, and process this data to use however you want.

To configure webhook:

  1. Click the Hub tab.

  2. Click the Triggers section.
    triggers
  3. Click Create in the Webhook section.
    webhook-create
  4. Type a name for your webhook in the Name field.
    New webhook
  5. Type the URL to be notified in the POST URL field.
    1. To configure survey responses in the request body, select the format of your request in the Request Body section:
      1. Form data - to receive the responses as form data
      2. JSON - to receive the responses in JSON format
        1. Type in a key or a name in the Name field.
        2. Click the Value dropdown to map responses and merge tags to a given name. To add direct values to your field, select the Direct value in the Value dropdown, then type in the corresponding value.
          Request body JSON
    2. To configure responses in the Query Parameter and Header sections, click Add Query Param or Add Header Data in the Query Parameter and Header sections. respectively.
      Query Parameter and Header
      1. Type in a key or a name in the Name field.
      2. Click the Value dropdown to map responses and merge tags to a given name. To add direct values to your field, select the Direct value in the Value dropdown, then type in the corresponding value. You can use the Header section for authentication purposes such as API Key, OAuth Token, and Auth Token. And, you can map questions only in the Request Body and Query Parameter sections.
      3. Click +  to add more names and keys.
      4. Click x to remove any data you added.
  6. Click Save.

Sample JSON Data (with name) 

         jsonName={  
         "singleChoice":"Agree",
         "directValue":"Zoho Survey",
         "multiChoice":[  
         "Sunday",
         "Thursday",
         "Saturday"
         ],
         "numeric":"1996",
         "email":"
         
         
         xyz@zoho.com
         ",
         "responseId":"xxxxxxxx155013"
         }

Sample JSON Data (without name) 

         {  
         "singleChoice":"Agree",
         "directValue":"Zoho Survey",
         "multiChoice":[  
         "Sunday",
         "Thursday",
         "Saturday"
         ],
         "numeric":"1996",
         "email":"
         
         
         xyz@zoho.com
         ",
         "responseId":"xxxxxxxx155013"
         }

Note
  1. Currently, we only support POST.
  2. We don't support piped fields in the callback.

To make edits to a webhook you created:

  1. Click the Hub tab. 
  2. Click the Triggers section. 
    triggers
  3. Click Manage in the Webhooks section. 
    webhook-manage
  4. Click webhooks-edit-icon  to make edits to your webhook. 
  5. Click the delete icon to delete the webhook you created. 
  6. Click Delete in the following popup. 
    webhook-delete-confirm
  7. Click  webhooks-sync-status-icon  to check the status of your survey's synchronization with your server or app. 

To check the synchronization status of your webhook:

  1. Click the Hub Tab.
  2. Open the webhook you have created.
  3. Click Sync Status.
  4. To check the status of each response, hover over the response and click  webhooks-sync-status-icon.