Notificações e Eventos (Webhook)

Os webhooks, também conhecidos como HTTP Callbacks, são uma maneira eficaz de se registrar para receber informações em tempo real em uma URL específica de sua escolha. Eles atuam como pontes entre diferentes sistemas, permitindo que um sistema notifique outro sobre eventos específicos.

Quando ocorre uma alteração no estado de um recurso dentro da plataforma, como quando um novo pedido é recebido, um evento é gerado. Esse evento é então enviado para todos os webhooks que foram previamente cadastrados para receber tais notificações.

Esta funcionalidade está disponível no menu de Integrações. Logo abaixo, veja como utilizá-la.

Para começar a utilizar as notificações de eventos por webhooks, siga os passos abaixo:

  1. Implemente o seu sistema de recebimento de notificações. Este será o local onde os eventos serão enviados.

  2. Cadastre as URLs do seu sistema na plataforma. Assim, a plataforma saberá para onde enviar as notificações.


Importante

  • Integração Assíncrona: Certifique-se de que o seu sistema de recebimento de eventos esteja construído seguindo o paradigma de integração assíncrona. Isso significa que, ao receber uma notificação, seu sistema deve armazená-la em uma fila para posterior processamento interno, em vez de processá-la imediatamente.

  • URL Pública: A URL do seu webhook deve ser acessível publicamente na internet. Isso garante que a plataforma possa alcançá-la e enviar os eventos sem problemas.


Timeouts

A plataforma espera receber uma resposta do seu webhook em até 3 segundos após o disparo de um evento. Se esse tempo for excedido, a conexão será encerrada e a plataforma tentará reenviar o evento após 5 minutos.

Recomendações:

  • Tratamento de Eventos Duplicados: É possível que, em algumas situações, um evento seja disparado mais de uma vez. Por isso, é essencial que você implemente um tratamento em seu sistema para garantir que eventos duplicados sejam considerados apenas uma vez.

  • Resposta ao Recebimento: Quando o seu endpoint receber uma notificação, é crucial retornar com a resposta {"status": "ok"}. Se houver um volume considerável e repetitivo de retornos inválidos, o webhook será desativado automaticamente pela plataforma.


Esperamos que este artigo tenha esclarecido como funcionam as notificações e eventos via webhook em nossa plataforma. Se tiver mais dúvidas, não hesite em entrar em contato com nossa equipe de suporte. Estamos aqui para ajudar!

Última actualización