Actions Overview
Trigger actions when events occur, or conditions are met
Last updated
Was this helpful?
Trigger actions when events occur, or conditions are met
Last updated
Was this helpful?
Our SDK comes with a number of powerful actions built in:
display a banner across the top/bottom of your app, optionally linking to other actions when tapped
: show a fullscreen popover with fully native UI. Create beautiful detailed UI with support for images, titles, text, buttons and theming. Buttons can connect to other actions.
: show the system native UI asking a user to rate your app
: launch native alerts, with buttons connecting to other actions.
: in an embedded brower displaying a webpage inside your app, or opening in the user's default browser
: Launch custom actions/deeplinks into other parts of your app
: Launch other apps, optional deeplinking to specific features
: check a condition, and fire one action if true, and another if false
An alternative to actions are our , which allow deeper integration into your codebase.
Our action UI can be themed to match the design of your app. .
Actions are created in your . A top level actions
object contains an namedActions
map/object, with subitems for each action.
Each action requires an actionType
string and actionData
object. The contents of each are described in the docs for the each action type.
Actions can optionally include a condition
string, which will be evaluated before triggering the action, and will stop the action from being performed if it evaluates to false (or errors).
Actions can also specify a fallback
, a string name of an action to perform if this action can't be performed for any reason. Reasons an action might fail vary based on the action type, but as an example, attempting to launch an app deep link into an app which isn't installed will fail, and can fallback to another action, like launching an app store link to get that app.
Example:
Nested Actions: actions like alerts, modals and banners can have buttons which can be connected to other actions which are fired when the user taps them. For example, a "more info" button could launch an open link action to your webpage for more info.
Actions are connected to the rest of the system through the , by the name specified in the namedActions
map. The following parts of the config file can trigger an action:
connect actions to events. You can fire an action when an event occurs.
: are actions which check a condition, and fire one action by name if true, and another if false