*API REST › Objetos › Plataforma*

# Workflow

> Automatización de la cuenta.

Una automatización de la cuenta, con su nombre, si está activa, su trigger y su versión actual. Su definición no se publica, y no puedes crear ni cambiar workflows desde fuera; puedes iniciar una ejecución de uno con un trigger manual y una versión guardada. Los workflows están acotados a la suscripción que posee la clave.

Esquemas: `WorkflowDto`

## Atributos

| Nombre | Tipo | Descripción |
| --- | --- | --- |
| `id` | string | Identificador único del workflow. |
| `name` | string | Nombre del workflow. |
| `isActive` | boolean | true cuando el workflow está activo; false cuando está en pausa. |
| `archivedAt` | string<date-time> | Fecha en que se archivó en ISO 8601 UTC; null si no está archivado. |
| `trigger` | object | Cómo se inicia el workflow y, si es manual, qué pide. |
| `trigger.type` | string | Cómo se inicia el workflow: manual (una persona o la API lo ejecuta), schedule (cron), webhook (una petición entrante), event (ocurre algo en Filmo), signal (otro workflow) o entity (se ejecuta desde la página de un registro). Null si no tiene versión publicada. `manual`, `schedule`, `webhook`, `event`, `signal`, `entity` |
| `trigger.event` | string | Para los triggers `event`, el evento de Filmo que escucha; null en caso contrario. |
| `trigger.entity` | string | Para los triggers `entity`, el tipo de entidad sobre el que se ejecuta; null en caso contrario. |
| `trigger.form` | object[] | Para los triggers `manual`, el formulario de ejecución: todos los campos listados son OBLIGATORIOS en `payload` al llamar a [`POST /api/v1/workflows/{workflowId}/runs`](https://docs.filmo.io/es/rest-api/endpoint-reference/workflows/run-a-workflow). Vacío cuando el workflow no pide nada. |
| `trigger.form.name` | string | Clave del campo en `payload` al ejecutar el workflow. |
| `trigger.form.label` | string | Texto que ve la persona que lo ejecuta. |
| `trigger.form.type` | object<string, any> | Tipo declarado del valor, en el lenguaje de tipos de los workflows: `{"type":"string"}`, `{"type":"number"}`, `{"type":"boolean"}`, `{"type":"date","mode":"date"\|"datetime"}`, `{"type":"enum","options":[{"value","label"}]}`, `{"type":"shape","shape":[{"key","label","value":<type>}]}`, `{"type":"list","item":<type>}`, `{"type":"record","value":<type>}` o `{"type":"tuple","tuple":[<type>]}`. El valor enviado en `payload` se valida contra él. |
| `currentVersion` | object | La versión publicada, que es la que se ejecuta y de la que se lee el formulario de ejecución; null cuando el workflow nunca se ha guardado. |
| `currentVersion.version` | integer | Número de la versión publicada. |
| `currentVersion.createdAt` | string<date-time> | Cuándo se publicó, en ISO 8601 UTC. |
| `createdAt` | string<date-time> | Fecha de creación en ISO 8601 UTC. |
| `updatedAt` | string<date-time> | Fecha de la última modificación en ISO 8601 UTC. |

## Ejemplo

*Workflow · Generado a partir del esquema*

```json
{
  "id": "id_8f2a1c",
  "name": "Example",
  "isActive": true,
  "archivedAt": "2026-09-01T08:00:00Z",
  "trigger": {
    "type": "manual",
    "event": "string",
    "entity": "string",
    "form": [
      {
        "name": "Example",
        "label": "Example",
        "type": {
          "key": "string"
        }
      }
    ]
  },
  "currentVersion": {
    "version": 1,
    "createdAt": "2026-09-01T08:00:00Z"
  },
  "createdAt": "2026-09-01T08:00:00Z",
  "updatedAt": "2026-09-01T08:00:00Z"
}
```

## Lo devuelven

- [`GET /api/v1/workflows`](https://docs.filmo.io/es/rest-api/endpoint-reference/workflows/list-workflows) — Listar workflows

## Lo modifican

Ninguna operación.

---

URL canónica: https://docs.filmo.io/es/rest-api/objects/workflow  
Última actualización: 2026-10-25