Webhook é uma tecnologia utilizada para permitir a comunicação entre duas aplicações e enviar notificações quase em tempo real. O envio ou o recebimento de dados é disparado quando determinado evento acontecer em uma das aplicações.

O que é um webhook?

Um webhook é uma função de callback baseada em HTTP que viabiliza a comunicação entre duas interfaces de programação de aplicações (APIs). Os webhooks são usados por várias web apps para receber pequenos volumes de dados de outras aplicações e também podem ser usados para acionar workflows de automação em ambientes GitOps.

Uma API é um conjunto de definições e protocolos usado no desenvolvimento e na integração de aplicações. As APIs web usam HTTP para solicitar dados de outras aplicações e definir a estrutura das mensagens de resposta, que normalmente são enviadas em um arquivo XML ou JSON.

Quando uma API cliente solicita dados de uma API servidor, ela está chamando para verificar a ocorrência de um evento específico, ou seja, se os dados do servidor mudaram e podem ser úteis ao cliente. Nesse processo (conhecido como pesquisa), o cliente envia uma solicitação HTTP em intervalos regulares até a API do servidor enviar os dados relevantes, às vezes chamados de payload.

No entanto, o servidor só enviará os dados solicitados quando as informações estiverem disponíveis. A aplicação cliente precisa continuar pedindo pela atualização e espera até a ocorrência do evento relevante.

Para configurar um webhook, o cliente oferece uma URL exclusiva para a API servidor e especifica sobre qual evento ele quer as informações. Quando o webhook estiver configurado, o cliente não precisará mais das pesquisas. O servidor enviará automaticamente o payload relevante para o URL do webhook do cliente quando o evento especificado ocorrer.

Em geral, os webhooks são descritos como APIs reversas ou APIs de push, porque colocam a responsabilidade da comunicação no servidor, e não no cliente. Em vez de o cliente enviar as solicitações HTTP pedindo os dados até receber uma resposta, o servidor envia para o cliente uma solicitação HTTP POST exclusiva quando os dados estiverem disponíveis.

Como funciona um webhook?

O funcionamento de um webhook pode ser resumido nos seguintes passos:

• O cliente se registra no servidor, fornecendo uma URL exclusiva e um evento de interesse.
• O servidor armazena a URL e o evento do cliente em um banco de dados ou em uma fila de mensagens.
• Quando o evento ocorre no servidor, ele envia uma solicitação HTTP POST para a URL do cliente, contendo o payload com os dados relevantes.
• O cliente recebe a solicitação HTTP POST e processa o payload de acordo com a sua lógica de negócio.
• O cliente pode enviar uma resposta HTTP para o servidor, confirmando o recebimento do payload ou informando algum erro.

Um exemplo de webhook é o envio de uma notificação por e-mail quando alguém faz um comentário em um blog. Nesse caso, o cliente é o dono do blog, o servidor é a plataforma de hospedagem do blog e o evento é o comentário. O cliente se registra no servidor, fornecendo uma URL exclusiva e o evento de comentário. O servidor armazena a URL e o evento do cliente. Quando alguém faz um comentário no blog, o servidor envia uma solicitação HTTP POST para a URL do cliente, contendo o payload com os dados do comentário. O cliente recebe a solicitação HTTP POST e processa o payload, enviando um e-mail para o dono do blog com o conteúdo do comentário. O cliente pode enviar uma resposta HTTP para o servidor, confirmando o recebimento do payload ou informando algum erro.

Onde é aplicado um webhook?

Um webhook pode ser aplicado em diversos cenários que envolvam a comunicação entre aplicações e a necessidade de receber dados em tempo real. Alguns exemplos são:

• Integração entre serviços de pagamento e e-commerce: um webhook pode ser usado para notificar o e-commerce sobre o status de uma transação, como aprovada, recusada ou estornada.
• Integração entre serviços de e-mail marketing e CRM: um webhook pode ser usado para atualizar o CRM sobre o comportamento dos leads, como abertura, clique ou descadastro de um e-mail.
• Integração entre serviços de automação e plataformas de rede social: um webhook pode ser usado para disparar uma ação de automação, como enviar uma mensagem ou publicar um post, quando alguém mencionar uma marca ou uma hashtag em uma rede social.
• Integração entre serviços de monitoramento e alerta: um webhook pode ser usado para enviar uma notificação para um canal de comunicação, como Slack ou Telegram, quando ocorrer algum problema em um sistema ou aplicação.
• Integração entre serviços de versionamento e deploy: um webhook pode ser usado para acionar um workflow de automação, como testar, construir e implantar um código, quando alguém fizer um commit ou um pull request em um repositório.

Quais são as vantagens de um webhook?

Um webhook oferece diversas vantagens em relação à comunicação tradicional entre aplicações, como:

• Redução do consumo de recursos: um webhook evita que o cliente faça pesquisas desnecessárias e consuma recursos como banda, memória e processamento. O cliente só recebe os dados quando eles estiverem disponíveis e forem relevantes.
• Aumento da velocidade e da eficiência: um webhook permite que o cliente receba os dados quase em tempo real, sem precisar esperar por intervalos de tempo ou por respostas vazias. O cliente pode processar os dados rapidamente e tomar as ações necessárias.
• Melhoria da experiência do usuário: um webhook possibilita que o usuário tenha acesso a informações atualizadas e confiáveis, sem precisar recarregar a página ou verificar manualmente as novidades. O usuário pode interagir com as aplicações de forma mais dinâmica e satisfatória.

Quais são os desafios de um webhook?

Um webhook também apresenta alguns desafios que devem ser considerados, como:

• Segurança dos dados: um webhook envolve o envio de dados sensíveis entre aplicações, o que pode gerar riscos de interceptação, adulteração ou vazamento. É preciso adotar medidas de segurança, como criptografia, autenticação e validação dos dados.
• Confiabilidade da comunicação: um webhook depende da disponibilidade e da estabilidade das aplicações e da rede, o que pode gerar falhas de conexão, perda de dados ou atrasos na entrega. É preciso implementar mecanismos de tolerância a falhas, como reenvio, confirmação e registro dos dados.
• Complexidade da integração: um webhook requer a compatibilidade e a padronização das aplicações e dos dados, o que pode gerar dificuldades de integração, manutenção e escalabilidade. É preciso seguir boas práticas de desenvolvimento, documentação e teste dos webhooks.

Conclusão

Webhook é uma tecnologia que permite a comunicação entre aplicações e o envio de notificações quase em tempo real. Um webhook é uma função de callback baseada em HTTP que é disparada quando um evento ocorre em uma das aplicações. Um webhook oferece vantagens como redução do consumo de recursos, aumento da velocidade e da eficiência e melhoria da experiência do usuário. Um webhook também apresenta desafios como segurança dos dados, confiabilidade da comunicação e complexidade da integração.

Webhook é uma ferramenta poderosa e inovadora que pode facilitar o desenvolvimento, a integração e a automação de aplicações. Se você quiser saber mais sobre webhook, você pode visitar o site oficial do Webhook.site ou ler alguns artigos sobre ele. Espero que este artigo tenha sido útil para você. 

Bibliografias

• Webhook: o que é e para que servem webhooks? - Red Hat
• Webhook: o que é? Como funciona? Diferenças entre API - GUIA
• O que é webhook: entenda tudo sobre o recurso - iugu