Tech para pessoas de produto - Webhooking

Webhookings são largamente utilizados atualmente em sistemas web que precisam receber informações específicas de outros sistemas web. O termo webhook se deriva do termo hook, que na tradução livre em português pode ser gancho, anzol, cabide e alguns outros nomes.

De acordo com a wikipedia, a definição de hook é a seguinte:

Em programação de computadores, o termo hooking (em português, "enganchar") cobre uma série de técnicas utilizadas para modificar ou melhorar o comportamento de um sistema operacional, aplicações ou outros componentes de software através da interceptação de chamadas de funções, mensagens ou eventos passados entre componentes de software. O código que manipula tais chamadas de funções, mensagens ou eventos interceptados é chamado de "hook" (gancho).

Traduzindo essa definição, pra você que é das antigas, certamente já viu essa tela ao fazer algum download no falecido Internet Explorer

Geralmente quando íamos baixar uma música, programa para o windows ou algum filme pirata (isso foi nos anos 2000 receita federal 😀, já foi hein haha), a internet estava cheia de programas maliciosos e nessa época o Avast salvava a vida. Até o próprio Avast a gente tentava crakear (crake era um programa que quebrava as licenças dos softwares) para ter a versão profissional. Velhos tempos, hoje vivemos na economia da recorrência.

O ponto aqui é, para que o Avast conseguisse saber que um Download começou a ser realizado, ele "escutava" um hook criado no navegador. Trazendo para nossa linguagem é como se o navegador falasse mais ou menos assim "Ei quem está ouvindo, estou iniciando um download!". Com isso, todos os programas que estavam ouvindo esse hook, recebiam essa mensagem e podiam então interceptar o arquivo que estava sendo baixado.

No caso do Avast, ele podia analisar o arquivo e entender se era malicioso ou não e já bloqueá-lo e deletá-lo. Sem existir um hook, seria algo difícil de acontecer em tempo real. Você descobriria que baixou um arquivo malicioso somente se fizesse uma varredura em todos os seus arquivos e pra quem lembra, isso podia demorar uma noite toda.

Então, se a gente abstrair, um hook é realmente um anzol, mas que não "pesca" qualquer peixe, só aqueles que "gostam" do tipo de presa que está ali. É como pedir para quem faz o almoço te avisar quando o almoço estiver pronto, é algo específico que uma aplicação quer saber.

Então Webhooks

Agora que entendemos o que é um hook, um webhook é então um hook trafegado pela internet e não dentro da mesma aplicação ou sistema operacional. Por isso, o sufixo web.

Isso significa que um webhook permite que uma aplicação receba mensagens de outras aplicações via internet, utilizando um protocolo HTTP (vamos falar sobre o que são protocolos da internet em outro texto).

Para ilustrar, vamos entender como identificamos pagamentos via PIX nas assinaturas do Product Oversee. Nós usamos a Stripe para receber pagamentos e eles ainda não têm suporte nativo para PIX em assinaturas. Dessa maneira, criamos uma "pequena" gambiarra, onde, para receber um pagamento via PIX, vendemos um produto com o valor da assinatura e controlamos a recorrência do nosso lado (ruim, mas a vida real é essa 😀).

Como o pagamento é feito num checkout da Stripe diferente do checkout que usamos em nosso sistema, nossa aplicação precisa saber quando um pagamento acontece na Stripe, identificar se o pagamento foi feito via PIX e então criar a assinatura no membro que realizou o pagamento.

Para isso, precisamos fazer duas coisas: 1) criar um webhook em nossa aplicação e 2) cadastrar esse webhook lá no portal de administração da Stripe e dizer para a Stripe quando ela deve enviar mensagens para esse webhook e qual o conteúdo dessas mensagens.

O passo 1) envolve escrever código, mas o objetivo desse texto não é ensinar programação, então não vou mostrar códigos aqui. Em suma, para a aplicação que manda a mensagem, o webhook é nada mais nada menos que um endpoint de uma API ou em outras palavras, um endereço específico da sua aplicação.

O mais importante é entender o que você está querendo modelar com esse código. Para nosso cenário, queremos saber se um pagamento via PIX foi feito na Stripe e quem realizou esse pagamento para que então a gente crie de maneira automática uma assinatura para a pessoa que comprou.

Sendo assim, nosso webhook precisa receber informações sobre pagamentos realizados na Stripe, incluindo o email e nome de quem pagou, o valor e o método de pagamento utilizado. Para nossa sorte, a Stripe tem suporte para webhooks e especificamente para enviar mensagens com esses dados de pagamento.

A aplicação que manda as mensagens para um webhook naturalmente não terá suporte para enviar mensagens para todos os eventos que acontecem na aplicação. Eventos são basicamente acontecimentos, como por exemplo, pagamento realizado com sucesso ou com falha.

A Stripe, por ter muito foco em desenvolvedores, tem uma lista extensa de eventos que são capazes de disparar mensagens para webhooks e para o nosso caso, queríamos que a mensagem fosse enviada quando um pagamento de fato fosse completado com sucesso. Para isso selecionamos o evento da imagem a seguir

Esse evento basicamente acontece quando um pagamento está finalizado e com sucesso. A mensagem que vai para nossa aplicação contém todos os dados que precisamos e mais alguns que podemos ignorar porque não vamos utilizar. Depois de selecionar os eventos que fazem com que a Stripe nos envie mensagens, só precisamos dizer pra ela pra onde mandar e pronto.

Como eu disse, o webhook é um endereço da internet ou como está na Stripe um Endpoint URL, o qual a Stripe vai bater quando o evento que selecionamos acontecer. Sim, toda vez que um pagamento acontecer com sucesso.

Seria ótimo só mandar uma mensagem para o nosso webhook quando um pagamento por PIX acontecesse, mas a Stripe não tem suporte para filtrar os eventos de pagamento por métodos de pagamento, então a missão de ignorar qualquer pagamento que não tenha sido feito com PIX fica para nossa aplicação via código.

Então, basicamente o que fizemos foi ler a mensagem de um pagamento que a Stripe nos manda, entender se ela foi feita com PIX e se não, ignorar todo o resto do código e não processar mais nada e se sim, encontrar o membro que pagou a partir do email que veio na mensagem e criar uma assinatura que a pessoa comprou. E pronto, não precisamos ficar olhando o email e criando assinaturas a mão toda vez que tiver um pagamento via PIX.

Bem últil, não?

Eu aprendi a aceitar

Eu iniciei minha carreira como programador. Tem um monte de coisa na programação que eu entendi o resultado final mas nunca entendi como funciona com todos os detalhes. Aceitar e parar de querer entender como tudo funciona foi o que me fez conseguir evoluir na escrita de código. Então, aceitem :D

Eu tentei aqui deixar o mais didático e no bom português possível. Como pessoa de produto, entender mais de tecnologia, não necessariamente saber programar, é algo que pode te ajudar muito no dia a dia a não ficar boiando em uma conversa com as pessoas que desenvolvem. E em alguns cenários mais técnicos, fazer as coisas andarem de maneira mais fluida.

Se você quiser saber sobre outros termos tecniquês de maneira mais didática, por favor, deixe seu comentário aqui. Até a próxima!

Referências