Automações

Fluxos de gatilho, condição e ação definidos no painel. A API os lista e mostra suas execuções.

Listar automações

GET/automations

As automações da organização com seu gatilho, passos, uma descrição em palavras (triggerLabel, stepsSummary) e as execuções da última semana. Filtra por aba (tab), gatilho ou busca; includeArchived=true inclui as arquivadas. Não é paginado.

Permissões: automations:read

Parâmetros

Nome	Onde	Tipo	Valores
`tab`	consulta	string	`all` · `active` · `paused` · `drafts`
`trigger`	consulta	string	`LIFECYCLE_STAGE_ENTERED` · `CAMPAIGN_REPLIED` · `NO_RESPONSE_DAYS` · `WALLET_LOW_BALANCE`
`q`	consulta	string	0–120 caracteres
`includeArchived`	consulta	string	`true` · `false`

curl

curl "https://micuenta.whatsmarketing.es/api/v1/automations" \
  -H "Authorization: Bearer $WM_API_KEY"

Node.js

const res = await fetch('https://micuenta.whatsmarketing.es/api/v1/automations', {
  headers: {
    Authorization: `Bearer ${process.env.WM_API_KEY}`,
  },
});
const data = await res.json();

Python

import os, requests

r = requests.get(
    "https://micuenta.whatsmarketing.es/api/v1/automations",
    headers={"Authorization": f"Bearer {os.environ['WM_API_KEY']}"},
    timeout=30,
)
r.raise_for_status()
data = r.json()

PHP

<?php
$ch = curl_init('https://micuenta.whatsmarketing.es/api/v1/automations');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer ' . getenv('WM_API_KEY'),
  ],
]);
$data = json_decode(curl_exec($ch), true);

Resposta 200

{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
      "organizationId": "f0e1d2c3-b4a5-4968-8776-655443322110",
      "name": "Bienvenida a leads nuevos",
      "status": "ACTIVE",
      "triggerType": "LIFECYCLE_STAGE_ENTERED",
      "triggerConfig": {
        "stage": "Lead nuevo"
      },
      "steps": [
        {
          "type": "CONDITION",
          "config": {
            "kind": "CHANNEL_IS",
            "value": "WHATSAPP"
          }
        },
        {
          "type": "ACTION",
          "config": {
            "kind": "SEND_TEMPLATE",
            "value": "bienvenida_es"
          }
        }
      ],
      "pausedReason": null,
      "failureCount": 0,
      "lastRunAt": "2026-10-14T09:30:00.000Z",
      "templateKey": "welcome",
      "createdByUserId": "2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
      "createdAt": "2026-09-20T12:00:00.000Z",
      "updatedAt": "2026-10-14T09:30:00.000Z",
      "triggerLabel": "Cuando entra en Lead nuevo",
      "stepsSummary": [
        "si canal es WhatsApp",
        "enviar plantilla bienvenida_es"
      ],
      "runs7d": 18
    }
  ],
  "summary": {
    "active": 1,
    "pausedByFailure": 0,
    "paused": 0,
    "drafts": 0,
    "runs7d": 18,
    "runs7dPrevious": 11,
    "templatesSent7d": 18,
    "templatesCost7d": 0.9,
    "currency": "EUR",
    "failures7d": 0,
    "failureExample": null
  }
}

Ver uma automação

GET/automations/{id}

Gatilho, configuração e passos (condição, ação, espera) tal como foram definidos no painel, mais as execuções da última semana.

Permissões: automations:read

Parâmetros

Nome	Onde	Tipo	Valores
`id` obrigatório	rota	string

curl

curl "https://micuenta.whatsmarketing.es/api/v1/automations/{id}" \
  -H "Authorization: Bearer $WM_API_KEY"

Node.js

const res = await fetch('https://micuenta.whatsmarketing.es/api/v1/automations/{id}', {
  headers: {
    Authorization: `Bearer ${process.env.WM_API_KEY}`,
  },
});
const data = await res.json();

Python

import os, requests

r = requests.get(
    "https://micuenta.whatsmarketing.es/api/v1/automations/{id}",
    headers={"Authorization": f"Bearer {os.environ['WM_API_KEY']}"},
    timeout=30,
)
r.raise_for_status()
data = r.json()

PHP

<?php
$ch = curl_init('https://micuenta.whatsmarketing.es/api/v1/automations/{id}');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer ' . getenv('WM_API_KEY'),
  ],
]);
$data = json_decode(curl_exec($ch), true);

Resposta 200

{
  "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
  "organizationId": "f0e1d2c3-b4a5-4968-8776-655443322110",
  "name": "Bienvenida a leads nuevos",
  "status": "ACTIVE",
  "triggerType": "LIFECYCLE_STAGE_ENTERED",
  "triggerConfig": {
    "stage": "Lead nuevo"
  },
  "steps": [
    {
      "type": "CONDITION",
      "config": {
        "kind": "CHANNEL_IS",
        "value": "WHATSAPP"
      }
    },
    {
      "type": "ACTION",
      "config": {
        "kind": "SEND_TEMPLATE",
        "value": "bienvenida_es"
      }
    }
  ],
  "pausedReason": null,
  "failureCount": 0,
  "lastRunAt": "2026-10-14T09:30:00.000Z",
  "templateKey": "welcome",
  "createdByUserId": "2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
  "createdAt": "2026-09-20T12:00:00.000Z",
  "updatedAt": "2026-10-14T09:30:00.000Z",
  "triggerLabel": "Cuando entra en Lead nuevo",
  "stepsSummary": [
    "si canal es WhatsApp",
    "enviar plantilla bienvenida_es"
  ],
  "runs7d": 18
}

Execuções de uma automação

GET/automations/{id}/logs

Cada vez que o gatilho foi atendido para um contato: status (COMPLETED, WAITING, CONDITION_NOT_MET, SKIPPED_NO_CONSENT, FAILED), explicação em palavras e modelos enviados com seu custo. Filtra por result. summary resume a última semana.

Permissões: automations:read

Parâmetros

Nome	Onde	Tipo	Valores
`id` obrigatório	rota	string
`page`	consulta	number	padrão: `1` · 1 – …
`pageSize`	consulta	number	padrão: `20` · 1 – 100
`result`	consulta	string	`all` · `completed` · `waiting` · `condition` · `skipped` · `failed`

curl

curl "https://micuenta.whatsmarketing.es/api/v1/automations/{id}/logs?page=1&pageSize=20" \
  -H "Authorization: Bearer $WM_API_KEY"

Node.js

const res = await fetch('https://micuenta.whatsmarketing.es/api/v1/automations/{id}/logs?page=1&pageSize=20', {
  headers: {
    Authorization: `Bearer ${process.env.WM_API_KEY}`,
  },
});
const data = await res.json();

Python

import os, requests

r = requests.get(
    "https://micuenta.whatsmarketing.es/api/v1/automations/{id}/logs?page=1&pageSize=20",
    headers={"Authorization": f"Bearer {os.environ['WM_API_KEY']}"},
    timeout=30,
)
r.raise_for_status()
data = r.json()

PHP

<?php
$ch = curl_init('https://micuenta.whatsmarketing.es/api/v1/automations/{id}/logs?page=1&pageSize=20');
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer ' . getenv('WM_API_KEY'),
  ],
]);
$data = json_decode(curl_exec($ch), true);

Resposta 200

{
  "data": [
    {
      "id": "b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e",
      "automationId": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
      "contactId": "0b1c2d3e-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
      "contact": {
        "id": "0b1c2d3e-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
        "fullName": "Laura Pérez",
        "primaryPhone": "+34612345678"
      },
      "triggeredAt": "2026-10-14T09:30:00.000Z",
      "status": "COMPLETED",
      "humanMessage": "Plantilla «bienvenida_es» enviada",
      "resultMessage": null,
      "waitUntil": null,
      "conversationReferenceId": null,
      "templatesSent": 1,
      "templateCost": 0.05
    }
  ],
  "meta": {
    "page": 1,
    "pageSize": 20,
    "total": 1,
    "totalPages": 1
  },
  "summary": {
    "runs7d": 18,
    "completed": 17,
    "waiting": 0,
    "conditionNotMet": 1,
    "skipped": 0,
    "failed": 0,
    "templatesSent": 17,
    "templatesCost": 0.85,
    "currency": "EUR"
  }
}