List of Action URLs

app menu open native app menu 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 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 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 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 purple //app/open/external/url/< \<font color="#3b9f0f">url encoded url\</font> > this action url opens the given url by handing it over to the underlying os parameter required description \<font color="#3b9f0f">url encoded url\</font> \<font color="#eb144c">yes\</font> placeholder for your given url this url must be url encoded the following url must be url encoded \<font color="#3b9f0f">https //www example com/\</font> which results in the following url encoded url \<font color="#3b9f0f">https%3a%2f%2fwww example com%2f\</font> to finally insert that in the action url purple //app/open/external/url/ \<font color="#3b9f0f">https%3a%2f%2fwww example com%2f\</font> register app for push 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 this action url has no parameters content note that all content related action urls starting with \<font color="#2166ae">purple //content/\</font> only work within the opened issue open issue purple //kiosk/issue/< \<font color="#3b9f0f">issue id\</font> >/open this action url opens an issue using the given issue id parameter required description \<font color="#3b9f0f">issue id\</font> \<font color="#eb144c">yes\</font> this is the issue id from your issue open issue by external issue id purple //kiosk/issue/by external id/< \<font color="#3b9f0f">external issue id\</font> >/open? \<font color="#2166ae">fallback url\</font> = < \<font color="#3b9f0f">url encoded url\</font> >& \<font color="#2166ae">target\</font> =< \<font color="#3b9f0f">target\</font> > 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 \<font color="#3b9f0f">external issue id\</font> \<font color="#eb144c">yes\</font> unique identifier for the content the external issue id may be part of your cms query parameter required description \<font color="#2166ae">fallback url\</font> no the url which should be opened if no issue with the external issue id can be found \<font color="#3b9f0f">url encoded url\</font> this url must be url encoded \<font color="#2166ae">target\</font> no the target for the fallback url \<font color="#3b9f0f">target\</font> " \<font color="#3b9f0f"> blank\</font> " 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 " \<font color="#2166ae">your app\</font> " => " \<font color="#2166ae">app design\</font> " => " \<font color="#2166ae">general\</font> " => " \<font color="#2166ae">advanced settings\</font> " => " \<font color="#2166ae">bookmarks\</font> " => " \<font color="#2166ae">custom bookmarks ui url\</font> " that configured view can be opened by using this action url docid\ hvlbwiwymm61gc7f6znfr purple //content/bookmark/add this action url adds a new bookmark this action url has no parameters open page in content by page id purple //content/page/< \<font color="#3b9f0f">page id\</font> >/open this action url opens a page by the given page id parameter required description \<font color="#3b9f0f">page id\</font> \<font color="#eb144c">yes\</font> the page id to open matching page open page in content by page alias purple //content/page/alias/< \<font color="#3b9f0f">page alias\</font> >/open this action url opens a page by the given page alias parameter required description \<font color="#3b9f0f">page alias\</font> \<font color="#eb144c">yes\</font> the page alias to open matching page open page in content by page index purple //content/page/index/< \<font color="#3b9f0f">page index\</font> >/open this action url opens a page by the given page index parameter required description \<font color="#3b9f0f">page index\</font> \<font color="#eb144c">yes\</font> the page index to open matching page share page in content by page alias in order for this action url to work, " \<font color="#2166ae">content share\</font> " must be activated in purple manager " \<font color="#2166ae">your app\</font> " => " \<font color="#2166ae">sharing\</font> " => " \<font color="#2166ae">general\</font> " => " \<font color="#2166ae">basic settings\</font> " => " \<font color="#2166ae">sharing\</font> " => " \<font color="#2166ae">content share enabled\</font> " purple //content/page/alias/< \<font color="#3b9f0f">page alias\</font> >/share this action url shares a page by the given page alias parameter required description \<font color="#3b9f0f">page alias\</font> \<font color="#eb144c">yes\</font> the page alias to share matching page open the toc from the content purple //content/toc/open this action url opens the toc of the issue this action url has no parameters entitlement start oauth entitlement flow purple //kiosk/entitlement/login/oauth/start? \<font color="#2166ae">success url\</font> =< \<font color="#3b9f0f">url encoded url\</font> > this action url starts the oauth login flow if the oauth login flow was successful completed, the \<font color="#2166ae">success url\</font> will be opened query parameter required description \<font color="#2166ae">success url\</font> no the url to open when the oauth flow completes successfully \<font color="#3b9f0f">url encoded url\</font> 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, " \<font color="#2166ae">custom ui login url\</font> " must be activated in purple manager " \<font color="#2166ae">your app\</font> " => " \<font color="#2166ae">entitlement\</font> " => " \<font color="#2166ae">app configuration\</font> " => " \<font color="#2166ae">basic settings\</font> " => " \<font color="#2166ae">entitlement\</font> " => " \<font color="#2166ae">custom ui login url\</font> " purple //kiosk/entitlement/login/open this action url opens the entitlement login view this action url has no parameters perform logout for user purple //kiosk/entitlement/logout/perform? \<font color="#2166ae">success url\</font> =< \<font color="#3b9f0f">url encoded url\</font> > this action url performs the entitlement logout if the logout was successful completed, the \<font color="#2166ae">success url\</font> will be opened query parameter required description \<font color="#2166ae">success url\</font> no the url to open when the logout completes successfully \<font color="#3b9f0f">url encoded url\</font> 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 purple //kiosk/products/< \<font color="#3b9f0f">product id\</font> >/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 \<font color="#3b9f0f">product id\</font> yes the product id, either from the apple app store or from the google play store restore purchases on device 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 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 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 " \<font color="#2166ae">your app\</font> " => " \<font color="#2166ae">consent/push/analytics\</font> " => " \<font color="#2166ae">privacy\</font> " => " \<font color="#2166ae">ios\</font> " => " \<font color="#2166ae">basic settings\</font> " => " \<font color="#2166ae">app tracking transparency (att)\</font> " 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 " \<font color="#2166ae">your app\</font> " => " \<font color="#2166ae">consent/push/analytics\</font> " => " \<font color="#2166ae">consent management\</font> " => " \<font color="#2166ae">general\</font> " => " \<font color="#2166ae">basic settings\</font> " 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, " \<font color="#2166ae">app share\</font> " must be activated in purple manager " \<font color="#2166ae">your app\</font> " => " \<font color="#2166ae">sharing\</font> " => " \<font color="#2166ae">general\</font> " => " \<font color="#2166ae">basic settings\</font> " => " \<font color="#2166ae">sharing\</font> " => " \<font color="#2166ae">app share enabled\</font> " 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, " \<font color="#2166ae">app share\</font> " or " \<font color="#2166ae">content share\</font> " must be activated in purple manager " \<font color="#2166ae">your app\</font> " => " \<font color="#2166ae">sharing\</font> " => " \<font color="#2166ae">general\</font> " => " \<font color="#2166ae">basic settings\</font> " => " \<font color="#2166ae">sharing\</font> " => " \<font color="#2166ae">app share enabled\</font> " " \<font color="#2166ae">your app\</font> " => " \<font color="#2166ae">sharing\</font> " => " \<font color="#2166ae">general\</font> " => " \<font color="#2166ae">basic settings\</font> " => " \<font color="#2166ae">sharing\</font> " => " \<font color="#2166ae">content share enabled\</font> " 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 " \<font color="#2166ae">custom html start point\</font> " in purple manager once configured and released to your app ensure that the website keeps valid at the configured location " \<font color="#2166ae">your app\</font> " => " \<font color="#2166ae">basic settings\</font> " => " \<font color="#2166ae">general\</font> " => " \<font color="#2166ae">basic settings\</font> " => " \<font color="#2166ae">custom html start point\</font> " 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, " \<font color="#2166ae">html onboarding\</font> " must be activated in purple manager " \<font color="#2166ae">your app\</font> " => " \<font color="#2166ae">basic settings\</font> " => " \<font color="#2166ae">general\</font> " => " \<font color="#2166ae">basic settings\</font> " => " \<font color="#2166ae">html onboarding\</font> " 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 purple //app/info/open this action url opens the app information view this action url has no parameters open app settings view 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 purple //app/resource/dynamic/< \<font color="#3b9f0f">path\</font> >? \<font color="#2166ae">display mode\</font> =< \<font color="#3b9f0f">display mode\</font> >& \<font color="#2166ae">title bar\</font> =< \<font color="#3b9f0f">title bar\</font> >& \<font color="#2166ae">controls\</font> =< \<font color="#3b9f0f">controls\</font> >& \<font color="#2166ae">force status bar\</font> =< \<font color="#3b9f0f">force status bar\</font> >& \<font color="#2166ae">app logo\</font> =< \<font color="#3b9f0f">app logo\</font> >& \<font color="#ff6900">bounces\</font> =< \<font color="#3b9f0f">bounces\</font> > 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 \<font color="#ff6900">bounces\</font> url parameter is for ios only parameter required description \<font color="#3b9f0f">path\</font> \<font color="#eb144c">yes\</font> the relative path of the html file in your dynamic resources query parameter required description \<font color="#2166ae">display mode\</font> no \<font color="#3b9f0f">display mode\</font> (default is " \<font color="#3b9f0f">embedded\</font> ") \<font color="#3b9f0f">embedded\</font> the html view is displayed embedded in your app and the app menu is still usable \<font color="#3b9f0f">modal\</font> the html view is displayed modally and the app menu is not usable \<font color="#2166ae">title bar\</font> no \<font color="#3b9f0f">title bar\</font> (default is " \<font color="#3b9f0f">true\</font> ") \<font color="#3b9f0f">true\</font> show the title bar \<font color="#3b9f0f">false\</font> no title bar is shown \<font color="#2166ae">controls\</font> no \<font color="#3b9f0f">controls\</font> (default is " \<font color="#3b9f0f">false\</font> ") \<font color="#3b9f0f">true\</font> show navigation controls \<font color="#3b9f0f">false\</font> no navigation controls are shown \<font color="#2166ae">force status bar\</font> no \<font color="#3b9f0f">force status bar\</font> (default is " \<font color="#3b9f0f">false\</font> ") \<font color="#3b9f0f">true\</font> show the status bar \<font color="#3b9f0f">false\</font> no status bar is shown \<font color="#2166ae">app logo\</font> no \<font color="#3b9f0f">app logo\</font> (default is " \<font color="#3b9f0f">false\</font> ") \<font color="#3b9f0f">true\</font> show app logo in title bar instead of text \<font color="#3b9f0f">false\</font> no app logo is shown \<font color="#ff6900">bounces\</font> no \<font color="#3b9f0f">bounces\</font> (default is " \<font color="#3b9f0f">true\</font> ") \<font color="#3b9f0f">true\</font> allow bouncing when scrolling \<font color="#3b9f0f">false\</font> no bouncing is allowed \<font color="#ff6900">note\</font> open storefront related html files purple //storefront/resource/dynamic/< \<font color="#3b9f0f">path\</font> >? \<font color="#2166ae">display mode\</font> =< \<font color="#3b9f0f">display mode\</font> >& \<font color="#2166ae">title bar\</font> =< \<font color="#3b9f0f">title bar\</font> >& \<font color="#2166ae">controls\</font> =< \<font color="#3b9f0f">controls\</font> >& \<font color="#2166ae">force status bar\</font> =< \<font color="#3b9f0f">force status bar\</font> >& \<font color="#2166ae">app logo\</font> =< \<font color="#3b9f0f">app logo\</font> >& \<font color="#ff6900">bounces\</font> =< \<font color="#3b9f0f">bounces\</font> > 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 \<font color="#ff6900">bounces\</font> url parameter is for ios only parameter required description \<font color="#3b9f0f">path\</font> \<font color="#eb144c">yes\</font> the relative path of the html file in your dynamic resources query parameter required description \<font color="#2166ae">display mode\</font> no \<font color="#3b9f0f">display mode\</font> (default is " \<font color="#3b9f0f">embedded\</font> ") \<font color="#3b9f0f">embedded\</font> the html view is displayed embedded in your app and the app menu is still usable \<font color="#3b9f0f">modal\</font> the html view is displayed modally and the app menu is not usable \<font color="#2166ae">title bar\</font> no \<font color="#3b9f0f">title bar\</font> (default is " \<font color="#3b9f0f">true\</font> ") \<font color="#3b9f0f">true\</font> show the title bar \<font color="#3b9f0f">false\</font> no title bar is shown \<font color="#2166ae">controls\</font> no \<font color="#3b9f0f">controls\</font> (default is " \<font color="#3b9f0f">false\</font> ") \<font color="#3b9f0f">true\</font> show navigation controls \<font color="#3b9f0f">false\</font> no navigation controls are shown \<font color="#2166ae">force status bar\</font> no \<font color="#3b9f0f">force status bar\</font> (default is " \<font color="#3b9f0f">false\</font> ") \<font color="#3b9f0f">true\</font> show the status bar \<font color="#3b9f0f">false\</font> no status bar is shown \<font color="#2166ae">app logo\</font> no \<font color="#3b9f0f">app logo\</font> (default is " \<font color="#3b9f0f">false\</font> ") \<font color="#3b9f0f">true\</font> show app logo in title bar instead of text \<font color="#3b9f0f">false\</font> no app logo is shown \<font color="#ff6900">bounces\</font> no \<font color="#3b9f0f">bounces\</font> (default is " \<font color="#3b9f0f">true\</font> ") \<font color="#3b9f0f">true\</font> allow bouncing when scrolling \<font color="#3b9f0f">false\</font> no bouncing is allowed \<font color="#ff6900">note\</font> standard system protocols open mail app 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 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