Webhooks are automated messages sent from Zonka Feedback when a new survey response is added.

Webhooks are always sent as an HTTP POST request to the webhook URLs you’ve configured via your Webhooks integration. The details of the activity that triggered the webhook are sent as the body of the HTTP request in JSON format.

Event Types

We support the following event type:

Type	Description
response.added	This occurs when a new response is received for a survey. The event JSON shall include all details of the response including respondent details, scores and survey questions and their responses provided by the respondent.

Example Response

{
    "id": "609d545970b5b6000801567c",
    "surveyId": "60659f8aecfaff0008e447e9",
    "surveyName": "Customer Experience Survey",
    "surveyLanguage": "en_US",
    "receivedDate": "2021-05-13T22:01:22.000Z",
    "respondentId": "",
    "respondentDetails": {
        "name": "Robert David",
        "emailAddress": "robertdavid@zonkafeedback.com"
    },
    "locationId": "",
    "locationName": "",
    "takenByUserId": "",
    "takenByUserName": "",
    "ratedUserId": "",
    "ratedUserName": "",
    "channel": "Online",
    "channelDetails": "",
    "integrationDetails": "",
    "NPS": 8,
    "responseURL": "",
    "surveyResponseData": [
        {
            "questionId": "60659fc5ecfaff0008e448ca",
            "questionLabel": "Email",
            "answer": "robertdavid@zonkafeedback.com"
        },
        {
            "questionId": "60659fd0b1e71d0007ffaff2",
            "questionLabel": "Full Name",
            "answer": "Robert David"
        },
        {
            "questionId": "60659fd8ecfaff0008e448e3",
            "questionLabel": "Comments",
            "answer": "The service was good."
        },
        {
            "questionId": "60659fefb1e71d0007ffb027",
            "questionLabel": "How likely are you to recommend us to a friend or colleague?",
            "answer": "8"
        }
    ]
}

Getting Started with Webhooks

Here's how you can get started with using Webhooks.

Navigate to Settings > Developers > Webhook
Click on 'Add Webhook'
Enter the following details:
- Name: Name of the webhook
- Event: Response Received
  - When a new survey response is received for the specified survey
- Target URL:
  1. URL where the JSON for the survey response is to be sent
  2. This can be a Target URL in any CRM, HRMS or any other 3rd party system that accepts webhook event data
- Survey: Specify the survey whose response will trigger this webhook
- Additional Parameters: You can specify any additional key:value pairs as comma-separated which can be added to the response JSON that will be sent.
Save the Webhook

Webhook Logs

When webhooks are triggered they a log is saved for successful or any unsuccessful requests. To view the Webhook Logs, follow these steps.

Go to Settings > Developers > Webhook
Click on 'View Logs'

For any further questions about Webhooks, please contact us at hello@zonkafeedback.com.