A Transfeera não realiza empréstimos financeiros. Em caso de dúvidas, fale com nossa ouvidoria.

Tecnologia
Webhook: o que é, como funciona e como criar um

Webhook: o que é, como funciona e como criar um

Muito provavelmente você já viu ou até utiliza aplicações com integração via webhook. O termo surgiu em 2007 e foi cunhado por Jeff Lindsay, a partir de uma palavra usual na programação de computador: hook, que significa “gancho” em português.

Assim como as APIs, os webhooks permitem que diferentes sistemas se comuniquem entre si e compartilhem informações. A seguir, entenda melhor como eles funcionam e quais os seus benefícios.

O que é webhook?

Um webhook é um recurso que possibilita que um sistema, ferramenta ou aplicativo se comunique com outro sistema, ferramenta ou aplicativo e troque dados entre si. Essa troca ocorre em tempo real e sempre que um evento qualificado acontece.

Graças a essa tecnologia é que um usuário recebe notificações quando algo novo se passa em seu sistema. Por essa razão, webhooks são também conhecidos por “retorno de chamada web” (ou HTTP e, ainda, impulso API).

Como funciona um webhook?

Um webhook reproduz automações pré-estabelecidas em sistemas ou ferramentas de chegadas. Sempre que ocorrer o gatilho que foi definido, a tecnologia notifica o usuário e executa a ação que foi também previamente programada.

Com relação aos dados, eles saem de um aplicativo X e vão para um aplicativo Y que os manipula. Vale destacar ainda que essa troca de informação acontece na web via um webhook URL.

Para melhor compreender, pense em um número de telefone. O aplicativo ou sistema receptor fornece o webhook URL, que seria como o número que o outro aplicativo ou sistema precisa ligar sempre que há um evento.

Também é importante entender que os dados fornecidos pelo webhook podem ter três formatos:

  • JSON
  • XML
  • Dados de formulários (application / x-www-form-urlencoded ou multipart/form-data)

Quais os benefícios do webhook?

Os webhooks podem trazer vários benefícios, como informações em tempo real de que um evento ocorreu e a sincronização dos dados. À lista acrescentamos também vantagens como:

Eficiência

Com webhooks, os dados são facilmente transferidos para outros sistemas ou aplicativos sem que para isso haja a necessidade de configurar processos trabalhosos. Também não existe o risco de que alguma informação importante se perca no caminho.

As transferências de informações, por serem feitas instantaneamente, aumentam a eficiência dos processos, pois tira a dependência do usuário de ter que verificar dados manualmente.

Automação

Conforme explicamos, com um webhook é possível criar eventos acionados por um gatilho. Em outras palavras, procedimentos específicos de transferência de informações podem ser facilmente automatizados.

Por exemplo, é possível automatizar sistemas de alerta nos quais o evento acionador é a loja virtual receber uma confirmação de pagamento sempre que um cliente concluir uma compra.

Menos configuração

Webhooks não utilizam uma imensa quantidade de códigos complexos, o que torna a configuração mais rápida e simples. Além disso, como eles normalmente utilizam HTTP, que já é um protocolo usado pela maioria dos sites, adicionar um webhook a um aplicativo não é algo que exija muito tempo e nem esforço.

Diferença entre webhook x API REST?

A principal diferença entre uma webhook e uma API REST é que a primeira tecnologia é orientada a eventos. Isso acontece pois webhooks são um endpoint HTTP, no qual o usuário recebe notificações em tempo real dos eventos que ocorrem em um servidor.

Já uma API é o conjunto de regras e métodos com os quais podemos comunicar e usar esse serviço. Ou seja, é uma maneira de interagir com o webhook.

Em termos práticos, webhooks podem utilizar APIs do tipo REST, GraphQL, entre outras.

Como criar um webhook?

Para melhor ilustrar, mostraremos como criar webhook na Transfeera. Até o momento, só é possível ter uma URL inscrita por tipo de evento (campo object_types na API de registro de URLs de webhooks).

Todos os eventos são enviados através de uma requisição HTTP/HTTPS POST com o formato JSON no payload.

Seu endpoint precisa retornar um status code de sucesso na resposta, sendo (2xx) um formato válido e, assim, consideraremos como entregue. Caso contrário, tentamos entregar a notificação mais 2 vezes. Depois disso, não há mais tentativas de entregas da notificação deste evento.

Os eventos que podem ser criados são:

  • Transfer: webhook contendo atualização de informações de uma transação de pagamento
  • TransferRefund: webhook contendo atualização de informações sobre uma devolução de transação de pagamento
  • CashIn: webhook contendo atualização de informações sobre um recebimento Pix
  • CashInRefund: webhook contendo atualização de informações sobre uma devolução recebimento Pix
  • PixKey: webhook contendo atualizações de status de chaves Pix

Para mais informações, consulte a documentação.

Fatores para considerar ao criar um webhook

Ao criar um webhook, leve em consideração fatores como:

  • Segurança de dados: já que um webhook transmite dados de um ponto A ao B, é fundamental que esses mesmos dados sejam protegidos de invasores e hackers e que não se corrompam no caminho.
  • Recebimento e armazenamento de dados: os webhooks devem ter um mecanismo de armazenamento de informações, o qual deve ser do tipo push. Também devem ter um mecanismo de recebimento de dados.
  • Manipulação e escalabilidade: a tendência é que cada vez mais dados sejam agregados. Isso exige que webhooks sejam escaláveis, pois somente assim eles possibilitam a manipulação correta das informações.

Empresas que utilizam webhooks

A Transfeera, uma instituição de pagamentos que fornece soluções para outras empresas, é um exemplo de empresa que oferece o webhook para seus clientes. Por exemplo, em uma transferência, o webhook é acionado assim que ela é realizada. Ou seja, nossos clientes são notificados sempre que há uma entrada de dinheiro.

Sem uma webhook essa informação não aconteceria em tempo real. Seria necessário que alguém do financeiro consultasse o sistema da Transfeera para verificar quais foram os recebimentos e se uma determinada transferência já foi executada.

No entanto, com a webhook o cliente cadastra uma url na Transfeera e o sistema, por sua vez, manda uma mensagem para essa mesma url. Desse modo, o cliente ganha:

  • Mais facilidade para fazer a conciliação;
  • Mais agilidade no envio das informações;
  • Mais rapidez nos processos que se seguem aos pagamentos de clientes, fornecedores etc.

A integração da plataforma da Transfeera é feita por meio de uma API. Para explorar as possibilidades das nossas APIs e ver como funciona a criação de webhooks no nosso sistema, convidamos você a acessar o Sandbox e:

  • Realizar testes em nosso ambiente para validar as integrações com o seu sistema;
  • Simular transações de pagamentos, validar dados bancários;
  • Gerar QR Codes Pix;
  • E muito mais.

Solicite aqui o seu acesso ao Sandbox.

 

Quer receber esses conteúdos e as novidades em primeira mão diretamente em seu e-mail?

Cadastre-se e receba as atualizações do blog e sobre a Transfeera diretamente em seu e-mail.

Ao informar meus dados, concordo com a política de privacidade

Usamos cookies e tecnologias similares para melhorar a sua experiência, personalizar publicidade e conteúdos de seu interesse. Ao utilizar nossos serviços, você concorda com tal monitoramento. Informamos ainda que atualizamos nossos termos legais, confira!