Documentation Index

Fetch the complete documentation index at: https://docs.eleostech.com/llms.txt

Use this file to discover all available pages before exploring further.

Actions

  • Published on Apr 22, 2026
  • 1 minute(s) read
Prev Next

Overview

Actions enable users to perform different activities or steps of operation within the mobile app. Actions help users submit time off requests, scan documents, and follow workflows. You can embed actions in various parts of the mobile app, such as within information cards on the dashboard, within a load, within a stop, and in an Action Request.

You can create inline actions via the API or create predefined actions within App Manager.

Action Types

The Platform provides seven available action types:

  • browser: Launches a web browser, either embedded inside the mobile app or an external browser.

  • scan-flow: Initiates a document scan flow or a photograph capture.

  • transaction-editor: Enables users to send a form-based message.

  • telephone: Enables a user to call a telephone number.

  • screen: Displays a dynamic action screen.

  • launch-url: Launches another application or launch the application store to install the application.

  • logout: Logs the user out of the mobile app.

Key Components

When building an inline action you will work with specific key components within the action object:

  • label: A required field that allows you to specify the text to be displayed on the action button.

  • icon_ref: An optional field specifying the icon reference code to display alongside the label.

  • type: A required field assigning the action function.

  • properties: A required object containing the specific action details.

You can review the dashboard.dashboard_items.properties.action object within the User Authentication API, the actions array within the GET Loads API, or the actions array within the PUT Action Requests API to view more detailed information outlining the definition of an inline action.

How it works

The Platform allows you to create multiple actions within different parts of the mobile app. You can include actions within authentication responses, load responses, and Action Requests.

Specify an action in two distinct ways:

  • Dynamically build the entire action inside the API response by providing a full action object or an actions array.

  • Reference the action code within the action object, actions array, or action_codes array.

    NOTE: This method requires you to build and save the action in App Manager before referencing the code.

When adding an action to a dashboard information card, the action_codes array specifies the codes of actions to display on the card.

IMPORTANT: If the API response includes either the action or actions property, the platform ignores the action_codes field. Action codes require exact case sensitivity.

You can also prefill form data at the action level using Data References.

Resources

API

Guides