Scheduled return
Scheduled return triggers when a device hasn't returned to its base location by a specific time of day.
How it works
You define a base location, a return-by time, and the days of the week to check. If the device is not at the base by the deadline (plus optional grace period), the rule triggers. The violation clears when the device returns. Only one alert is generated per device per day — it resets at midnight in the configured timezone.
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
base_location_id |
string | Conditional | — | The base zone ID. Use this or zone_tags. |
zone_tags |
array | Conditional | — | Match zones with any of these tags |
exclude_zone_ids |
array | No | — | Zone IDs to exclude when using zone_tags |
return_by_time |
string | Yes | — | Deadline time (e.g., "18:00") |
return_by_days |
array | No | All days | Days to check (e.g., ["monday", "friday"]) |
timezone |
string | No | UTC | Timezone for the deadline |
grace_period_minutes |
integer | No | 0 | Extra minutes after deadline before triggering |
Example: equipment return by end of day
Alert when equipment hasn't returned to the depot by 6:30pm on weekdays:
- Base location:
zone_depot - Return by: 18:00
- Grace period: 30 minutes
- Check days: Monday through Friday
- Timezone: Europe/London
- Severity: High