Skip to content
docs

AutomatedAction

An automation: “when this happens, start that”. Its triggers are schedules and message triggers (another run changing), and every trigger starts all of its actions. Runs it starts are recorded in its history.

Kind: an object, used in responses.

Fields

Section titled “Fields”

Every field is present in a response; empty ones are null.

FieldTypeDescription
namestringThe automation’s name.
descriptionstring | nullWhat the automation is for, in your own words. Optional.
actionsAutomatedActionItem[]What to start when it is triggered. Every trigger starts each action in turn.
schedulesCronSchedule[]Schedules that trigger it, as cron fields (UTC).
messageTriggersMessageTrigger[]Triggers that fire when another run changes and matches a filter.
nextScheduledRunAtdatetime | nullWhen its schedules next trigger it, in UTC: the earliest next time of its enabled schedules. Null when no schedule is enabled.
historyExecutionHistoryEntry[]The runs it started, oldest first: the most recent maxHistoryEntries of them.
maxHistoryEntriesintegerHow many entries history keeps; older ones are dropped. 50.
totalExecutionsintegerHow many runs it has started, in all.
consecutiveFailuresintegerHow many of its runs in a row have failed. A run that succeeds sets it back to zero.
lastExecutedAtdatetime | nullWhen it last started a run, in UTC. Null if it never has.
lastProcessIduuid | nullThe id of the last run it started. Null if it never has.
userCreatedByIduuidThe id of the user who created it. A call made with an API key is recorded as the key’s user.
namespaceIduuidThe id of the namespace it belongs to.
tenantIduuidThe id of the tenant it belongs to.
iduuidThe unique id. Use it in by-id routes and wherever another object refers to this one.
dateCreateddatetimeWhen it was created, in UTC.
dateUpdateddatetimeWhen it was last changed, in UTC.

Example

Section titled “Example”
{
  "name": "...",
  "description": "...",
  "actions": [
    {
      "id": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
      "name": "...",
      "config": {
        "$type": "app"
      }
    }
  ],
  "schedules": [
    {
      "id": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
      "name": "...",
      "isEnabled": false,
      "second": "...",
      "minute": "...",
      "hour": "...",
      "dayOfMonth": "...",
      "month": "...",
      "dayOfWeek": "...",
      "nextOccurrence": "2026-10-26T12:00:00.0000000Z"
    }
  ],
  "messageTriggers": [
    {
      "id": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
      "name": "...",
      "isEnabled": false,
      "triggerType": "AppProcessUpdated",
      "eventFilter": "..."
    }
  ],
  "nextScheduledRunAt": "2026-10-26T12:00:00.0000000Z",
  "history": [
    {
      "id": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
      "triggerType": "Schedule",
      "triggerId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
      "actionId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
      "processId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
      "processType": "App",
      "dateStarted": "2026-10-26T12:00:00.0000000Z",
      "dateCompleted": "2026-10-26T12:00:00.0000000Z",
      "outcome": "Pending",
      "errorMessage": "..."
    }
  ],
  "maxHistoryEntries": 0,
  "totalExecutions": 0,
  "consecutiveFailures": 0,
  "lastExecutedAt": "2026-10-26T12:00:00.0000000Z",
  "lastProcessId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
  "userCreatedById": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
  "namespaceId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
  "tenantId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
  "id": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
  "dateCreated": "2026-10-26T12:00:00.0000000Z",
  "dateUpdated": "2026-10-26T12:00:00.0000000Z"
}

Where it’s used

Section titled “Where it’s used”
maitento