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.

Action Requests

Prev Next

Overview

The Action Request service enables you to display high-priority modal prompts to specific mobile app users. Action Requests require acknowledgment or interaction before users can continue using the mobile app.

NOTE: This feature is only supported in version 1.59 or newer.

Common use cases include but are not limited to:

  • Severe weather warnings

  • Document scan requests

  • Safety policy acknowledgments

  • Load assignment acceptances

IMPORTANT: Action Requests block all mobile app interaction until the user responds. To avoid safety risks, we strongly recommend limiting the use of this feature.


How It Works

Submit an Action Request using the PUT API. The Platform synchronizes the request to the target user’s mobile app. When conditions allow, the mobile app displays the Action Request as an overlay on top of the current screen. Users must respond before interacting with other areas of the app.

Delivery may be temporarily postponed while a user is in turn-by-turn navigation or during In-Motion Locking.

Key Components

When creating an Action Request, define the following required properties:

  • username: Identifies the user who will receive the Action Request

  • handle: Defines a unique per-user identifier used for tracking and completion handling

  • title: Specifies the primary heading text displayed to the user

  • actions: Defines the available response actions presented within the request

    NOTE: The actions array must contain at least one action object and cannot contain more than two action objects.

TIP: Disable the show_form_editor flag when a simple acknowledgment button is sufficient. This configuration allows users to respond with a single tap without opening the form editor.

Snooze Behavior

Action Requests support configurable snooze behavior through the snooze object. When enabled is set to true, users can temporarily snooze the Action Request and continue interacting with the mobile app until the snooze period expires. You can set this snooze duration via the snooze_duration_minutes field.

The snooze_duration_minutes field supports values from 15 minutes up to 1,439 minutes (24 hours). After the configured expiration, the Action Request reappears automatically and the user must respond before continuing use of the mobile app.

Users can manually redisplay a snoozed Action Request through the app menu at any time.

WARNING: Setting enabled to false disables snoozing entirely and blocks all mobile app interaction until the user responds to the Action Request.

Action Button Sizing

Use the action_button_size property to control the size of action buttons displayed within the Action Request.

Use larger button sizing for workflows that require increased visibility or easier interaction within the mobile app.

Delivery Behavior

The Platform manages the timing and volume of Action Requests to ensure safety and system stability:

  • Only one Action Request can remain active per user at a time.

  • If an Action Request is no longer needed, delete it via the API to remove it from the user's device.


Resources

API