Automations

Retrieve the evaluable fields of a trigger

List the fields you can write conditions against for one trigger: location in the event, type, label and accepted operators.

  • A trigger outside your visible catalog returns 404, so it cannot be used to probe contracted modules.
  • A visible trigger with no evaluable fields returns 422.
get/companies/{company}/automations/catalog/triggers/{trigger}/fields

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/companies/{company}/automations/catalog/triggers/{trigger}/fields
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

companystring uuid required

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

triggerstring required

Trigger key, a dotted event name such as invoice.created.

Headers

Factuarea-Versionstring date
Example:2026-06-01

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Response

Example response

{
  "data": {
    "trigger": "invoice.paid",
    "fields": [
      {
        "path": "total",
        "type": "number",
        "type_label": "Número decimal",
        "operators": [
          "eq",
          "neq",
          "gt",
          "gte",
          "lt",
          "lte"
        ]
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.