Webhooks

Em um cenário cada vez mais dinâmico e interconectado, a comunicação entre sistemas é essencial para o funcionamento eficaz das aplicações.

No contexto das APIs, a implementação de webhooks emerge como uma ferramenta indispensável, trazendo uma série de benefícios significativos.

Um dos aspectos mais relevantes dos webhooks é a sua capacidade de promover uma comunicação proativa e direta entre as partes envolvidas. Em vez de depender exclusivamente da consulta constante à API por parte dos clientes, os webhooks permitem que a Grafeno envie atualizações e notificações de forma ativa e precisa. Esse modelo de comunicação bidirecional reduz a carga de requisições sobre a API, melhorando a eficiência do sistema como um todo.

Ao adotar a prática de envio de webhooks, podemos garantir uma entrega mais rápida e precisa de informações importantes para nossos clientes. As atualizações de dados e status são transmitidas instantaneamente, evitando atrasos e proporcionando uma experiência mais ágil e satisfatória aos usuários. Outro benefício fundamental dos webhooks é a sua capacidade de aumentar a escalabilidade e a flexibilidade das aplicações.

Ao permitir que os nossos clientes se inscrevam em eventos específicos de interesse, podemos personalizar a entrega de informações de acordo com as necessidades individuais de cada usuário. Isso resulta em uma comunicação mais relevante e direcionada, fortalecendo o relacionamento entre a Grafeno e nossos clientes. Além disso, os webhooks desempenham um papel crucial na melhoria da integridade e da segurança dos dados, pois ao fornecer uma forma segura e autenticada de transmitir informações, eles minimizam o risco de acesso não autorizado ou manipulação indevida dos dados durante o processo de comunicação.

Políticas e boas práticas para webhooks Grafeno

  • Política de retry: Nossas aplicações esperam um http response code da família 2XX para confirmar que o nosso cliente recebeu a notificação. Considerando que podem ocorrer casos onde o cliente não conseguirá receber nosso POST, nós temos uma política de retry. Atualmente o número máximo de retentativas automáticas são de 25, sendo disparadas 1 notificação por hora.
  • Retry ativo: Caso uma notificação tenha esgotado as suas possibilidades de retry automático, nós da Grafeno podemos efetuar o renvio manual de uma ou mais notificações.
  • Custom Headers: Nossos clientes podem definir um header customizado no cadastro de suas URLs de notificação, esta prática é recomendada pois permite que o cliente defina uma chave de segurança que será enviada no header para auxiliar na garantia da origem da notificação.
  • Signature: Todas as nossas notificações possuem uma assinatura para que o cliente consiga validar a origem da notificação.