Como Adicionar um Webhook na Plataforma

O que é um Webhook?

Um webhook é uma maneira eficiente e em tempo real de seu sistema se comunicar com outros serviços. Basicamente, ele é um callback HTTP que permite que você receba notificações automáticas sempre que um evento específico ocorrer na plataforma. Diferente de uma API tradicional onde você precisa solicitar dados ativamente, os webhooks enviam as informações diretamente para uma URL que você define, sem a necessidade de intervenção manual.

Para que Serve um Webhook?

Os webhooks são extremamente úteis quando você precisa reagir a eventos em tempo real. Isso permite que você integre a plataforma com outros sistemas, automatize fluxos de trabalho e reaja a eventos sem precisar fazer requisições constantes à API.

Como Configurar um Webhook

Adicionar um webhook na nossa plataforma é simples e rápido. Siga os passos abaixo para configurar o seu webhook:

1. Acesse a seção de Webhooks:

   • No painel clique no seu ícone de usuário no canto superior direito, e clique em "Integrações".

2. Adicionar um Novo Webhook:

   • Role até a seção "Outro", e clique em "Adicionar" no webhook para iniciar o processo de configuração.

3. Preencher os Campos Necessários:

   • URL: Este é o campo mais importante. Aqui você deve informar a URL para a qual os eventos serão enviados. Certifique-se de que essa URL esteja preparada para receber as requisições HTTP POST que serão enviadas com os dados do evento.

   • Token (Opcional): Este campo permite que você defina um token de autenticação que será enviado junto com as requisições. Se você definir um token, ele será incluído nos cabeçalhos da requisição como um Bearer Token. Isso é útil para garantir que apenas requisições legítimas, enviadas pela nossa plataforma, sejam aceitas pelo seu servidor.

   • Eventos: Selecione os eventos para os quais você deseja receber notificações. Você pode escolher entre "Novo pedido", "Pedido pago" ou "Pedido expirado". Selecione apenas os eventos que são relevantes para sua aplicação.

4. Adicionar:

   • Após preencher todos os campos, clique em "Adicionar". O seu webhook será adicionado à lista de webhooks configurados.

Como Funciona o Webhook?

Uma vez configurado e ativado, sempre que um dos eventos selecionados ocorrer, a nossa plataforma enviará uma requisição HTTP POST para a URL que você especificou. A requisição conterá os dados do evento em formato JSON, permitindo que você processe essas informações de acordo com as necessidades do seu sistema.

Se você configurou um token de autenticação, ele será enviado como um Authorization: Bearer SEU_TOKEN_SECRETO no cabeçalho da requisição. Seu servidor deve estar preparado para validar esse token antes de processar a requisição.

Considerações Finais

Webhooks são ferramentas poderosas para integrar sistemas e automatizar processos. Ao configurar um webhook na nossa plataforma, você poderá reagir a eventos em tempo real, proporcionando uma experiência mais dinâmica e eficiente para os usuários do seu sistema.

Caso tenha dúvidas ou precise de ajuda adicional, não hesite em entrar em contato com o nosso suporte técnico.