Webhook é uma forma de notificação de informações, enviadas quando um evento ocorre, ou seja, é uma forma de receber informações de um sistema passivamente.

O Omie fornece esse recurso e para trabalhar com ele você precisa ter um Endpoint, que é um endereço que receberá as notificações quando os eventos configurados no seu aplicativo Omie ocorrerem.

Se você ainda não possui um Endpoint próprio, existem diversas ferramentas disponíveis na internet para realização de testes.

Durante o exemplo apresentado neste artigo, iremos utilizar a ferramenta RequestBin.

Inicialmente, vamos configurar um endereço (URL) de um endpoint para realização do teste.

1) Acesse a página da ferramenta RequestBin e então, clique sobre a opção “Create a public bin instead”, conforme destacado na imagem abaixo:

2) Na próxima tela, será apresentado a URL do seu Endpoint de testes (1).

Você pode clicar sobre a opção “copy” (2) para não ser preciso digitar o endereço do Endpoint no momento da configuração:

3) Agora que já temos o Endpoint criado, vamos ativar o Webhook. 🚀

1) Para iniciar a configuração, faça o login no Omie e então acesse o portal Developer:

2) Dentro do portal Developer, clique no botão "Aplicativos":

3) Na tela seguinte, localize o aplicativo de interesse e clique sobre ele:

4) Agora, clique na opção "⚙️ Adicionar novo webhook":

5) Cole a URL do Endpoint de teste que copiamos anteriormente:

6) Em seguida, será exibido a listagem com os Webhooks disponíveis.

Basta ativar os Webhooks referentes as notificações que deseja receber (1) e então, clique em "Salvar" (2):

7) Após salvar as alterações, o Omie enviará uma notificação de teste para o RequestBin, onde poderemos confirmar que já está ocorrendo a comunicação entre os sistemas:

8) Podemos, então, iniciar o teste com o Webhook ativado.

1) Neste exemplo de teste, ativamos o Webhook "ClienteFornecedor.Alterado".

Então, vamos modificar o endereço um cliente cadastrado no Omie (1) e salvar (2) a alteração:

2) Em seguida, o Webhook sobre a alteração cadastral será disparado pelo aplicativo Omie notificando o Endpoint de destino. Se você seguiu nosso passo a passo anterior, receberá o evento em seu Endpoint de testes.
​
Você conseguirá visualizar o evento, na página do Endpoint de teste configurado nos passos anteriores:

3) Ao seguir este artigo, você aprendeu a configurar, ativar e testar Webhooks no Omie.

Com essas informações, você está pronto para explorar e integrar Webhooks em seus próprios projetos, otimizando ainda mais suas operações. 🚀