Webhook

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. Process this data to use however you want.

How do I...

  1. Configure webhook?
  2. Make edits to a webhook I created?

How do I configure webhook?

  1. Select the Hub tab.

    Hub

  2. Select the Triggers section.

    triggers

  3. Click Create in the Webhooks 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.
  6. To configure survey responses in the request body:
    • Select the format of your request in the Request Body section:
      • Form data - to receive the responses as form data
      • JSON - to receive the responses in JSON format
    • Type in a key or a name in the Name field.
    • Click the Value dropdown to map responses and merge tags to a given name. To add direct values to your field, select Direct value in the Value dropdown, then type in the corresponding value.

      Request body JSON

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

    • Type in a key or a name in the Name field.
    • Click the Value dropdown to map responses and merge tags to a given name. To add direct values to your field, select 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.
    • Click + to add more names and keys.
    • Click x to remove any data you added.
  8. 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"
  }

 

How do I make edits to a webhook I created?

  1. Select the Hub tab.

    Hub

  2. Select 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 webhooks-delete-icon to delete the webhook you created.
    1. Click Delete in the following popup.

      webhook-delete-confirm

  6. Click webhooks-sync-status-icon to check the status of your survey's synchronization with your server or app.

 

Limitations

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

    • Related Articles

    • How do I configure 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. Process this data to use however you want. To configure webhook: Click the  Hub  tab. Click ...
    • How do I create a webhook?

      1. From the Navigation toolbar, choose Settings. 2. Select Webhooks under Developer Space. 3. Click Create and enter the following details during webhook creation:   A Name for your webhook The URL of the webhook to be configured from the application ...
    • How do I delete a webhook?

      From the Navigation toolbar, choose Settings. Select Webhooks under Developer Space. Locate the webhook you want to delete and select it. Click the Delete icon in the top-right corner of the details page. ​
    • How do I make edits to a webhook I created?

      To make edits to a webhook I created: Click the  Hub  tab. Click the  Triggers  section. Click  Manage  in the  Webhooks  section. Click    to make edits to your webhook. Click the delete icon to delete the webhook you created. Click Delete  in the ...
    • How do I check the synchronization status of my webhook with the service or app?

      To check the synchronization status of your webhook: Click the Hub Tab. Open the webhook you have created. Click Sync Status. To check the status for each response, hover over the response and click  .