How to Send Leads to Webhooks¶
Integrating thw quiz with webhooks allows you to automatically send all quiz data, including responses, recommended products, and participant information, to your specified endpoints.
This guide will walk you through the steps to link your quiz to custom webhooks, enabling seamless data integration for further processing or analysis.
Before you start, ensure you have:
- A Shop quiz (product recommendation quiz) from which you want to send data.
- A valid webhook URL to receive the data.
Link Quiz to Webhooks¶
To initiate the integration:
- Navigate to the Connect section of your quiz.
- Scroll down to the "Webhooks" option and click on
Connectto expand the input field. - In the newly opened line, paste your webhook URL. The system will automatically save the URL once entered.
- After adding the webhook URL, click on the three dots
…next to the webhook entry and selectTest webhookfrom the dropdown menu. -
A successful connection test will result in a message, the appearance of which may vary based on your webhook's configuration.
-
If an error occurs during the test, perform the following checks:
- Verify that your quiz has received responses by checking the
Metrics -> Responsessection. If no responses are present, generate test responses by selectingPreviewingit. - Confirm the correctness of the webhook URL and its active status.
- Verify that your quiz has received responses by checking the
-
Configuring HTTP Headers (Optional): For enhanced security or specific data handling requirements, you can add HTTP headers to your webhook.
- After a successful connection test, select
+add new headerto open header fields. - Enter the data for your HTTP headers, which will be sent along with the quiz data in a POST request.
- After a successful connection test, select
-
Activating Your Webhook: With testing and configuration complete, activate your webhook. Use the toggle button next to your webhook entry to activate it. This switch allows for easy deactivation should the need arise.
Upon activation, all quiz data will be transmitted to your webhook URL via a POST request (including headers).
If you want to add another webhook to the quiz, click +add new webhook, paste a new URL and follow the same steps to test and activate it.
What Data is Sent to Webhook?¶
Webhooks will receive all data from the quiz, incluiding:
- Participant's name, email, and phone number.
- Details of recommended products.
- Quiz questions and their respective answers.
- Tags, quiz permalink, and the permalink to individual quiz responses.
This data is packaged and sent as a JSON payload in a POST request, ensuring a structured and accessible format for automated processing or integration into other systems.
Below is a sample JSON payload sent on the POST request for a skincare quiz:
{
"quiz_name": "Skincare Quiz (Basic Routine)",
"quiz_id": "dbqHqN",
"response_id": "NLTqvGqg",
"first_name": "Paulina",
"full_name": "Paulina",
"email": "paulina@revenuehunt.fake",
"emails": [
"paulina@revenuehunt.fake"
],
"products": [
{
"name": "The Ordinary \"Buffet\" + Copper Peptides 1%",
"score": 2.102760090909091,
"url": "https://skincarequiz.myshopify.com/products/the-ordinary-buffet-copper-peptides-1",
"price": "27.0",
"image_url": "https://cdn.shopify.com/s/files/1/0273/8113/7492/products/oily-serum.jpg?v=1568583098",
"position": 0,
"sku": "RHSK-016",
"id": 4095078301780,
"variant_id": 30099568885844
},
{
"name": "Organix Facial Moisturizer",
"score": 2.1020920909090908,
"url": "https://skincarequiz.myshopify.com/products/organix-facial-moisturizer",
"price": "36.0",
"image_url": "https://cdn.shopify.com/s/files/1/0273/8113/7492/products/age-moisturizer.jpg?v=1568621334",
"position": 1,
"sku": "RHSK-012",
"id": 4095721668692,
"variant_id": 30104418451540
},
{
"name": "All Natural Face Cleanser",
"score": 2.101927090909091,
"url": "https://skincarequiz.myshopify.com/products/all-natural-face-cleanser",
"price": "32.0",
"image_url": "https://cdn.shopify.com/s/files/1/0273/8113/7492/products/cleanser.jpg?v=1568621187",
"position": 2,
"sku": "RHSK-001",
"id": 4095717834836,
"variant_id": 30104403476564
},
{
"name": "Fresh Rose Deep Hydration Toner",
"score": 1.1010830909090907,
"url": "https://skincarequiz.myshopify.com/products/fresh-rose-deep-hydration-toner",
"price": "48.0",
"image_url": "https://cdn.shopify.com/s/files/1/0273/8113/7492/products/fresh-rose-hydration.jpg?v=1568581379",
"position": 3,
"sku": "RHSK-006",
"id": 4095053168724,
"variant_id": 30099364773972
}
],
"blocks": [
{
"id": "Q2wTvD",
"type": "HeadingBlock",
"position": 0,
"content": "{{slide:ZMiXjj}}, here's what your skin wants!"
},
{
"id": "Qm0T1V",
"type": "ContentBlock",
"position": 1,
"content": "Applying your skin care products in the proper order ensures that your skin receives the full benefits of each product.↵↵Enter this coupon code at checkout to get a 10% discount:↵**QUIZ123**↵↵"
},
{
"id": "Qp7T9x",
"type": "SlotsBlock",
"position": 2,
"slots": [
{
"id": "NXGuwK",
"title": "Step 1: Cleanser",
"position": 0,
"products": [
{
"name": "All Natural Face Cleanser",
"id": 4095717834836,
"url": "https://skincarequiz.myshopify.com/products/all-natural-face-cleanser",
"price": "32.0",
"image_url": "https://cdn.shopify.com/s/files/1/0273/8113/7492/products/cleanser.jpg?v=1568621187",
"sku": "RHSK-001",
"variant_id": 30104403476564,
"position": 0,
"score": 2.101927090909091
}
]
},
{
"id": "RV6u0R",
"title": "Step 2: Toner",
"position": 1,
"products": [
{
"name": "Fresh Rose Deep Hydration Toner",
"id": 4095053168724,
"url": "https://skincarequiz.myshopify.com/products/fresh-rose-deep-hydration-toner",
"price": "48.0",
"image_url": "https://cdn.shopify.com/s/files/1/0273/8113/7492/products/fresh-rose-hydration.jpg?v=1568581379",
"sku": "RHSK-006",
"variant_id": 30099364773972,
"position": 0,
"score": 1.1010830909090907
}
]
},
{
"id": "K6MuvR",
"title": "Step 3: Serum",
"position": 2,
"products": [
{
"name": "The Ordinary \"Buffet\" + Copper Peptides 1%",
"id": 4095078301780,
"url": "https://skincarequiz.myshopify.com/products/the-ordinary-buffet-copper-peptides-1",
"price": "27.0",
"image_url": "https://cdn.shopify.com/s/files/1/0273/8113/7492/products/oily-serum.jpg?v=1568583098",
"sku": "RHSK-016",
"variant_id": 30099568885844,
"position": 0,
"score": 2.102760090909091
}
]
},
{
"id": "9OJulN",
"title": "Step 4: Moisturizer",
"position": 3,
"products": [
{
"name": "Organix Facial Moisturizer",
"id": 4095721668692,
"url": "https://skincarequiz.myshopify.com/products/organix-facial-moisturizer",
"price": "36.0",
"image_url": "https://cdn.shopify.com/s/files/1/0273/8113/7492/products/age-moisturizer.jpg?v=1568621334",
"sku": "RHSK-012",
"variant_id": 30104418451540,
"position": 0,
"score": 2.1020920909090908
}
]
}
]
}
],
"answers": [
{
"question_title": "Leave us your email to receive an exclusive 10% discount on your next purchase:",
"question_id": "KGQi5e",
"values": [
"paulina@revenuehunt.fake"
]
},
{
"question_title": "Is your skin sensitive to any of the following ingredients?",
"question_id": "yYqiz5",
"choice_label": "Witch Hazel"
},
{
"question_title": "Which of the following best describes the climate in which you live?",
"question_id": "pa2i8L",
"choice_label": "Desert or High Altitude"
},
{
"question_title": "What is your main skin concern?",
"question_id": "ydDimb",
"choice_label": "Fine lines and wrinkles"
},
{
"question_title": "How does your skin feel on an average day?",
"question_id": "K72iWW",
"choice_label": "Dry and tight all over"
},
{
"question_title": "Pleased to meet you {{slide:ZMiXjj}}, what is your age?",
"question_id": "p5Vi02",
"choice_label": "40's"
},
{
"question_title": "Before we get started... what's your name?",
"question_id": "ZMiXjj",
"values": [
"Paulina"
]
}
],
"tags": [
"sensitive_witch_hazel",
"desert_area",
"fine_lines",
"dry_skin",
"40s"
],
"permalink": "https://skincarequiz.myshopify.com/#results-dbqHqN-NLTqvGqg",
"permalink_hash": "#results-dbqHqN-NLTqvGqg",
"created_at": "2022-07-15T13:18:30Z"
}
Troubleshooting Broken JSON Responses in Webhooks¶
If you're experiencing issues where a webhook response contains broken or invalid JSON, here's a step-by-step guide to help you identify and resolve the problem.
Common Scenario: When using webhooks to send quiz data, the response may appear broken or improperly formatted. For example, you may see incomplete or misaligned JSON objects in your logs. This could result from an unexpected content type or header configuration.
Steps to Resolve the Issue
-
Check the Content-Type Header:
-
Inspect the content-type of the webhook payload.
-
Log the headers to verify the content type being sent. If it is unexpected, this could cause the payload to be interpreted incorrectly.
Example:
-
-
Verify the Header Configuration:
-
Compare the headers in your app's webhook configuration with the expected content type in the documentation.
-
If the content type differs, it may need to be overridden manually in your webhook configuration.
Example:
-
-
Override the Content-Type in the App Config:
-
Update the webhook configuration to explicitly set the correct
Content-Typeheader. -
For example, change the content type to
application/json.
-
-
Test the Webhook Connection:
After updating the configuration, test the connection:
-
Disconnect the webhook.
-
Reconnect the webhook and test it.
-
Ensure the webhook is properly activated.
-
-
Validate the JSON:
-
Use a tool like JSONLint to validate the JSON payload.
-
Paste the payload into the tool to ensure it conforms to proper JSON formatting.
-
-
Publish Your Changes:
-
Ensure you click the
Publishbutton in the top-right corner after making updates to the webhook configuration. -
Missing this step may result in the changes not being applied.
-
-
Retest the Integration:
-
Complete a full end-to-end test of the quiz, submitting valid test data (e.g., email address, phone number, etc.).
-
Confirm that the webhook receives the corrected JSON payload.
-
By following this article, you can set up your data flow with Webhooks.