The Automations API configures scheduled reactions: logic that runs on a recurring schedule or at a specific time, rather than in response to a live event. See Reactions for a conceptual overview of both automations and event-driven triggers.Documentation Index
Fetch the complete documentation index at: https://docs.omneo.io/llms.txt
Use this file to discover all available pages before exploring further.
Automations vs triggers
| Type | What fires it | Configured via |
|---|---|---|
| Trigger | A platform event (e.g., transaction.created) | Triggers API |
| Automation | A schedule (daily, weekly, specific date) | Automations API |
trigger field value, which for automations specifies the schedule rather than an event name.
Automation attributes
| Attribute | Description |
|---|---|
id INTEGER | The unique Omneo ID of the automation |
name STRING | The display name of the automation |
trigger STRING | The schedule definition (a cron expression or schedule keyword) |
description STRING | A description of what this automation does |
notes STRING | Internal notes about the automation |
is_active BOOLEAN | Whether the automation is active and will run on schedule |
actions ARRAY | An ordered array of actions that execute when the automation fires |
Actions
Automation actions use the same structure as trigger actions. Each action has auuid (action type), sort_order, and arguments array. See Triggers for the full action type reference.
Common automation patterns
- Win-back: weekly automation that finds lapsed profiles and issues a re-engagement benefit
- Birthday: daily automation that issues birthday rewards to profiles with
birth_datetoday - Expiry reminder: daily automation that finds rewards expiring within 14 days and sends a reminder via target