ARararahq
Automações

Listar automações

Changed on

Todas as automações da organização, sem paginação. Exige plano com recuperação de receita. Permissão: READ.

get/v1/automations

Request

Response

Automações

idstring uuid required
namestring required
triggerstring required
triggerConfigobject nullable
activeboolean required

false na criação. Mude em PUT /v1/automations/{id}/active.

costPerRunBrlnumber required

Custo estimado, em reais, de cada pessoa que entrar na automação.

webhookUrlstring nullable

URL que o seu sistema precisa chamar, quando o gatilho depende disso.

Example response

[
  {
    "id": "3d5a1f0c-6b2e-4c8d-9a41-0e1f2a3b4c5d",
    "name": "Lembrete de carrinho",
    "trigger": "cart.abandoned",
    "triggerConfig": null,
    "active": false,
    "steps": [
      {
        "id": "b2f0c1de-1a2b-4c3d-8e4f-5a6b7c8d9e0f",
        "type": "wait",
        "config": {
          "minutes": 60
        }
      },
      {
        "id": "c7a1e2d3-4b5c-4d6e-9f70-8a9b0c1d2e3f",
        "type": "message",
        "config": {
          "templateId": "0b8f6c1e-7a52-4a1b-9a0e-3f2d6c9e1a44",
          "variables": [
            "nome"
          ]
        }
      }
    ],
    "costPerRunBrl": 0.38,
    "stats": {
      "runsLast30Days": 0,
      "inFlight": 0,
      "completed": 0,
      "stopped": 0
    },
    "webhookUrl": null,
    "hook": null
  }
]

Changes