Quiz Responses Webhook

The Quiz Responses Webhook sends the answers submitted by users when they complete a quiz on your sales funnels. This webhook helps you analyze user behavior, personalize funnels, score quizzes, or trigger post-quiz flows.

By default, you will only receive quiz responses from users who completed a purchase. If you would like to also receive quiz responses from non-paying users, you can enable this option in the Webhook settings page.

When This Is Triggered

A callback is sent whenever a user completed registration after completed a quiz.

Context	Description
Self-Service Sales Sites	If the “send unpaid quiz responses” option is enabled Sent immediately after the user completes the registration step. If the option is disabled (default) Sent after the user completes the payment

Example Payload

{
  "client": {
    "subscriberId": "[email protected]",
    "subscriberName": "name surname",
    "email": "[email protected]",
    "uuid": "29de05a7-5a6f-4107-b15a-1c8abdefad95",
    "isPayer": 1,
    "platform": "Mac OS",
    "country": "US",
    "language": "en",
    "utmSource": null,
    "utmMedium": null,
    "utmCampaign": null,
    "utmContent": null,
    "utmTerm": null,
    "paymentModule": "generate",
    "flowId": 600,
    "siteId": 38,
    "ip": "192.168.1.1"
  },
  "questions": {
    "5706": {
      "questionId": "question1",
      "questionName": "Question 1",
      "question": "Question Title",
      "settings": "{\"backgroundColor\":\"\",\"forceDesktopBG\":true,\"backgroundImage\":{\"desktop\":\"\",\"tablet\":\"\",\"mobile\":\"\"}}",
      "sequence": 1,
      "displayedSequence": 1,
      "required": 1,
      "isMultiple": 0,
      "typeId": 0,
      "typeName": "SingleSelection",
      "isLogic": false
    }
  },
  "answers": {
    "5706": {
      "answerDate": "2024-01-10 10:47:25",
      "answer": null,
      "answerOptions": [
        {
          "optionId": 8215,
          "name": "Option örnek 1",
          "type": "image",
          "image": ""
        }
      ]
    }
  }
}

Field Reference

Client Fields

Field	Description
client.subscriberId	Email or phone number used during quiz or purchase
client.subscriberName	User’s full name
client.email	User email (if collected)
client.uuid	Unique user/session ID
client.isPayer	1 = user completed purchase, 0 = did not purchase
client.platform	OS or device platform
client.country	User’s country
client.language	User’s language
client.utmSource / Medium / Campaign / Term / Content	UTM parameters if present
client.paymentModule	generate for Self-Service, store for Marketplace
client.flowId	Identifier of the flow where quiz was taken
client.siteId	Sales site ID
client.ip	User IP address

Question Fields

Field	Description
questionId	Unique question identifier
questionName	Friendly name of the question
question	Question title/text
settings	Design configuration of the question
sequence	Actual question order
displayedSequence	Order shown to user (after logic/skips)
required	1 if required, 0 if optional
isMultiple	1 if multiple answers allowed
typeId	Numeric question type
typeName	Example: SingleSelection, ImageBox, Location
isLogic	Whether conditional logic is applied

Question types:

• 0: Single selection

• 2: Image chooser

• 4: Info page

• 5: Date

• 6: Time

• 7: Text input

• 8: Location

• 9: Ending page

• 10: File upload

Answer Fields

Field	Description
answers.answerDate	When the answer was submitted
answers.answer	Raw answer value (text, date, time, location object, file URL, etc.)
answers.answerOptions.optionId	Option ID for selectable questions
answers.answerOptions.name	Selected option text
answers.answerOptions.type	text or image
answers.answerOptions.image	Selected option image (if applicable)

NOTE: For multilingual funnels, answers are returned in the language used by the user.