Skip to main content

Para que serve

Automação é o jeito de dizer ao Notifique: “quando isto acontecer, faça aquela sequência” — por exemplo mandar e-mail de boas-vindas, esperar alguns dias e mandar outro lembrete, ou escolher um caminho diferente se o cliente for plano A ou B. Você monta o roteiro (no painel ou pela API). Quando o gatilho dispara, o sistema cria uma execução e vai seguindo os passos: envios, esperas, condições, atualizar contato, encerrar um ramo, etc. Assim você não precisa reimplementar fila, retry e acompanhamento na mão para cada jornada.

Por que isso importa

  • Menos trabalho repetido — cadastro, pagamento, onboarding: o mesmo padrão de avisos sai do motor, não de um script solto.
  • Um lugar só — o mesmo fluxo que você desenha no painel pode ser criado ou ajustado pela API, se a equipe preferir versionar em código.
  • Visibilidade — cada disparo gera execuções que dá para listar e abrir: o que já rodou, o que falhou, quando — útil para suporte e auditoria.

Em três ideias (sem se perder no jargão)

  1. Evento — um nome para o fato que aconteceu no seu produto (user.signed_up, order.paid…). Opcionalmente você define quais campos o disparo deve trazer, para barrar payload errado.
  2. Automação — o grafo: começa no gatilho (esse evento ou uma mensagem recebida em WhatsApp, Telegram ou SMS), depois os passos em sequência. Pode ficar ligada ou pausada.
  3. Execução (run) — cada vez que alguém dispara o evento (ou chega a mensagem que casa com o gatilho), nasce uma corrida daquele roteiro para aquele destinatário.

O que você pode fazer no painel

Editor visual do fluxo, ligar e desligar automações, ver execuções e configurar gatilhos por mensagem recebida nos canais, quando fizer sentido para o seu negócio.

O que você pode fazer por integração (API)

Cadastrar eventos, criar e atualizar automações, disparar (POST /v1/events/send), parar uma automação com esforço de cancelar o que ainda não rodou, e ler listas e detalhes de execuções. A chave de API já está ligada a um workspace — não envie x-workspace-id na API v1. Os caminhos exatos, campos e códigos de erro estão no OpenAPI de automações.

Disparo mais comum

Seu backend chama o envio de evento com nome do evento, quem é o destinatário (contato, e-mail ou telefone) e dados (payload). O servidor valida o que você definiu, acha o contato e cria uma execução por automação habilitada que escuta aquele nome. Para não duplicar jornada em retry de rede, use Idempotency-Key nesse disparo.

Gatilho por mensagem (resumo)

Além do evento vindo da sua API, dá para iniciar fluxo quando chega mensagem em WhatsApp, Telegram ou SMS. O roteiro (espera, envio, condição…) reutiliza os mesmos tipos de passo; mudam o começo e os dados iniciais da execução. Condições nesse modo olham o texto recebido. O Quick Start traz referência rápida a condições e encerramento de ramo; o OpenAPI e o painel fecham o detalhe de cada campo.

Alguns detalhes que evitam surpresa

  • Várias automações no mesmo evento — um disparo pode gerar várias execuções se mais de uma jornada “escutar” o mesmo nome de evento. Planeje volume e custo dos canais.
  • Pausar com força — existe rota para desligar a automação e tentar cancelar o que ainda não rodou (abordagem best-effort; o que já terminou fica no histórico).
  • Condição no grafo — todo passo do tipo “se / senão” precisa de dois caminhos explícitos (verdadeiro e falso). Dá para aninhar várias decisões em sequência.

Escopos (o que pedir na chave)

  • events:read / events:write — cadastro de eventos e disparo.
  • automations:read / automations:write — automações, parar, listar e ver execuções.
Quem envia e-mail ou WhatsApp dentro do fluxo ainda precisa das permissões de envio daqueles canais na mesma conta (como nos envios normais de template).

Próximos passos


Resumo em uma frase (para colar em outro lugar)

Automações no Notifique ligam “algo aconteceu no meu sistema ou no canal” a uma sequência de passos (avisos, esperas, ramificações), com painel e API no mesmo motor e execuções que dá para acompanhar.