Skip to main content
Evento = nome do fato (pedido.pago). Seu backend dispara; automações ENABLED com aquele gatilho criam runs. Não confunda com webhooks da Notifique de entrega de canal.

O que é um evento?

É um contrato de nome entre seu sistema e as automações. Você cadastra (opcionalmente com schemaJson), liga automações ao eventName e dispara com Enviar evento.

Evento × webhook da automação × mensagem recebida

Este artigo foca em eventos pela API. Os outros gatilhos configuram-se no editor da automação.

Cadastrar

Escopo: events:write. Rotas na spec Automações e eventos.

Disparar

  • Destinatário: contactId, email ou phone
  • Header Idempotency-Key recomendado
  • Resposta: lista de runs (uma por automação ligada)

Boas práticas

  • Nomes estáveis: order.paid, user_created
  • Payload pequeno (IDs, valores, datas)
  • Um disparo pode acionar várias automações, planeje volume e créditos

Escopos

Próximos passos