Webhooks na EngagED 2.0

Entenda todo o poder do webhook no one page checkout e integre milhares de sistemas na EngagED.

1) O que é Webhook?

Webhook é uma solução eficiente que permite que um software envie notificações ou alertas para outro software. Essa tecnologia possibilita a transmissão de informações de forma imediata, assim que um evento específico acontece.

Com webhooks, processos podem ser automatizados e sistemas integrados de maneira eficiente. Por exemplo, ao configurar um webhook na EngagED, detalhes de uma nova compra como nome do cliente, produtos comprados, valor, entre outras informações, podem ser enviados ao seu CRM ou qualquer outro sistema assim que uma compra for concluída, garantindo uma atualização automática e em tempo real.

Na EngagED, você tem a flexibilidade de determinar os momentos exatos em que essas informações serão enviadas para outro software. Abaixo, listamos todos os eventos disponíveis para configuração.

2) Quais eventos estão disponíveis para configuração?

A seguir, apresentamos uma tabela com os eventos que podem ser configurados na sua EngagED. Cada evento está associado a um momento específico de disparo, que será detalhado a seguir.

Nome do Evento	Momento do disparo
purchase.open.payment.waiting_payment	Indica que uma compra permanece no status OPEN enquanto o pagamento está aguardando confirmação (status WAITING_PAYMENT). Esse evento é acionado quando o usuário gera um Boleto ou PIX no Checkout e ainda não finalizou o pagamento.
purchase.refused	Este evento ocorre quando uma compra realizada no Checkout é recusada, especificamente em tentativas de pagamento com Cartão de Crédito. O status REFUSED indica que a transação foi rejeitada pela administradora do cartão ou pelo processador de pagamentos.
purchase.open.payment.canceled	Ocorre quando uma compra no Checkout é cancelada após a geração de um Boleto ou PIX. Isso pode acontecer se o usuário optar por não concluir a transação com o método inicialmente escolhido, retornando ao Checkout para selecionar outro meio de pagamento.
purchase.expired	Este evento ocorre quando uma compra atinge o status EXPIRED devido ao vencimento do prazo de pagamento. Isso é comum em transações por Boleto ou PIX, onde o pagamento não é efetuado antes do vencimento. Quando isso acontece, tanto a compra quanto o pagamento ficam com o status EXPIRED.
purchase.paid	Este evento representa uma compra efetivamente concluída e paga no Checkout, mudando o status da compra para PAID e confirmando o recebimento do valor pelo método escolhido.

3) Quais informações são enviadas nos eventos? Exemplos de Payloads

Os eventos disparados por webhooks na EngagED contêm informações essenciais sobre a transação em questão. Cada evento é acompanhado de um payload em JSON, que é um conjunto estruturado de dados que descreve o estado da compra e outros detalhes relevantes.

Por exemplo, ao ocorrer o evento de "purchase.paid", o payload pode incluir informações como o nome do cliente, os produtos adquiridos, o valor total da compra, a forma de pagamento utilizada e a data da transação. A seguir, apresentamos exemplos de payloads.

Recomendamos pegar como exemplo sempre o payload de evento "purchase.paid" com cupom aplicado, uma vez que ele contém o maior número de informações possíveis para sua parametrização.

4) Como posso receber as informações enviadas por Webhook?

Para receber as informações enviadas por webhooks, é necessário configurar um endpoint em seu Middleware que ficará responsável por escutar as notificações. Esse endpoint deve ser uma URL acessível publicamente, onde o seu sistema poderá receber os dados enviados pela EngagED.

Para ativar seu webhook na EngagED, você deve ter em mãos essa URL e escolher os eventos que deseja monitorar. Quando um evento ocorrer, a EngagED enviará um payload em JSON para o seu endpoint, contendo todas as informações relevantes sobre a transação. É importante garantir que o seu Middlere esteja preparado para processar essas solicitações e responder adequadamente, confirmando o recebimento dos dados.

É bastante comum que as empresas optem por utilizar soluções de Middleware já existentes, em vez de desenvolver uma do zero, o que pode reduzir significativamente a complexidade e o tempo necessário para a implementação. Abaixo deixo algumas sugestões de Middleware que você consegue contratar e sair utilizando em poucos minutos.

Zapier: O Zapier é uma plataforma de automação que permite conectar mais de 5.000 aplicativos populares, como Gmail, Slack, Salesforce e outros, criando fluxos de trabalho automáticos (conhecidos como "Zaps") entre eles. Ele é muito fácil de usar e é altamente indicado para quem deseja uma solução rápida e prática para integrar serviços sem precisar de conhecimento técnico avançado.
Resumo: Muito popular no mercado e fácil de manipular, custos mais altos para automações complexas e baixa customização.
N8N: N8N é uma plataforma de automação de código aberto que permite criar automações complexas e customizáveis entre diferentes serviços. Ao contrário do Zapier, o N8N também pode ser hospedado no seu próprio servidor, o que oferece maior controle sobre dados e fluxos e uma redução significativa de custos. Além disso, permite a inclusão de código JavaScript em fluxos, proporcionando grande flexibilidade.

Resumo: Exige um pouco mais de conhecimento técnico, tem interface menos amigável e um custo menor.

5) Como configurar Webhooks na EngagED?

Antes de configurar os webhooks, é importante verificar se a seu plano EngagED inclui essa funcionalidade. Recomendamos que você entre em contato com o suporte ou converse com seu gerente de contas para confirmar a disponibilidade dos webhooks em seu plano.

Caso seu plano contemple a funcionalidade, basta enviar para suporte@engaged.com.br a sua URL do seu Endpoint e quais os eventos você gostaria de configurar. Feito isso, nossa equipe tem até 48 horas para ativar o webhook.