Quiz Responses
Learn how to get quiz responses to your server via webhooks
This webhook service provides you with information about the answers to the questions in the quizs when you use the quiz feature on your sales sites. When you enable this webhook service, you will only receive responses from users who have completed a purchase. However, if you would like to receive answers from users who have not completed a purchase, you need to check the preference box in the webhook field.
Setup the Endpoint URL
Webhook events are sent to your server via HTTP POST
. You configure the endpoint URL through Developer Tools / Webhooks menu under your project.
By default, webhook notifications include only the quiz responses from users who have paid. You can configure to also receive quiz responses from users who have not paid.
After completion, first event is sent within 5 minutes. Your server should return a 200 status code. Any other status code will be considered a failure by our backend. In case of failure, Zotlo will retry later (up to 10 times) with 1-hour intervals. After 10 retries, we will stop sending notifications.
Events Format
Webhook events are serialized in JSON. The body of a POST
request to your server will contain the serialized event.
Fields
Field | Description |
---|---|
client.subscriberId | Subscriber ID which can be email or phone number. |
client.subscriberName | Name and surname of the registered user. |
client.email | Subscriber email. |
client.uuid | Unique user ID. |
client.isPayer | Value is sent as |
client.platform | User device OS. |
client.country | User country. |
client.language | User language. |
client.utmSource | UTM source parameter. |
client.utmCampaign | UTM campaign parameter. |
client.utmContent | UTM content parameter. |
client.utmTerm | UTM term parameter. |
questions | Question details. |
questions.questionId | Question ID |
questions.questionName | Question name. |
questions.question | Quetion title. |
questions.settings | Question design settings. |
questions.sequence | Question order. |
questions.displayedSequence | Question order seen by the user. |
questions.required | Value is |
questions.isMultiple | Value is |
questions.typeId | Question type, possible values:
|
questions.typeName | Question type name. |
questions.isLogic |
|
answers | Contains answer details. |
answers.answerDate | Answer date. |
answers.answer | Answers to the question. |
answers.answerOptions.optionId | Option ID if question is a multi select type. |
answers.answerOptions.name | Option text if Option ID if question is a multi select type. |
answers.answerOptions.type | |
answers.answerOptions.image |
Last updated