Skip to main content

collect_app_records

Internal beta — config shape is being migrated

The Automation API is an internal beta and is not released yet — endpoints and payloads may change or be withdrawn without notice. This action's config is being migrated to a typed schema; the fields below reflect that in-progress shape. Always read the authoritative, live shape from GET /v1/automation/meta/action before building against it.

Collect app records — collects records from an app into a record collection. group: "action". No specific trigger context is required.

Part of the Record collections family. This page documents the typed config; for how an action sits inside an automation definition, see Actions and Action examples.

Config​

KeyTypeRequiredDescription
app_idintegernoId of the app whose records are collected. Carried through only when set.
match_conditionfilter group | nullnoRecords filter. Empty "match all" condition when omitted; null composes back from an empty condition.
limitintegernoMaximum number of records to collect. Default 1.
limit_enabledbooleannoWhether limit is applied. Default false.

Example​

An action entry inside an automation definition's actions[]:

{
  "type": "collect_app_records",
  "config": {
    "app_id": 4821,
    "match_condition": {
      "operator": "and",
      "rows": [
        {
          "subject": {
            "kind": "variable",
            "source": "field",
            "field_id": 55012,
            "field_type": "single_text",
            "previous": false,
            "collection": false,
            "triggering": false
          },
          "operator": "is_not_empty"
        }
      ]
    },
    "limit": 100,
    "limit_enabled": true
  }
}

Validation & behavior​

  • Every member is optional; an omitting caller still yields a complete internal action via the mapper's defaults.
  • match_condition defaults to the empty "match all" condition, so with no filter the whole app is collected.
  • limit defaults to 1 and only takes effect when limit_enabled is true; with limit_enabled false the collect is unbounded.
  • This action is a producer: it publishes a record_collection. An unbounded collect is capped at the server 1000-record limit.

See also​