List of Action URLs
purple://app/menu/close
This action URL opens the native app menu. If the app menu is already open, it stays open.
purple://app/menu/open
This action URL closes the native app menu. If the app menu is already closed, it stays closed.
purple://app/menu/toggle
This Action URL opens the native app menu when it is closed. And when it's open, it is closed.
purple://app/feedback/mail/open
This action URL opens a pre-filled email for feedback as configured within the dynamic resources.
purple://app/open/external/url/<URL_ENCODED_URL>
This action URL opens the given URL by handing it over to the underlying OS.
This action URL does not work below Android 13.
purple://app/push/register
This action URL triggers the push registration for the application. This will display a system dialog asking for permission to receive push notifications.
Note that all content related action URLs starting with purple://content/ only work within the opened issue.
purple://kiosk/issue/<ISSUE_ID>/open
This action URL opens an issue using the given issue ID.
purple://kiosk/issue/by_external_id/<EXTERNAL_ISSUE_ID>/open?fallback_url= <URL_ENCODED_URL>&target=<TARGET>
This action URL opens an issue using the given external issue ID. The external issue ID may be part of your CMS.
Related information: You can configure your own view for created bookmarks under the following setting in Purple Manager:
"Your app" => "App Design" => "General" => "Advanced Settings" => "Bookmarks" => "Custom Bookmarks UI URL"
That configured view can be opened by using this action URL.
purple://content/bookmark/add
This action URL adds a new bookmark.
purple://content/page/<PAGE_ID>/open
This action URL opens a page by the given page id.
purple://content/page/alias/<PAGE_ALIAS>/open
This action URL opens a page by the given page alias.
purple://content/page/index/<PAGE_INDEX>/open
This action URL opens a page by the given page index.
In order for this action URL to work, "Content Share" must be activated in Purple Manager.
"Your app" => "Sharing" => "General" => "Basic Settings" => "Sharing" => "Content Share enabled"
purple://content/page/alias/<PAGE_ALIAS>/share
This action URL shares a page by the given page alias.
purple://content/toc/open
This action URL opens the TOC of the issue.
purple://kiosk/entitlement/login/oauth/start?success_url=<URL_ENCODED_URL>
This action URL starts the oauth login flow. If the oauth login flow was successful completed, the success_url will be opened.
In order for this action URL to work, "Custom UI Login URL" must be activated in Purple Manager.
"Your app" => "Entitlement" => "App Configuration" => "Basic Settings" => "Entitlement" => "Custom UI Login URL"
purple://kiosk/entitlement/login/open
This action URL opens the entitlement login view.
purple://kiosk/entitlement/logout/perform?success_url=<URL_ENCODED_URL>
This action URL performs the entitlement logout. If the logout was successful completed, the success_url will be opened.
purple://kiosk/products/<PRODUCT_ID>/purchase
This action URL starts an in-app purchase for the given product id. The product ID must be either from the Apple App Store or from the Google Play Store.
purple://kiosk/products/restore
This action URL restores purchases on the device.
This action URL is for iOS only.
purple://store/coderedemption/open
This action URL opens the code redemption view.
This action URL is for iOS only. The flow is only shown if the app user has not seen the ATT system dialog before and has selected one of the provided options.
purple://app/consent/privacy_info/open
This action URL starts the ATT flow. This flow consists of two steps depending of the app configuration within the purple manager.
Step 1: Show a custom html info view before the ATT dialog is shown. This step is optional and must be configured within the Purple Manager.
"Your app" => "Consent/Push/Analytics" => "Privacy" => "iOS" => "Basic Settings" => "App Tracking Transparency (ATT)"
Step 2: Show the ATT dialog (This is a system dialog from iOS).
The CMP itself must be configured in Purple Manager. If no CMP is configured, this action URL will not work.
"Your app" => "Consent/Push/Analytics" => "Consent Management" => "General" => "Basic Settings"
purple://app/consent/privacy_manager/open
This action URL opens the settings view from your configured CMP.
In order for this action URL to work, "App Share" must be activated in Purple Manager.
"Your app" => "Sharing" => "General" => "Basic Settings" => "Sharing" => "App Share enabled"
purple://app/share_app_or_issue
This action URL shares the current issue if one is open. Otherwise the app is shared.
In order for this action URL to work, "App Share" or "Content Share" must be activated in Purple Manager.
"Your app" => "Sharing" => "General" => "Basic Settings" => "Sharing" => "App share enabled"
"Your app" => "Sharing" => "General" => "Basic Settings" => "Sharing" => "Content Share enabled"
purple://app/share_app_or_issue_or_page
This action URL shares the current page if an issue is open and "Content sharing" is activated in Purple Manager.
If the above case does not apply the current issue will be shared if it is open, otherwise the app will be shared.
This action URL can be customized by "Custom HTML start point" in Purple Manager. Once configured and released to your app ensure that the website keeps valid at the configured location.
"Your app" => "Basic Settings" => "General" => "Basic Settings" => "Custom HTML start point"
purple://app/home/open
This action URL opens the home view of the app. The home view itself is any html file within the dynamic resources.
In order for this action URL to work, "HTML Onboarding" must be activated in Purple Manager.
"Your app" => "Basic Settings" => "General" => "Basic Settings" => "HTML Onboarding"
purple://app/onboarding/app_start/open
This action URL opens the onboarding view which is shown on first app start.
purple://app/info/open
This action URL opens the app information view.
purple://app/settings/open
This action URL opens the app settings view.
The following two variants each open an existing html file from the dynamic resources. The two variants differ only in one point that comes into play in an Android app. For Android's app behavior please read the red warning below.
As a suggestion for good structuring, always use the storefront variant if you want to reference a view from the storefront and the app variant for all storefront independent views. Such as a FAQ page or a privacy policy page.
Androids app behavior for both variants:
The app variant opens the html file on top of the current view context while the storefront variant navigates to a kiosk view context before opening the html.
Open app related html files
purple://app/resource/dynamic/<PATH>?display_mode=<DISPLAY_MODE>&title_bar=<TITLE_BAR>&controls=<CONTROLS>&force_status_bar=<FORCE_STATUS_BAR>&app_logo=<APP_LOGO>&bounces=<BOUNCES>
This action URL opens a hml file within an in-app-browser. The appearance of the in-app-browser can be configured by params.
Note: The bounces url parameter is for iOS only.
Open storefront related html files
purple://storefront/resource/dynamic/<PATH>?display_mode=<DISPLAY_MODE>&title_bar=<TITLE_BAR>&controls=<CONTROLS>&force_status_bar=<FORCE_STATUS_BAR>&app_logo=<APP_LOGO>&bounces=<BOUNCES>
This action URL opens a hml file within an in-app-browser. The appearance of the in-app-browser can be configured by params.
Note: The bounces url parameter is for iOS only.
mailto:
This action URL opens the default mail app from your device to write and send an email.
tel:
This action URL opens the default phone app from your device for a call.