Este recurso está disponível em todos os planos das contas de indústrias e distribuidoras. Somente os usuários responsáveis pela conta podem configurar o Webhook.

Webhook é um recurso que faz o Mercos avisar automaticamente sua aplicação sempre que algo acontece, enviando as informações em tempo real. Com ele, você pode otimizar sua integração, recebendo notificações automáticas sobre novos pedidos gerados, cancelamentos, faturamentos de pedidos e atualizações de pagamentos via Mercos Pay. 

Além disso, você também recebe avisos automáticos quando um cliente é cadastrado, atualizado, excluído ou tem o acesso bloqueado, ou liberado. Para configurar o Webhook dentro do Mercos, siga esses passos:

1. Acesse o sistema Mercos online;
2. No menu lateral, clique em “Minha conta”:

3. Na aba “Sistema”, em seguida, vá em “Webhooks”;

4. Depois, clique em “Configurar Webhook”.

5. Nas configurações, os seguintes campos devem ser preenchidas:

- URL do endpoint: informe a URL da aplicação que será responsável pelo recebimento das notificações enviadas pelo Mercos. Essa URL deve ser obtida com o responsável pela integração entre o Mercos e seu ERP. O conteúdo enviado pelo Mercos será em formato JSON num método do tipo POST. 

- Situação: opção para manter o Webhook como ativo ou inativo. Caso o webhook esteja inativo, nenhuma notificação será enviada para a URL informada. 

- Tipos de eventos que podem receber notificações através do Webhook:

• cliente.cadastrado: selecione esta opção quando desejar que a sua aplicação seja notificada que um novo cliente foi cadastrado no Mercos (através do sistema Online, pela API ou pelo aplicativo).

• cliente.atualizado: selecione esta opção quando desejar que a sua aplicação seja notificada que um cliente foi alterado no Mercos (através do sistema Online, pela API ou pelo aplicativo).

• cliente.bloqueioatualizado: selecione esta opção quando desejar que a sua aplicação seja notificada que um cliente foi bloqueado ou desbloqueado no Mercos (através do sistema Online, pela API ou pelo aplicativo).

• cliente.excluido: selecione esta opção quando desejar que a sua aplicação seja notificada que um cliente foi excluído no Mercos (através do sistema Online, pela API ou pelo aplicativo).

• pedido.gerado: selecione esta opção quando desejar que a sua aplicação seja notificada que um novo pedido foi gerado no Mercos (através do sistema Online, pela API, pelo e-commerce B2B ou pelo aplicativo).

• pedido.faturado: selecione esta opção quando desejar que a sua aplicação seja notificada que um pedido foi faturado no Mercos (através do sistema Online ou pela API).

• pedido.cancelado: selecione esta opção quando desejar que a sua aplicação seja notificada que um pedido foi cancelado no Mercos (através do sistema Online ou pela API).

• pagamento.atualizado: selecione esta opção quando desejar que a sua aplicação seja notificada que um link de pagamento (via Mercos Pay) foi criado ou excluído e/ou que o status de algum pagamento (também via Mercos Pay) foi atualizado. 

6. Por fim, salve as configurações. 

Quando ocorrer algum dos eventos selecionados na configuração do webhook (pedido gerado, cancelado e/ou faturado, ou pagamento atualizado; cliente.cadastrado, cliente.atualizado, cliente.bloqueioatualizado, cliente.excluído), uma notificação será disparada na URL informada.

Importante!

• É permitido configurar até 5 webhooks;

• A URL informada deve ser uma URL válida. Se identificarmos que a URL é inválida, não será possível configurar o webhook. Além disso, não é permitido configurar a mesma URL para diferentes webhooks;

• Pelo menos um tipo de evento precisa ser selecionado ao configurar um webhook;

Como visualizar as notificações enviadas pelo Mercos?

Para visualizar as notificações enviadas ou em processo de envio, pelo Mercos, siga esses passos:

1. Acesse o menu “Minha conta”;

2. Siga para a aba, “Sistema”, e depois, “Webhooks”;

3. Em um dos Webhooks já configurados, clique em “Consultar informações enviadas”. Uma listagem será exibida em tela com informações sobre as notificações.

Para cada notificação da listagem, existem quatro opções de status:

• Envio não iniciado: a notificação está na fila para ser enviada, mas o envio ainda não foi iniciado;

• Em processo de envio: o envio da notificação já foi iniciado, mas ainda não foi finalizado;

• Sucesso: a notificação foi enviada com sucesso.

• Falha: ocorreu algum erro durante o envio ou recebimento da notificação.

As notificações com status de “Sucesso” ou “Falha”, possuem o botão “Detalhar” disponível. Ao clicar neste botão, é possível verificar as informações da notificação (as mesmas que aparecem na listagem) e também o conteúdo enviado na notificação (requisição) e o retorno obtido (resposta).

Importante: apenas as notificações dos últimos 60 dias são armazenadas.

São realizadas três tentativas de envio para cada notificação, e os dados da requisição e da resposta referentes a cada tentativa podem ser visualizados nos detalhes da notificação. A segunda tentativa ocorre apenas se a primeira não for concluída com sucesso. Da mesma forma, a terceira tentativa acontece somente quando as duas primeiras não obtêm sucesso.

Confira a documentação técnica para obter mais informações sobre a estrutura de dados retornados pelo webhook.