Webhooks

Nesse artigo aprenda o que é o Webhook e como configurá-lo no Omie

Hugo Alves avatar
Escrito por Hugo Alves
Atualizado há mais de uma semana

O que é um Webhook?

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 Omie ocorrerem

Caso você ainda não tenha esse Endpoint, para realizar testes é possível usar diversas ferramentas disponíveis na internet com esse propósito. Aqui, vamos utilizar a ferramenta: RequestBin através do site: https://requestbin.com/


Configurando o endpoint

Após acessar o site clique sobre a opção “Create a public bin instead”, conforme destacado em vermelho na imagem abaixo:

Após clicar nessa opção, perceba que você já possui um Endpoint disponível para testes. Clique sobre o link “copy” para não ser necessário digitar o endereço do Endpoint:


Configurando o Webhook no Omie

Para configurar o Webhook no Omie, acesse a página de webhooks do seu aplicativo:

Lembrando que é necessário ter o perfil de administrador!

Ao acessar o site, clique sobre o botão “Adicionar novo webhook":

Defina o Endpoint disponibilizado pelo RequestBin e selecione os eventos que desejar:

Salve as alterações abaixo:

Após salvar as alterações imediatamente o Omie enviará uma notificação de testes para o RequestBin:

📌 Obs.: as alterações do Webhook apenas terão efeito para as novas sessões do Omie. Se você está com alguma sessão aberta feche para iniciar os testes


Testando o Webhook

A partir desse momento, todas as novas sessões abertas do aplicativo configurado notificarão o Endpoint quando os eventos configurados ocorrerem

Por isso, recarregue seu aplicativo antes de iniciar os testes!

Vamos alterar, por exemplo, o endereço desse cliente, e salvar:

No mesmo instante, o Webhook será disparado com a alteração da informação:


📌 Separamos alguns artigos importantes que podem te ajudar bastante:

Respondeu à sua pergunta?