close
#Events
Most actions completed by a reader will trigger custom events where you will be
able to assign a listener.
#Available events
#onIdentityAvailable
- Arguments: { event: { user_id: String, context_name: String, context_type: String, context_value: String, segment_slug: String, journey_name: String, widget: String, widget_name: String, trigger: String, triggerType: String, triggerValue: String } }
Triggered after the first tracking request, when the user ID is available.
#onLock
Triggered when the paywall locks the current article.
#onReady
- Arguments: { event: { widget: String, trigger: String, triggerType: String, triggerValue: String } }
Triggered when the paywall is fully loaded and displayed inside the page.
#onPaywallSeen
- Arguments: { event: { widget: String, trigger: String, triggerType: String, triggerValue: String } }
Triggered when the paywall has been seen by the user (when it has entered the browser's viewport).
#onRelease
- Arguments: { event: { widget: String, actionName: String, trigger: String, triggerType: String, triggerValue: String } }
Triggered when the paywall unlocks the current article.
#onRegister
- Arguments: { event: { email: String, newsletter_id: String, pass_id: String }}
Triggered when a user registers to your newsletter using the newsletter widget or the pass widget.
For example, thanks to this event, you'll be able to save a user's email address using tools such as Mailchimp and Sendgrid.
#onSubscribeClick
- Arguments: { event: { widget: String, button: String, originalEvent: MouseEvent, url: String } }
Triggered when a user has clicked a subscribe button/link inside the paywall.
#onLoginClick
- Arguments: { event: { widget: String, button: String, originalEvent: MouseEvent, url: String } }
Triggered when a user has clicked a signin button/link inside the paywall.
#onDiscoveryLinkClick
- Arguments: { event: { widget: String, widget_name: String, button: String, originalEvent: MouseEvent, url: String } }
Triggered when a user has clicked the Link Discovery widget's button inside the paywall.
#onAlternativeClick
- Arguments: { event: { widget: String, button: String, originalEvent: MouseEvent } }
Triggered when a user has clicked the 'No thanks' link in the widget.
Initialy loaded action will be replaced by an alternative one, set up in the dashboard in journey / actions configurations.
#onError
- Arguments: { error: Error, event: { forceRelease: Function } }
Triggered if an unknown/unexpected error has appeared when loading the paywall.
#onOutdatedBrowser
Triggered if the browser is detected to be too old to run Poool's paywall correctly.
#onDataPolicyClick
- Arguments: { event: { widget: String, button: String, originalEvent: MouseEvent, url: String } }
Triggered when a user has clicked a data information button/link inside the paywall.
#onFormSubmit
- Arguments: { event: { name: String, fields: { [fieldKey]: Any, ... }, valid: { [fieldKey]: Boolean, ... } } }
Triggered when a user registers through a form using the Form widget.
For example, thanks to this event, you'll be able to save a user's provided informations using tools such as a DMP.
#onFacebookLoginClick
- Arguments: { event: { widget: String, originalEvent: MouseEvent } }
Triggered when a user clicks on Sign-in with Facebook inside the paywall, enabled using
facebook_login_enabled option.Use this event to place your calls to Facebook's login SDK.
#onGoogleLoginClick
- Arguments: { event: { widget: String, originalEvent: MouseEvent } }
Triggered when a user clicks on Sign-in with Google inside the paywall, enabled using
google_login_enabled option.Use this event to place your calls to Google's login SDK.
#onAnswer
- Arguments: { event: { question_id: String, answer: String } }
Triggered after an answer is chosen in the question widget.
#onConsent
Triggered after a click on the consent button. It is then possible to set up your own consent logic.
You can check our cookie-wall with Didomi guide for more information.
#onCustomButtonClick
Event Button
- Arguments: { event: { name: String, buttonId: String } }
Link Button
- Arguments: { event: { url: String, buttonId: String } }
Triggered after a click on a button component, used in an advanced appearance or a form.
#onExternalLinkClick
- Arguments: { event: { url: String, originalEvent: MouseEvent } }
Triggered after clicking on a link in rich text editor content.