API Reference

Below is the typical events that are sent to analytics systems like Amplitude or Posthog from web2wave


Main events

Event nameDescriptionProperties
Step %screen_index% %screen_name%User visited #screen_name page with index screen_index{value: '0', section_id: 'welcome'}
Answer %screen_name%User answered question on #screen_name page{value: 'User answer'}
Quiz finishedQuiz is finished - sent on the last quiz page(at the end), can be not delivered.
CompleteRegistration
sign_up - in GA
User visited Paywall page
Paywall clickUser clicked on paywall
Paywall scroll 1User scrolled on paywall
Paywall scroll 50User scrolled 50% of paywall
InitiateCheckout
begin_checkout - in GA

3 different events:

  • User opened Stripe or Paddle form in popup
  • User clicked in Stripe form embedded in page
  • User clicked on 'Subscribe with Apple Pay button'
Subscribe
conversion - in GA
User subscribed or made trial{ currency: 'USD', value: '19.99' }
Purchase
purchase - in GA
User subscribed or made trial{ currency: 'USD', value: '19.99' }
CompletePaymentUser subscribed or made trial{ currency: 'USD', value: '19.99' }

Technical events

Event nameDescriptionProperties
PageViewFB event on page view
Page pageshow
Page freeze
Page resume
Page onvisibilitychangeBrowser page close
Page beforeunload
Page unload
Page pagehide
Page pageshow

Stripe events

Works with

Event NameDescriptionProperties
Stripe changeUser selected payment method in form{ "elementType": "payment", "collapsed": false, "empty": true, "complete": false, "value": "card" }
Stripe readyStripe form is loaded
Stripe focusUser clicked in Stripe form
Stripe blurUser clicked outside Stripe form
Stripe escapeUser pressed "Escape" in Stripe form
Stripe loaderrorError while loading Stripe form
Stripe loaderstart
Stripe submit error{ "code": "card_declined", "type": "card_error", "charge": "ch_XXXX", "doc_url": "https://stripe.com/docs/error-codes/card-declined", "message": "Your card has been declined.", "shouldRetry": "false", "decline_code": "try_again_later", "payment_intent": {XXX}, "payment_method": {XXX}, "request_log_url": "https://dashboard.stripe.com/logs/req_XXXXX" }
Stripe submitStripe Payment form submitted OR Stripe Express Button clicked{value: 'card'} **OR** {"value": "apple_pay", "resolve": null, "elementType": "expressCheckout", "expressPaymentType": "apple_pay"}
Stripe Express readyStripe Express Button loaded{"elementType": "expressCheckout", "availablePaymentMethods": {"link": "false", "paypal": "false", "applePay": "true", "amazonPay": "false", "googlePay": "false"}}
Stripe Express No buttons
Stripe Express loaderror
Stripe Express loaderstart
Stripe Express click +
Stripe submit +
InitiateCheckout
Stripe submit + InitiateCheckout
Stripe Express confirmPayment completed with Stripe Express button{ "elementType": "expressCheckout", "paymentFailed": null, "billingDetails": { "name": "John Doe", "address": { "city": "Arden", "line1": "49 Owenby Dr", "line2": null, "state": "NC", "country": "US", "postal_code": "28704" } }, "expressPaymentType": "apple_pay" }
Stripe Express cancel
Stripe Express Has buttons
Stripe Express No buttons

PayPal events

Event NameDescriptionProperties
PayPal createSubscription +
InitiateCheckout
User clicked on PayPal button, PayPal payment initiated{ "price_id": "price_1P2avpAg4LBBeMXXXXXX" }
PayPal onApprove +
Subscribe
{ "orderID": "3S629229XXXXXXX", "paymentSource": "paypal", "subscriptionID": "I-74NVU7XXXXX", "facilitatorAccessToken": "xxxx...xxxxx" }
PayPal onError
PayPal onCancel{ "orderID": "2G963992NV477XXX" }

Paddle events

Event nameDescriptionProperties
Paddle checkout.loaded
Paddle checkout.payment.selected
Paddle checkout.payment.initiated
Paddle checkout.customer.created
Paddle checkout.completed
Paddle checkout.ping.size
Paddle checkout.warning