For AI agents: the docs index is at https://docs.web2wave.com/llms.txt. 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
    • web2wave deferred deeplinks
    • SDK integration
    • Direct integration in mobile app with web2wave API
    • RevenueCat + web2wave integration
    • Adapty + web2wave integration
    • Qonversion + web2wave integration
    • Apphud + web2wave integration
    • Superwall + web2wave integration
    • 🏁 Post-Subscription Integration Flow
    • Embedding Quizzes and Paywalls into Mobile Apps
  • 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
    • LTV Predictions
    • 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
  • 🎧Support Desk
    • ⚙️Set up Support Desk
    • 📥Working in the inbox
    • 🤖Auto replies, follow-ups and auto close
    • 📊Support analytics
    • 🔌Support Desk API and MCP
  • Subscription management
    • Customer Portal and User Subscription Management
  • FAQ
    • FAQ

web2Wave API

  • ❓Quiz
    • /quizzes/{quizId}/copy
      • Copy quizpost
    • /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}/copy
      • Copy paywallpost
    • /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
  • 📬Email Sequences
    • /email-sequences/translations/{id}
      • Delete a translation (not the source email)del
    • /email-sequences/quizzes
      • Quizzes usable in `quiz_ids`get
    • /email-sequences/prices
      • Prices usable in `subscription_price_ids`get
    • /email-sequences/{id}/translations
      • Add a language version of a steppost
    • /email-sequences/{id}/send-test
      • Send a test email of a steppost
    • /email-sequences/{id}/restore
      • Restore archived email sequence step (and its translations)post
    • /email-sequences/{id}/promote-to-source
      • Make a translation the default-language (source) emailpost
    • /email-sequences/{id}
      • Get email sequence step with translationsget
      • Update email sequence stepput
      • Archive email sequence step (and all its translations)del
    • /email-sequences/ai-generate/{token}/status
      • Status of an AI email generation jobget
    • /email-sequences/ai-generate/style-packs
      • Visual style packs for AI email generationget
    • /email-sequences/ai-generate/sequence-templates
      • Ready-made sequence templates (with steps) for AI email generationget
    • /email-sequences/ai-generate/quizzes
      • Quizzes selectable as CTA / style source / audienceget
    • /email-sequences/ai-generate/paywalls
      • Paywalls selectable as CTA / style source / audienceget
    • /email-sequences/ai-generate/example-templates
      • Example email templates used as AI referenceget
    • /email-sequences/ai-generate
      • Generate email sequence steps with AI (async)post
    • /email-sequences
      • List email sequence stepsget
      • Create email sequence steppost
  • 📊Reports and Analytics
    • /reports/overview
      • Get Analytics Overviewget
    • /reports/events
      • Funnel event countsget
    • /reports/chart-builder/catalog
      • Get Chart builder catalogget
    • /reports/chart-builder
      • Get Chart builder dataget
    • /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
    • /plan
      • List plansget
    • /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
  • 📱Mobile Deeplinking
    • Identify user by fingerprintget
    • Identify user by fingerprintpost
  • 📁File Upload
    • Upload a project filepost
  • 🌐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
  • 📹Creatives
    • Trends tab category summary (top brands, domains, creatives)get
    • Paginated brands / pages / domains for a Trends categoryget
    • Brands whose paid ad activity moved most over the periodget
    • Landing pages observed for a domain in Trendsget
    • Filter catalogs for the Inspiration Feedget
    • Brands in the paid-ads Trends catalogget
    • Brand ad-activity analyticsget
    • Similar brandsget
    • Inspiration Feed of winning paid adsget
    • Single inspiration ad detailget
    • Prepaid creatives wallet (Trends API access requires a positive balance)get
    • List the project's saved target audiencesget
    • Create (or reuse by name) a target audiencepost
    • Recommended creative scenarios (angles / video structures) for an audienceget
    • Estimate the wallet cost of a generation before launching it (read-only)get
    • Launch a static image or video creative generation from a briefpost
    • List the project's generated creatives (newest first)get
    • Generated creative detail and generation progress (poll this)get
    • Like / dislike a generated creative (null clears the vote)post
  • /project-files/upload-font
    • Upload a font filepost
  • /projects
    • List projects accessible with the current API keyget
  • 👨‍💻Support Desk
    • /support/analytics
      • Support Desk analyticsget
    • /support/billing
      • Support Desk subscription and trialget
    • /support/billing/checkout
      • Get a Stripe Checkout link for the subscriptionpost
    • /support/billing/portal
      • Get a Stripe customer portal linkpost
    • /support/conversations
      • List Support Desk conversationsget
    • /support/conversations/{id}
      • Get a conversation with its messages and notesget
    • /support/conversations/{id}/ai-draft
      • Draft a reply with AIpost
    • /support/conversations/{id}/assignee
      • Assign a conversationput
    • /support/conversations/{id}/customer
      • The customer behind a conversationget
    • /support/conversations/{id}/messages
      • New messages and notes of a conversationget
    • /support/conversations/{id}/mute
      • Mute the sender of a conversationpost
    • /support/conversations/{id}/notes
      • Add an internal notepost
    • /support/conversations/{id}/reply
      • Reply to the customerpost
    • /support/conversations/{id}/request-type
      • Set the request type of a conversationput
    • /support/conversations/{id}/status
      • Change the status of a conversationput
    • /support/members
      • Team members who can take conversationsget
    • /support/settings
      • Support Desk settingsget
      • Change Support Desk settingspatch
    • /support/settings/check-dns
      • Verify the custom domainpost
    • /support/templates
      • List reply templatesget
      • Create a reply templatepost
    • /support/templates/{id}
      • Update a reply templateput
      • Delete a reply templatedel
    • /support/templates/starters
      • Create the four starter templatespost
Powered by 

Token migration

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



Updated 6 months ago


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

Updated 6 months ago


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