Skip to content

Iniciar a automação

POST https://api-mwm.datallog.com/api/start-automation/{project_name}/{automation_name}

Inicia a execução de uma automação pertencente a um projeto do usuário autenticado.
Este endpoint valida o acesso do usuário, o status do projeto e da automação, a validade do plano, o saldo do usuário, a configuração de seed/webhook e, em seguida, dispara o pipeline de execução.

Authentication

Este endpoint requer ambos os headers abaixo.

Authorization: Token <your_token>

x-api-key: <your_x_api_key>

Path Parameters

ParameterTypeDescription
project_namestringNome do projeto do usuário.
automation_namestringNome da automação dentro do projeto.

Request Body (JSON)

O corpo da requisição é opcional, mas pode incluir:

1. webhook (optional)

Sobrescreve ou define um webhook para a execução.

json
{
  "webhook": {
    "url": "https://yourdomain.com/webhook",
    "webhook_header": {
      "Authorization": "Bearer 123",
      "Custom-Header": "ABC"
    }
  }
}

Formatos aceitos:

  • JSON object
  • JSON string

Se Omitido: → O sistema utilizará o webhook padrão da automação, se existir e estiver ativo.


2. seed (optional)

Dados de seed personalizados a serem passados para a execução.

json
{
  "seed": {
    "user_id": 123,
    "filters": ["a", "b"]
  }
}

Ou como string JSON:

json
{
  "seed": "{\"user_id\": 123}"
}

Se omitido: → Nenhum seed será passado, a menos que a execução seja originada por um gatilho agendado.


Validation Rules

A requisição falhará se qualquer uma das condições abaixo ocorrer:

  • Projeto não existe
  • Automação não existe
  • Projeto está inativo
  • Usuário não possui plano ativo
  • Saldo do usuário é insuficiente
  • Automação está desativada
  • Webhook ou seed contém JSON inválido

Success Response (200)

json
{
  "status": "success",
  "message": "Automation <automation_name> started successfully.",
  "execution_id": "<uuid>"
}

Error Responses

403 — Project not found

json
{
  "message": "This Project does not exist. consult API"
}

403 — Automation not found

json
{
  "message": "This Automation does not exist. consult API"
}

400 — Invalid webhook JSON

json
{
  "status": "error",
  "message": "Invalid webhook JSON format"
}

400 — Generic execution error

json
{
  "status": "error",
  "message": "User doesn't have an active plan"
}

Example Request

bash
curl -X POST \
  https://api-mwm.datallog.com/api/start-automation/{project_name}/{automation_name} \
  -H "Authorization: Token <YOUR_TOKEN>" \
  -H "x-api-key: <YOUR_X_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
        "webhook": {
          "url": "https://yourdomain.com/webhook",
          "webhook_header": {
            "Authorization": "Bearer 123"
          }
        },
        "seed": {
          "id": 1,
          "action": "start"
        }
      }'