Open Link

Launch web links or app deep links

link actions open a variety of links. This includes:

  • Web links (http/https) in Safari, or an in-app browser

  • System links, like linking to settings with app-settings:

  • Deep linking into other apps, like spotify:album:4oktVvRuO1In9B7Hz0xm0a

Links have the actionType link and an actionData object with the following keys:

  • url [string, required]: the URL to open

  • useEmbeddedBrowser [bool, optional]: If true, will open the link in an in-app browser instead of launching to Safari. Only valid for http/https links.

Config Examples

"web_link_action": {
    "actionType": "link",
    "actionData": {
        "url": "https://criticalmoments.io"
    }
},
"web_link_embedded_action": {
    "actionType": "link",
    "actionData": {
        "url": "https://criticalmoments.io",
        "useEmbeddedBrowser": true
    }
},
"settings_link_action": {
    "actionType": "link",
    "actionData": {
        "url": "app-settings:"
    }
},
"main_screen_deeplink_action": {
    "actionType": "link",
    "actionData": {
        "url": "critical-moments-sampleapp:main"
    }
}

Last updated