Developers
Webhooks push signed quiz events to any URL. The API lets your tools look up answers, recommendations and events with a key. Zapier connects 8,000+ apps without code. Every answer arrives as its own field, keyed by question ID.
Webhooks, the API and Zapier are available on Starter and above.
curl https://api.shopper-quiz.com/v1/search/responses \
-G --data-urlencode "[email protected]" \
-H "Authorization: Bearer sq_key_…"Three ways in
Events
The same events and fields reach webhooks, Zapier and API subscriptions. Each fires once per quiz attempt. Cart events carry line items with the chosen option and subscription plan; orders carry their real line items and say whether the shopper bought a recommended product.
lead.createdA shopper enters their email on a quizquiz.completedA shopper reaches the results page — with every answer and the recommended productscart.addedA shopper adds recommended products to their cart from the resultscheckout.startedA shopper starts checkout from the resultsorder.createdA shopper who took the quiz pays for an order linked to itAPI
Base URL https://api.shopper-quiz.com, with Authorization: Bearer sq_key_… on every request. Create keys on the Developers page in your dashboard.
GET /v1/meThe connected storeGET /v1/quizzesUp to 200 quizzes, newest firstGET /v1/search/quizzes?name=Up to 5 quizzes whose name contains the textGET /v1/search/responsesUp to 5 responses by email or response ID, with every answer and recommendationGET /v1/responsesThe 50 most recent responses, ready for dropdownsGET /v1/quizzes/{quiz_id}/answer-fieldsThe answer fields for a quiz, with readable labelsGET /v1/events/{event}/samplesUp to 3 recent real events of a typePOST /v1/hooks · DELETE /v1/hooks/{id}Subscribe a URL to signed events, or unsubscribe itSecurity
Failed deliveries retry after 1 minute, 5 minutes, 30 minutes, 2 hours, 6 hours and 12 hours — and every one is in Recent deliveries for 30 days.
Signed requests
HMAC-SHA256 over the timestamp and raw body in X-ShopperQuiz-Signature. Reject anything older than 5 minutes.
Secrets stay secret
Each endpoint has its own signing secret, kept server-side and shown once. Rotate it any time.
HTTPS, public hosts only
Endpoints must use HTTPS. Private, local and cloud-metadata addresses are refused.
Idempotent by design
Every event has an id that stays the same on retries. Respond 2xx within 10 seconds; 410 Gone turns an endpoint off.
Docs for AI tools
The whole ShopperQuiz documentation is published as plain text for AI assistants and coding tools — an index at llms.txt and every page in one file at llms-full.txt.
Create your store’s account free, then upgrade to Starter to create API keys and endpoints.
Get started for freeNo credit card required · Free plan available