Home

Webhook API

Introdução

Webhooks criam conexões entre sistemas distintos, de modo que um sistema possa receber informações de outro assim que uma determinada ação ocorra.

Confira a imagem abaixo:

Referência: https://miro.medium.com

Webhook API

A Webhook API recebe dados de fontes externas convertendo-os em inteligência aplicada a processos internos da estrutura do OSB. Atualização de operações e disparo de notificações são alguns dos procedimentos mais comuns acionados pelos hooks recebidos. Ela é responsável por receber estes hooks de aplicações parceiras para atualização e conclusão de processos e operações.
Exemplo:

  • Atualização do processamento de transferências entre bancos, Pix, recargas de celular ou transferências internas, disparam hooks para a API de Webhook informando seus respectivos estados;
  • Contas criadas através da FitbankAPI disparam hooks para a API de Webhook informando que essas contas foram criadas;
  • Usuários criados através de processos manuais, formulários de abertura de conta ou chamadas no FitbankAPI disparam hooks para a API de Webhook informando sobre a criação destes usuários;

Autenticação

Para receber dados das fontes externas é preciso configurar a Autorization das requisições, a Webhook API trabalha com Basic Auth, necessitando de um usário e uma senha para conseguir realizar as chamadas. No ato da configuração desse projeto defina as credenciais e informe ao provedor de serviços financeiros para que ele possa ajustar sua estrutura garantindo a comunicação entre as aplicações.