Webhooks de saída

O QUE SÃO WEBHOOKS DE SAÍDA

Webhooks são chamadas de API automáticas configuradas para serem disparadas para acontecerem após eventos específicos, neste caso dentro do ZionTalk, chamando sistemas externos, é possível atribuir múltiplos gatilhos a um mesmo Webhook, para a criação de novos gatilhos selecione “Adicionar gatilho”:

EVENTOS

Cada gatilho pode ter um Evento determinando quando será disparado, acionando o Webhook em diferentes situações, estes eventos podem ser:

Cada um dos eventos possui um filtro específico para a ação, com exceção de “Contato criado” e “Contato atualizado”:

• Adicionar/remover uma etiqueta de um contato

  • Filtro: A etiqueta que for atribuída/removida

• Adicionar/remover um contato à uma lista

  • Filtro: A lista em que o contato foi adicionado/removido

• Uma mensagem recebida/enviada por um canal

  • Filtro 1: O canal específico que a mensagem foi recebida/enviada

  • Filtro 2: Palavras chaves recebidas na mensagem

(Atenção: Eventos de mensagens são de alto volume - Recomenda-se sempre usar filtros para evitar disparos excessivos e sobrecarga do endpoint)

MÉTODO HTTP E URL DE DESTINO

Após a definição do evento e de filtros, é selecionado o método HTTP e a URL de destino da chamada do Webhook:

Exemplo: Enviando uma requisição para iniciar um workflow do n8n utilizando método POST porque será necessário enviar um conjunto de dados no template :

• POST: envia dados para o servidor processar, geralmente resultando na criação de um novo recurso. É o método mais comum para webhooks de saída.

• PUT: substituí totalmente um recurso existente, ou o cria caso não exista.

• PATCH: atualiza parcialmente um recurso, modificando apenas os campos enviados na requisição.

• GET: solicita a recuperação de um recurso; é seguro e não altera o estado do servidor. Menos usual em webhooks de saída, já que não carrega corpo de dados — use apenas quando o endpoint de destino espera receber os parâmetros pela URL.

CONFIGURAÇÕES AVANÇADAS

Nas configurações avançadas é possível criar Headers para o envio de informações adicionais, como o tipo de conteúdo esperado (Content-Type), dados de autorização, tokens de acesso, idioma e outros parâmetros exigidos pela API externa.

Exemplos comuns de headers: Content-Type: application/json, Authorization: <sua_chave_api>. A chave de API deve ser obtida junto ao sistema de destino, e seu formato (por exemplo, Bearer <token> ou a chave crua) depende do que a API externa exige.

Exemplo: Content-type avisando ao serviço que o corpo da requisição é formatado como JSON, a chave de autorização da API (caso seja necessário, é precis

TEMPLATE DE ENVIO

O corpo do webhook (dados principais a serem enviados), podem ser configurados por meio do “Template JSON”, esse campo aceita algumas variáveis, modificadas com base no tipo de evento selecionado, passando dados específicos de contato ou mensagem:

(É possível selecionar onde no template quer inserir a variável e selecioná-la na lista)

Cada evento possui as seguintes variáveis disponíveis para uso:

• Presentes em todos os evento

  • {{contato.nome}}

  • {{contato.primeiro_nome}}

  • {{contato.telefone}}

  • {{contato.email}}

  • {{contato.etiquetas}}

  • {{contato.empresas}}

  • {{evento.tipo}}

  • {{evento.timestamp}}

• Etiqueta adicionada/removida de contato (Específica deste evento) 

  • {{tag.nome}}

• Contato adicionado/removido de lista (Específica deste evento) 

  • {{lista.nome}}

• Mensagem recebida/enviada (Específicas deste evento) 

  • {{mensagem.texto}}

  • {{mensagem.canal}}

  • {{mensagem.tipo}}

  • {{mensagem.arquivo_nome}}

  • {{mensagem.arquivo_tipo}}

  • {{mensagem.arquivo_url}}