Corvex API

Automações enviam mensagens quando algo acontece na loja: PIX gerado, pagamento confirmado, carrinho abandonado, lead novo, rastreio atualizado, e-mail recebido ou eventos de assinatura. O fluxo é o JSON { name, trigger_event, steps, active }. Você monta no painel ou pela API v1 (cvx_live_...). Automações criadas pela API nascem desativadas (active: false) até alguém ligar. Use o builder e os templates para montar o JSON.

Páginas

Criar e editar

Intenção → plano → JSON, etapas, preview e validação.

Templates

E-mail, SMS e WhatsApp com metatags válidas.

Triggers

Quando cada gatilho dispara e quais dados vêm junto.

Steps, actions e conditions

Tipos de passo, operadores (= e não equals) e actions.

Metatags

Variáveis {{categoria.campo}} por gatilho.

Execução

Quando corre, duplicidade, falhas e como diagnosticar.

Regras para IA

Contrato para a LLM operar como automation builder.

Como funciona (visão de uso)

Um evento ocorre (pagamento, PIX, carrinho, etc.).
Só correm automações da mesma loja, com o mesmo trigger_event e active: true.
Conditions decidem o ramo. Metatags {{chave}} são preenchidas no envio; chave sem valor vira texto vazio.
Actions enviam a mensagem, disparam o webhook ou criam o cupom.
O painel mostra se a execução concluiu, falhou ou foi bloqueada (por exemplo, falta de créditos).

Campos da automação

Campo	Tipo	Obrigatório	Notas
`id`	UUID	gerado	Não envie na criação
`name`	string	sim	3–100 caracteres
`trigger_event`	string	sim	Um dos 14 gatilhos
`steps`	JSON	sim	1–50 passos
`active`	boolean	opcional	Painel: default `true`. API v1: criar sem `active` nasce `false`. `false` não executa
`created_at`	datetime	gerado

Não há draft, paused ou archived. Pausar = active: false. Excluir a automação no painel remove o fluxo.

Exemplo mínimo válido

{
  "name": "Recuperação PIX",
  "trigger_event": "pix.generated",
  "active": true,
  "steps": [
    {
      "type": "delay",
      "minutes": 30,
      "nextId": "send-1"
    },
    {
      "id": "send-1",
      "type": "action",
      "name": "send_whatsapp",
      "data": {
        "type": "text",
        "message": "Olá {{customer.name}}, seu PIX ainda está aberto: {{order.pix_code}}"
      }
    }
  ]
}

Válido: gatilho existe, nome no tamanho certo, delay entre 1 e 10080 minutos, WhatsApp com mensagem, metatags disponíveis em pix.generated.

Exemplo inválido

{
  "name": "Pedido enviado",
  "trigger_event": "order.shipped",
  "steps": [
    {
      "type": "action",
      "name": "send_email",
      "data": {
        "subject": "Saiu",
        "body": "Status {{order.status}}"
      }
    }
  ]
}

Inválido: order.shipped não existe; e-mail exige nome e e-mail do remetente. Para rastreio use tracking_code_updated.

Exemplos comuns

PIX gerado → espera → WhatsApp

Use o exemplo mínimo. {{order.pix_code}} é o copia-e-cola; {{order.url_pix_gerado}} é a página de pagamento. O QR em HTML ({{order.pix_qr_code}}) vale no e-mail.

Carrinho abandonado → SMS

{
  "name": "Carrinho abandonado SMS",
  "trigger_event": "cart.abandoned",
  "active": true,
  "steps": [
    {
      "type": "condition",
      "field": "lead.phone",
      "operator": "not-empty",
      "if_true": [
        {
          "type": "action",
          "name": "send_sms",
          "data": {
            "message": "Oi {{lead.name}}, volte ao checkout: {{cart.url_checkout}}"
          }
        }
      ]
    }
  ]
}

O limite de 160 caracteres do SMS vale no texto salvo. Depois da substituição, a URL pode deixar a mensagem mais longa.

Pagamento confirmado → e-mail

{
  "name": "Obrigado pelo pagamento",
  "trigger_event": "payment.confirmed",
  "active": true,
  "steps": [
    {
      "type": "action",
      "name": "send_email",
      "data": {
        "remetente_nome": "Loja",
        "remetente_email": "loja@example.com",
        "subject": "Pagamento confirmado",
        "body": "Olá {{customer.name}}, recebemos {{order.total}}."
      }
    }
  ]
}

Código de rastreio → WhatsApp

{
  "name": "Código de rastreio",
  "trigger_event": "tracking_code_updated",
  "active": true,
  "steps": [
    {
      "type": "action",
      "name": "send_whatsapp",
      "data": {
        "type": "text",
        "message": "Seu pedido saiu: {{tracking.code}} — {{tracking.url}}"
      }
    }
  ]
}

Não existe gatilho “pedido enviado”. O evento é a atualização do rastreio.

Autenticação da API pública

Authorization: Bearer cvx_live_...
X-Store-Id: UUID-DA-LOJA

Uso	Método	Escopo
Metatags	`GET /api/v1/automation/metatags`	`automations:read`
Validar JSON (não salva)	`POST /api/v1/automations/validate`	`automations:read`
Listar / obter	`GET /api/v1/automations`	`automations:read`
Criar / editar / excluir	`POST` `PATCH` `DELETE /api/v1/automations`	`automations:write`
Templates	`/api/v1/automation/templates`	read lista; write cria

POST /api/v1/automations sem active grava desativada. Para disparar mensagens, envie PATCH com "active": true depois de revisar.

Visão geral

Fundamentos

Checkout externo

Catálogo

Pedidos e entrega

Clientes

Marketing

Webhooks

Automações

Automações Corvex

Páginas

Criar e editar

Templates

Triggers

Steps, actions e conditions

Metatags

Execução

Regras para IA

Como funciona (visão de uso)

Campos da automação

Exemplo mínimo válido

Exemplo inválido

Exemplos comuns

PIX gerado → espera → WhatsApp

Carrinho abandonado → SMS

Pagamento confirmado → e-mail

Código de rastreio → WhatsApp

Autenticação da API pública

​Páginas

Criar e editar

Templates

Triggers

Steps, actions e conditions

Metatags

Execução

Regras para IA

​Como funciona (visão de uso)

​Campos da automação

​Exemplo mínimo válido

​Exemplo inválido

​Exemplos comuns

​PIX gerado → espera → WhatsApp

​Carrinho abandonado → SMS

​Pagamento confirmado → e-mail

​Código de rastreio → WhatsApp

​Autenticação da API pública

Páginas

Como funciona (visão de uso)

Campos da automação

Exemplo mínimo válido

Exemplo inválido

Exemplos comuns

PIX gerado → espera → WhatsApp

Carrinho abandonado → SMS

Pagamento confirmado → e-mail

Código de rastreio → WhatsApp

Autenticação da API pública