List of Action URLs

59min

App menu
Open native app menu
Action URL
Parameter
purple://app/menu/close
This action URL opens the native app menu. If the app menu is already open, it stays open.
This action URL has no parameters.
﻿
Close native app menu
Action URL
Parameter
purple://app/menu/open
This action URL closes the native app menu. If the app menu is already closed, it stays closed.
This action URL has no parameters.
﻿
Toggle native app menu
Action URL
Parameter
purple://app/menu/toggle
This Action URL opens the native app menu when it is closed. And when it's open, it is closed.
This action URL has no parameters.
﻿
App interaction with operating system
Open feedback mail 
Action URL
Parameter
purple://app/feedback/mail/open
This action URL opens a pre-filled email for feedback as configured within the dynamic resources.
This action URL has no parameters.
﻿
Open external URL
Action URL
Parameter
Example
purple://app/open/external/url/<URL_ENCODED_URL>
This action URL opens the given URL by handing it over to the underlying OS. 
Parameter
Required
Description
﻿URL_ENCODED_URL﻿
﻿yes﻿
Placeholder for your given URL. This URL must be URL-encoded.

The following URL must be URL-encoded
https://www.example.com/

which results in the following URL-encoded URL
https%3A%2F%2Fwww.example.com%2F

to finally insert that in the action URL:
purple://app/open/external/url/https%3A%2F%2Fwww.example.com%2F﻿
﻿
﻿
Register app for push
This action URL does not work below Android 13.
Action URL
Parameter
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.
This action URL has no parameters.
﻿
Content
Note that all content related action URLs starting with purple://content/ only work within the opened issue.
Open issue
Action URL
Parameter
purple://kiosk/issue/<ISSUE_ID>/open
This action URL opens an issue using the given issue ID.
Parameter
Required
Description
﻿ISSUE_ID﻿
﻿yes﻿
This is the issue-ID from your issue. 
﻿
Open issue by external issue ID
Action URL
Parameter
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.
Parameter
Required
Description
﻿EXTERNAL_ISSUE_ID﻿
﻿yes﻿
Unique identifier for the content.
The external issue-ID may be part of your CMS.
Query-Parameter
Required
Description
﻿fallback_url﻿
no
The URL which should be opened if no issue with the external issue-ID can be found. 
﻿URL_ENCODED_URL
This URL must be URL-encoded.
﻿target﻿
no
The target for the fallback_url. 
﻿TARGET
"_blank" to open the URL in the system browser
"" (empty) or omitted to open in the 
in-app-browser.
﻿
Add bookmark for content
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﻿.
Action URL
Parameter
purple://content/bookmark/add
This action URL adds a new bookmark. 
This action URL has no parameters.
﻿
Open page in content by page id
Action URL
Parameter
purple://content/page/<PAGE_ID>/open
This action URL opens a page by the given page id.
Parameter
Required
Description
﻿PAGE_ID﻿
﻿yes﻿
The page id to open matching page.
﻿
Open page in content by page alias
Action URL
Parameter
purple://content/page/alias/<PAGE_ALIAS>/open
This action URL opens a page by the given page alias.
Parameter
Required
Description
﻿PAGE_ALIAS﻿
﻿yes﻿
The page alias to open matching page.
﻿
Open page in content by page index
Action URL
Parameter
purple://content/page/index/<PAGE_INDEX>/open
This action URL opens a page by the given page index.
Parameter
Required
Description
﻿PAGE_INDEX﻿
﻿yes﻿
The page index to open matching page.
﻿
Share page in content by page alias
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"
Action URL
Parameter
purple://content/page/alias/<PAGE_ALIAS>/share
This action URL shares a page by the given page alias.
Parameter
Required
Description
﻿PAGE_ALIAS﻿
﻿yes﻿
The page alias to share matching page.
﻿
Open the TOC from the content
Action URL
Parameter
purple://content/toc/open
This action URL opens the TOC of the issue. 
This action URL has no parameters.
﻿
Entitlement
Start oauth entitlement flow
Action URL
Parameter
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.
Query-Parameter
Required
Description
﻿success_url﻿
no
The URL to open when the oauth flow completes successfully.
﻿URL_ENCODED_URL
This URL must be URL-encoded. It is allowed to use an action URL as success URL.
﻿
Show entitlement login view
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"
Action URL
Parameter
purple://kiosk/entitlement/login/open
This action URL opens the entitlement login view.
This action URL has no parameters.
﻿
Perform logout for user
Action URL
Parameter
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.
Query-Parameter
Required
Description
﻿success_url﻿
no
The URL to open when the logout completes successfully.
﻿URL_ENCODED_URL
This URL must be URL-encoded. It is allowed to use an action URL as success URL.
﻿
In-app purchases
Purchase product by product ID
Action URL
Parameter
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.
Parameter
Required
Description
﻿PRODUCT_ID﻿
yes
The product ID, either from the Apple App Store or from the Google Play Store.
﻿
Restore purchases on device
Action URL
Parameter
purple://kiosk/products/restore
This action URL restores purchases on the device. 
This action URL has no parameters.
﻿
Show code redemption view
This action URL is for iOS only.
Action URL
Parameter
purple://store/coderedemption/open
This action URL opens the code redemption view.
This action URL has no parameters.
﻿
Privacy
Show ATT flow with optional custom html 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.
Action URL
Parameter
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).
This action URL has no parameters.
﻿
Show privacy settings view from CMP
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" 
Action URL
Parameter
purple://app/consent/privacy_manager/open
This action URL opens the settings view from your configured CMP. 
This action URL has no parameters.
﻿
Sharing
Share app or issue
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"
Action URL
Parameter
purple://app/share_app_or_issue
This action URL shares the current issue if one is open. Otherwise the app is shared.
This action URL has no parameters.
﻿
Share app or issue or page
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"
Action URL
Parameter
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 has no parameters.
﻿
Views
Open home view
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"
Action URL
Parameter
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.
This action URL has no parameters.
﻿
Open onboarding view
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"
Action URL
Parameter
purple://app/onboarding/app_start/open
This action URL opens the onboarding view which is shown on first app start.
This action URL has no parameters.
﻿
Open app info view
Action URL
Parameter
purple://app/info/open
This action URL opens the app information view.
This action URL has no parameters.
﻿
Open app settings view
Action URL
Parameter
purple://app/settings/open
This action URL opens the app settings view.
This action URL has no parameters.
﻿
Show custom html view from dynamic resources
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
Action URL
Parameter
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.
Parameter
Required
Description
﻿PATH﻿
﻿yes﻿
The relative path of the html file in your dynamic resources.
Query-Parameter
Required
Description
﻿display_mode﻿
no
﻿DISPLAY_MODE (default is "embedded")
﻿embedded
The html view is displayed embedded in your app and the app menu is still usable.
﻿modal
The html view is displayed modally and the app menu is not usable.
﻿title_bar﻿
no
﻿TITLE_BAR (default is "true")
﻿true
Show the title bar.
﻿false
No title bar is shown.
﻿controls﻿
no
﻿CONTROLS (default is "false")
﻿true
Show navigation controls.
﻿false
No navigation controls are shown.
﻿force_status_bar﻿
no
﻿FORCE_STATUS_BAR (default is "false")
﻿true
Show the status bar.
﻿false
No status bar is shown.
﻿app_logo﻿
no
﻿APP_LOGO (default is "false")
﻿true
Show app logo in title bar instead of text.
﻿false
No app logo is shown.
﻿bounces﻿
no
﻿BOUNCES (default is "true")
﻿true
Allow bouncing when scrolling.
﻿false
No bouncing is allowed.
﻿Note:
That url parameter is for iOS only.﻿
﻿
Open storefront related html files
Action URL
Parameter
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.
Parameter
Required
Description
﻿PATH﻿
﻿yes﻿
The relative path of the html file in your dynamic resources.
Query-Parameter
Required
Description
﻿display_mode﻿
no
﻿DISPLAY_MODE (default is "embedded")
﻿embedded
The html view is displayed embedded in your app and the app menu is still usable.
﻿modal
The html view is displayed modally and the app menu is not usable.
﻿title_bar﻿
no
﻿TITLE_BAR (default is "true")
﻿true
Show the title bar.
﻿false
No title bar is shown.
﻿controls﻿
no
﻿CONTROLS (default is "false")
﻿true
Show navigation controls.
﻿false
No navigation controls are shown.
﻿force_status_bar﻿
no
﻿FORCE_STATUS_BAR (default is "false")
﻿true
Show the status bar.
﻿false
No status bar is shown.
﻿app_logo﻿
no
﻿APP_LOGO (default is "false")
﻿true
Show app logo in title bar instead of text.
﻿false
No app logo is shown.
﻿bounces﻿
no
﻿BOUNCES (default is "true")
﻿true
Allow bouncing when scrolling.
﻿false
No bouncing is allowed.
﻿Note:
That url parameter is for iOS only.﻿
﻿
Standard system protocols
Open mail app
Action URL
Parameter
mailto:
This action URL opens the default mail app from your device to write and send an email.
This official scheme has many parameters. For its use, please inform yourself at the appropriate place. For example in RFC 6068.
﻿
Open phone app to start a call
Action URL
Parameter
tel:
This action URL opens the default phone app from your device for a call.
This official scheme has many parameters. For its use, please inform yourself at the appropriate place. For example in RFC 3966.
﻿
﻿
﻿
﻿
﻿
﻿
﻿
﻿

Parameter	Required	Description
URL_ENCODED_URL	yes	Placeholder for your given URL. This URL must be URL-encoded.

Parameter	Required	Description
ISSUE_ID	yes	This is the issue-ID from your issue.

Parameter	Required	Description
EXTERNAL_ISSUE_ID	yes	Unique identifier for the content. The external issue-ID may be part of your CMS.

Query-Parameter	Required	Description
fallback_url	no	The URL which should be opened if no issue with the external issue-ID can be found. URL_ENCODED_URL This URL must be URL-encoded.
target	no	The target for the fallback_url. TARGET "_blank" to open the URL in the system browser "" (empty) or omitted to open in the in-app-browser.

Parameter	Required	Description
PAGE_ID	yes	The page id to open matching page.

Parameter	Required	Description
PAGE_ALIAS	yes	The page alias to open matching page.

Parameter	Required	Description
PAGE_INDEX	yes	The page index to open matching page.

Parameter	Required	Description
PAGE_ALIAS	yes	The page alias to share matching page.

Query-Parameter	Required	Description
success_url	no	The URL to open when the oauth flow completes successfully. URL_ENCODED_URL This URL must be URL-encoded. It is allowed to use an action URL as success URL.

Query-Parameter	Required	Description
success_url	no	The URL to open when the logout completes successfully. URL_ENCODED_URL This URL must be URL-encoded. It is allowed to use an action URL as success URL.

Parameter	Required	Description
PRODUCT_ID	yes	The product ID, either from the Apple App Store or from the Google Play Store.

Parameter	Required	Description
PATH	yes	The relative path of the html file in your dynamic resources.

Query-Parameter	Required	Description
display_mode	no	DISPLAY_MODE (default is "embedded") embedded The html view is displayed embedded in your app and the app menu is still usable. modal The html view is displayed modally and the app menu is not usable.
title_bar	no	TITLE_BAR (default is "true") true Show the title bar. false No title bar is shown.
controls	no	CONTROLS (default is "false") true Show navigation controls. false No navigation controls are shown.
force_status_bar	no	FORCE_STATUS_BAR (default is "false") true Show the status bar. false No status bar is shown.
app_logo	no	APP_LOGO (default is "false") true Show app logo in title bar instead of text. false No app logo is shown.
bounces	no	BOUNCES (default is "true") true Allow bouncing when scrolling. false No bouncing is allowed. Note: That url parameter is for iOS only.

Parameter	Required	Description
PATH	yes	The relative path of the html file in your dynamic resources.

Query-Parameter	Required	Description
display_mode	no	DISPLAY_MODE (default is "embedded") embedded The html view is displayed embedded in your app and the app menu is still usable. modal The html view is displayed modally and the app menu is not usable.
title_bar	no	TITLE_BAR (default is "true") true Show the title bar. false No title bar is shown.
controls	no	CONTROLS (default is "false") true Show navigation controls. false No navigation controls are shown.
force_status_bar	no	FORCE_STATUS_BAR (default is "false") true Show the status bar. false No status bar is shown.
app_logo	no	APP_LOGO (default is "false") true Show app logo in title bar instead of text. false No app logo is shown.
bounces	no	BOUNCES (default is "true") true Allow bouncing when scrolling. false No bouncing is allowed. Note: That url parameter is for iOS only.

Updated 07 Sep 2023

Did this page help you?

Action URLs and Deep linking

Deep linking