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.

Geofencing

Prev Next

Overview

A geofence provides you with the ability to define a specific geographic boundary near a stop. These boundaries trigger trip-change notifications whenever a user enters or exits the defined area while actively using turn-by-turn navigation within the mobile app.

NOTE: Notifications for entering or exiting a geofence are strictly scoped to the load in which the geofence is defined.

How It Works

The Platform monitors the user's location during active navigation and evaluates it against the geofences provided in your load data.

Defining Boundaries

You can define a geofence in one of two ways:

  1. Point and Radius: A central geographic coordinate (latitude and longitude) paired with a radius (e.g., a circle around a facility).

  2. Polygon: A custom shape defined by a series of geographic coordinates, allowing for precise boundaries around complex property lines.

Triggering Notifications

When a user crosses the threshold of a configured geofence during turn-by-turn navigation, the Platform detects the entry or exit. This event triggers a trip-change notification, keeping your system informed of the user's proximity to a destination.

IMPORTANT: Geofence events are only evaluated during active turn-by-turn navigation. If the user's arrival at the destination causes navigation to end before the geofence is breached, you will not receive a trip change notification.

Load Integration

To configure geofences, you must modify your Loads response. You can do this by adding a geofences array as an attribute to any of the following locations:

  • The shipper object.

  • The consignee object.

  • A specific stop object within the stops array.

Resources

API