For AI agents: visit https://docs.web2wave.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
web2wave
API Reference
v1.0

Log Inweb2wave
API Reference
Log In
v1.0API Reference

Instructions

  • Getting started
    • web2wave integration
    • web2wave video instructions
  • AI assistants (Cursor, Claude, Codex)
    • MCP server (Cursor, Claude, Codex)
  • Project setup
    • Project settings
    • Additional custom domains
    • Get your API key and set up webhooks
    • Project members
  • Quizzes and paywalls
    • ✨Wavy AI — generate and edit quizzes with AI
    • Quiz & Paywall design requirements
      • Quiz Content Blocks
      • Paywall Content Blocks
    • Plans & Prices
    • Multicurrency and Auto Currency Switching
    • Adding Downsell popup on Paywall
    • 🌎 Auto-Redirect User Guide: Language & Country-Based Redirects
    • Custom logic, Variables, JS SDK, HTML to HEAD
    • Quiz blocks
      • Weight & Height Blocks
      • Payment Terms Block
      • Lottie Animation Block
      • Adding fonts to quizzes & paywalls
      • Show hints on user answers
    • Custom JS
      • JS API – window.w2w object
      • Making Requests from Quiz and Saving Data
      • Callback function before the quiz ends to send the collected answers to an external API
      • Show custom popup with JS
      • Handling Stripe submit errors, Fake payments
      • Sending Purchase event with test prices
      • Custom 'After pay' page with redirect
      • Redirect to Custom URL after quiz, based on answers
      • Adding redirect to external paywall after price selection
      • Upsell Subscription with Cancellation & Refund
      • Link cloaking
      • Authorize User Using Password Generated in Web2Wave
      • Move Next button on top when keyboard is open
      • Adding Countdown Timer to quiz
    • Conditional logic
      • Conditional Logic for Fields and Screens
  • Payment systems
    • Stripe integration & Managing Paywalls
      • Stripe subscription schedules vs first-period discounts
      • Enabling PayPal recurring payment in Stripe
      • Address Billing Address Collection Configuration
      • Handling Failed Payments in Stripe
      • Stripe Payment and Fraud Metrics
    • PayPal integration
    • Paddle integration
    • Primer.io Integration with web2wave
      • Primer.io account setup
      • Google Pay setup
      • Creation and test Primer prices
      • External MIT renewals (own billing)
      • Token migration
    • Billerix Integration
    • Unlimit integration
    • Airwallex Integration via Primer
    • Solidgate integration
      • Solidgate Form Styling
    • FastSpring integration
    • Zotlo integration
    • Chargebacks
      • PayPal integration
    • Custom External Payment System
  • Mobile app integration
    • Common integration questions
    • Embedding Quizzes and Paywalls into Mobile Apps
    • web2wave deferred deeplinks
    • SDK integration
    • Direct integration in mobile app with web2wave API
    • RevenueCat + web2wave integration
    • Adapty + web2wave integration
    • Qonversion + web2wave integration
    • 🏁 Post-Subscription Integration Flow
  • Other integrations
    • Embed Funnels into iFrame
    • LearnWorlds integration to web2wave
    • Webhook Documentation
  • Testing
    • Making Test Purchase
  • Analytics and events
    • Analytics Integration Guide
      • Advanced Analytics and Event Tracking
    • List of Analytics Events
    • Meta Ads Launch & Pixels
      • Custom and multiple pixels (Meta, TikTok, Snapchat)
    • Connect a Meta Ad Account — spend and ROAS in the UTM report
    • Web2Wave JS SDK for external websites
    • Export events & user_properties to external DB
  • A/B testing
    • 🧪Experiments (A/B Testing)
  • Emails
    • 📧Email settings
      • 📧Placeholders in Emails
      • 📧Email Sequences
      • 🪄Generate email sequences with AI
      • 📧External email integrations
      • 💸Email Deliverability Best Practices
  • Subscription management
    • Customer Portal and User Subscription Management
  • FAQ
    • FAQ

web2Wave API

  • ❓ Quiz
    • /quizzes/{quizId}/preview-url
      • Resolve preview URL for a quizget
    • /quizzes/{quizId}/versions
      • Get quiz versions with view URLsget
    • /quizzes/css-variables
      • Get theme CSS variables for a quizget
      • Update theme CSS variables for a quizput
    • /quizzes
      • List quizzesget
      • Create quizpost
    • /quizzes/{quizId}
      • Get quizget
      • Update quizput
      • Delete quizdel
    • /quizzes/{quizId}/restore
      • Restore quizpost
    • /quizzes/screens-version
      • Get quiz screens for specific versionget
    • /quizzes/versions
      • Get quiz versions listget
    • /quizzes/screens
      • Get quiz screensget
      • Update quiz screensput
    • /quizzes/custom-css
      • Retrieve custom CSS for a quizget
      • Add or update custom CSS for a quizpost
  • 💳 Paywall
    • /paywalls/{paywallId}/preview-url
      • Resolve preview URL for a paywallget
    • /paywalls/{paywallId}/versions
      • Get paywall versions with view URLsget
    • /paywalls/css-variables
      • Get theme CSS variables for a paywallget
      • Update theme CSS variables for a paywallput
    • /paywalls
      • List paywallsget
      • Create paywallpost
    • /paywalls/{paywallId}
      • Get paywallget
      • Update paywallput
      • Delete paywalldel
    • /paywalls/screens
      • Get paywall screensget
      • Update paywall screensput
    • /paywalls/versions
      • Get paywall versions listget
    • /paywalls/screens-version
      • Get paywall screens for specific versionget
    • /paywalls/{paywallId}/restore
      • Restore paywallpost
  • 📧 Email Templates
    • Get available email templatesget
    • Send an email templatepost
  • 📊 Reports and Analytics
    • /exports/{id}
      • Get export statusget
    • /exports
      • List recent exportsget
    • /exports/user-visits
      • Start user visits TSV export (async)post
    • /reports/quiz-answers/insights/{token}/status
      • Poll quiz answer insight generation statusget
    • /reports/quiz-answers/insights/{id}
      • Get completed quiz answer insightget
    • /reports/quiz-answers/insights/history
      • List completed quiz answer insightsget
    • /reports/quiz-answers/insights/generate
      • Generate quiz answer AI insight (async)post
    • /reports/quiz-answers/insights/access
      • Quiz answer insights — quota / plan accessget
    • /exports/quiz-answers
      • Start quiz answers CSV export (async)post
    • /analytics/user-visits
      • List user visits (paginated)get
    • /reports/getGraph
      • Retrieve reports data for projectget
    • /reports/quiz-answers
      • Get quiz answers analytics dataget
  • 💰 Subscription
    • /exports/subscriptions
      • Start subscriptions TSV export (async)post
    • /subscription/invoice
      • Create a subscription invoicepost
    • /subscription/cancel
      • Cancel a subscriptionput
    • /subscription/refund
      • Refund a paymentput
    • /subscription/user/charge
      • Charge existing user with saved payment methodpost
    • /subscriptions/list
      • List subscriptions with filtersget
    • /subscription/invoices
      • Retrieve a list of all client invoicesget
    • /subscription/pause
      • Pause a subscriptionput
    • /subscription/resume
      • Resume a paused subscriptionput
    • /subscription/schedule-cancellation
      • Schedule subscription cancellationput
    • Create a subscriptionpost
    • Update a subscriptionput
  • 👤 User
    • /user/send_auth_link
      • Send authentication link to userpost
    • /user/events
      • Get user eventsget
      • Send a new user eventpost
    • /user/subscriptions
      • Get user subscriptionsget
    • /user/user_visits
      • Get user visits listget
    • /user/user_visit
      • Get user visit informationget
    • /user/properties
      • Get user propertiesget
      • Update user propertiespost
  • 💲 Price
    • /price
      • Retrieve prices based on optional filtersget
  • 🧪 Experiments
    • /exports/experiments/{id}/users
      • Start experiment user IDs CSV export (async)post
    • /exports/experiments/{id}
      • Start A/B test results CSV export (async)post
    • /experiments/{id}/snapshots
      • Get experiment metric snapshotsget
    • /experiments
      • List experimentsget
    • /experiments/{id}
      • Get experiment detailsget
      • Update experiment statuspatch
    • /experiments/{id}/users
      • Get experiment usersget
    • Create experimentpost
  • /project-files/upload
    • Upload a project filepost
  • /user/identify
    • Identify user by fingerprintget
    • Identify user by fingerprintpost
  • Translations
    • List supported translation languagesget
    • Get translation provider connections for the projectget
    • Update translation provider connectionsput
    • List quiz translations (sibling rows)get
    • Launch AI or Crowdin translation for a quizpost
    • Poll translation status for a quizget
    • List paywall translationsget
    • Launch AI or Crowdin translation for a paywallpost
    • Poll translation status for a paywallget
Powered by 

Token migration

https://support.stripe.com/contact/email?topic=migrations



Updated 4 months ago


External MIT renewals (own billing)
Billerix Integration
Did this page help you?

Updated 4 months ago


External MIT renewals (own billing)
Billerix Integration
Did this page help you?