O que são webhooks?

Webhook é a forma que uma aplicação fornece informações em tempo real a outras aplicações. Os webhooks são frequentemente chamados de API callback ou simplesmente notificações. No Moip você pode receber webhooks de diferentes tipos de eventos referentes aos status das vendas, como um pedido criado ou pagamento concluído. Sendo assim, os Webhooks foram criados para permitir que seu sistema seja atualizado em tempo real sobre os principais eventos que ocorrem no Moip. Um exemplo é a autorização de um pagamento após a análise anti-fraude. Neste caso, o seu sistema recebe (de forma síncrona) na resposta da criação de um pagamento o retorno com a informação de que o pagamento entrou em análise. No entanto, como a análise é feita em um segundo momento, você precisa atualizar o seu sistema com o resultado da análise. Para isso, você irá cadastrar URLs no Moip e enviaremos as notificações por meio de chamadas HTTP Post.

Você pode utilizar os webhooks para:

  • Receber o resultado da análise de transações de cartão de crédito
  • Receber notificações de pagamentos por boleto
  • Enviar e-mails para seus usuários com base nas alterações de status dos pedidos
  • Receber atualizações de assinaturas pagas ou vencidas
  • Atualizar sistemas contábeis de lançamentos liquidados na Conta Moip
  • Outros usos diversos

Entendendo os Webhooks

Como descrito acima os Webhooks são as notificações automáticas que o Moip te envia sobre as alterações de status.

Vamos colocar em etapas para simplificar o entendimento.

1) Preparar a sua conta Moip

Primeiramente você deve preparar a sua conta para enviar os webhook, por padrão no Moip os webhooks são desabilitados em todas as contas, então você precisa habilitar o envio em sua conta cadastrando uma URL para receber essas notificações.

2) Tratar os webhooks

Depois de criada a configuração em sua conta Moip sua aplicação passará a receber os webhooks sempre que alguma coisa mudar em seus pedidos, pagamento e etc. Nesse caso sua aplicação deve saber interpretar essas notificação e trata-las de acordo com o seu modelo de negócio.

O conteúdo que enviamos nos webhooks é o mesmo que retornamos na API, apenas estará dentro de um nova parâmetro.

Configurando URLs de recebimento

Você deve cadastrar suas URLs de Webhook através da API de Notificações. É possível cadastrar múltiplas URLs e definir o tipo de webhook que deve ser enviado para cada uma delas. Isso faz com que você possa por exemplo receber notificações de pedidos pagos em um sistema (plataforma de e-commerce) e as notificações de lançamentos liquidados em um sistema diferente (sistema contábil). Caso você configure o mesmo webhook em mais de uma URL você receberá as notificações em todas as URLs.

Esse artigo foi útil?
Usuários que acharam isso útil: 0 de 0
Tem mais dúvidas? Envie uma solicitação

Comentários

Artigo fechado para comentários.