Paywall

Richie Paywall navigation callbacks

Moving between views inside paywall experience

Paywall can communicate with the native app in two different ways: JavaScript API and by loading special URLs we call navigation callbacks. Each navigation callback uses our custom URL scheme maggio-callback://. E.g. full URL for the sign-in callback is maggio-callback:///sign-in.

/sign-in

Loads the sign-in.html page, taking into account the current state and context of the paywall. This callback must be used instead of navigating directly to the sign-in.html page. This allows the app to have control whether to display the page in a new, full screen paywall view (in e.g. article paywall overlay case), or in the current, full screen paywall view (if one is already open).

/skip-screen

Closes the current paywall page. This results in the same action as if the user would have tapped on the close button on the current paywall page.

/return-to-frontpage

Closes the current paywall page and returns to the front page of the app. This is useful when paywall wants to force user to return to the section front from a paywall view which was displayed on top of the article view.

/ask-permission

In apps with metered access, this callback checks whether the user has unused metered accesses for the current article. If there are unused metered accesses, one of them is consumed for the current article, and paymeter overlay is dismissed.

This callback is supported only from the paymeter overlay view, which is displayed on top of an article view.

/iap-subscribe

Loads the paywall.html page, taking into account the current state and context of the paywall. This callback must be used instead of navigating directly to the paywall.html page. This allows the app to have control whether to display the in a new, full screen paywall view (in e.g. article paywall overlay case), or in the current, full screen paywall view (if one is already open).

Previous
JavaScript API