Skip to main content
Automação é um roteiro: quando X acontece, executa passos (enviar, esperar, IA, condição…). Evento é o nome do fato. Execução (run) é cada vez que o roteiro roda para uma pessoa.

​
O que são Automações na Notifique?

É o motor de jornadas: você monta um grafo de passos no painel ou pela API. Quando o gatilho dispara, nasce uma run que percorre envio de template, delay, assistente IA, atualização de contato, etc. Você pode:
  • Disparar por evento da sua API (pedido_pago, user.created)
  • Receber webhook HTTP de ferramentas externas (Zapier, ERP)
  • Reagir a mensagem recebida no canal (WhatsApp, SMS, widget…)
  • Reagir a fases de chamada WhatsApp outbound (concluída, desligada, sem resposta…)
  • Consultar execuções e auditar o que aconteceu
Pense num roteiro de teatro: o gatilho levanta a cortina; cada passo é uma cena.

​
Não confunda: mapa dos conceitos

Campanha (aba Contatos) = disparo em lote uma vez. Automação = sequência repetível quando o gatilho dispara de novo.
Webhook da automação (inicia o fluxo) ≠ webhook da Notifique (avisa entrega de SMS, status de mensagem, etc.). Veja Webhooks nos Guias.

​
Quatro formas de disparar

​
Gatilho whatsappCall

No editor: Chamada WhatsApp. No grafo:
Fases: initiated · answered · completed · hung_up · failed · no_answer · rejected.
  • completed: o áudio/fala terminou (par com webhook whatsapp.call.completed).
  • hung_up: alguém desligou no meio (par com whatsapp.call.hung_up).
O payload da run inclui callId, to / toE164, status, hangupReason, durationSecs, type, instanceId, direction: OUTBOUND. Idempotência por (automação, callId, callPhase).

​
Gatilho channelInbound no chat do site (WEB_WIDGET)

Para automações no widget do site, use triggerKind: "channelInbound" com channel: "WEB_WIDGET". O passo sendWebWidget responde no mesmo chat e só é permitido com esse gatilho.
webWidgetId opcional: omitir ou null = qualquer widget do workspace.

​
Condição de horário (schedule)

Na condição, fonte Horário comercial: fuso IANA, dias da semana e janela HH:mm. Ramo true se “agora” estiver dentro da janela; false caso contrário (útil para inbound fora do horário).

​
Passos comuns no grafo

Status da automação: ENABLED (dispara) ou DISABLED (não dispara). POST /v1/automations//stop desativa a automação (DISABLED) e cancela runs ativas (QUEUED / RUNNING) — escopo automations:write.

​
O que está na API v1

Rotas com prefixo /v1/ e autenticação por API Key (sk_live_... / sk_test_...):
  • Eventos, cadastrar e disparar (events:read, events:write)
  • Automações, grafos, parar fluxo, listar execuções (automations:read, automations:write)
Referência completa na spec Automações e eventos no menu lateral.
Cada API Key pertence a um workspace. Na v1 não envie x-workspace-id. Use Idempotency-Key ao disparar evento.

​
Painel (fora da API v1)

Base de conhecimento, assistentes e integrações MCP configuram-se no painel (Automações → Bases, Assistentes, MCP). Não há rotas /v1/ públicas para isso nesta documentação, use os guias Assistentes, Base de conhecimento e Integrações MCP.

​
Quando usar?

Funciona muito bem para sequência após evento, chatbot e follow-up (esperar + segunda mensagem). Para envio único sem repetir, use template ou API do canal.

​
Próximos passos