🔗Webhooks

Documentação sobre o webhook da Adoorei.

O que é webhook?

Uma das melhores formas de se conectar aplicações web é através do uso de webhooks. Utilizando webhooks uma aplicação se torna capaz de enviar requisições para outra toda vez que um determinado evento ocorrer. Assim a aplicação que recebe o webhook pode iniciar algum processo sempre que esse evento for recebido. Com isso é possível automatizar diversos tipos de tarefas em seu workflow.

Adoorei Webhooks

Até o momento nossa aplicação está preparada para lidar com dois webhooks.

Os eventos de pedido são aqueles enviados quando ocorre alguma alteração no pedido, para este possuímos os seguintes hooks:

  • Pedido criado

  • Atualização de pedido

  • Atualização de status de pedido

  • Pedido aprovado

  • Pedido com pagamento recusado

Como utilizar?

Para utilizar esse recurso disponível em nossa aplicação, primeiro você deve possuir alguma URL que será usada pelo nosso sistema para enviar uma requisição POST sempre que um evento selecionado ocorrer.

No momento do cadastro do webhook será feita uma requisição de teste para a URL informada. Neste momento, a URL informada deve ser válida e responder com status HTTP 200.

Quando já possuir a URL disponível, vá até o nosso painel e acesse Configurações/Webhook. Nessa página você deverá informar:

  • nome do webhook;

  • URL para onde iremos enviar a requisição POST.

Após o preenchimento, guarde o TOKEN de maneira segura e selecione quais eventos a URL informada deverá receber.

Toda requisição que for enviada pela Adoorei será feita com o header "X-Adoorei-hash", com o TOKEN informado na hora do cadastro do webhook. Seu sistema pode usar esse header para autenticar as requisições, garantindo maior segurança e confiabilidade.

Uma vez que o webhook esteja cadastrado e habilitado, sempre que um evento habilitado no webhook ocorrer em nosso sistema será enviado uma requisição POST para a URL informada.

Last updated