Voltar para Documentação

Webhooks

Integre sua aplicação em tempo real com notificações automáticas de eventos

O que são Webhooks?

Webhooks são notificações HTTP automáticas enviadas em tempo real quando eventos específicos ocorrem no sistema. Ao invés de consultar o sistema de tempos em tempos, você recebe os dados instantaneamente quando algo acontece.

Tempo Real

Notificações instantâneas quando eventos ocorrem

Escalável

Elimina a necessidade de polling constante

Histórico

Cada execução fica registrada com status e resposta

Configuração

1Criar um Endpoint

Crie um endpoint HTTPS em seu servidor que receberá as requisições:

https://seu-servidor.com/webhooks

2Registrar o Webhook

No painel, navegue até Configurações → Integrações → Webhooks e clique em "Adicionar Webhook":

  • Defina um nome descritivo
  • Escolha o método HTTP
  • Insira a URL do seu endpoint (deve começar com https://)
  • Selecione os eventos que deseja receber
  • Configure headers personalizados se necessário (ex.: um token para validar a origem da chamada)

3Responder às Requisições

Seu endpoint deve responder com um status 2xx. Cada chamada fica registrada no histórico do webhook, com o status e a resposta do seu servidor.

Eventos Disponíveis

Ao criar o webhook, selecione quais destes eventos ele deve receber:

Contatos

Contato Criado

Disparado quando um novo contato é criado

Contato Atualizado

Disparado quando um contato é atualizado

Contato Deletado

Disparado quando um contato é removido

Campanhas

Campanha Enviada

Disparado quando uma campanha é enviada

Campanha Iniciada

Disparado quando uma campanha é iniciada

Campanha Concluída

Disparado quando uma campanha termina

Emails

Email Entregue

Disparado quando um email é entregue

Email Aberto

Disparado quando um email é aberto

Email Clicado

Disparado quando um link no email é clicado

Email Rejeitado

Disparado quando um email é rejeitado

Email Descadastrado

Disparado quando um contato se descadastra

Automações

Entrada na Automação

Disparado quando um contato entra em uma automação

Automação Concluída

Disparado quando um contato completa uma automação

Saída da Automação

Disparado quando um contato sai de uma automação