O que é #
Webhook é uma chamada que a ViaShopModa faz para uma URL do ERP quando algo acontece na loja. Ele substitui as consultas repetidas ("tem pedido novo?") que gastam o limite diário.
Eventos #
| Evento | Quando |
|---|---|
| Pedido | Pedido criado, cancelado ou alterado (a alteração gera um cancelamento e, 4 minutos depois, um pedido novo). |
| Cliente | Cliente se cadastrou na loja ou foi incluído pela loja. |
| Lead | Visitante deixou nome e e-mail ou WhatsApp. |
| Sacola abandonada | Cliente identificado deixou itens na sacola sem finalizar. |
Formato e configuração #
O formato de cada webhook (corpo, cabeçalhos, autenticação) e a configuração das URLs estão na documentação de webhooks. Para cadastrar ou trocar as URLs da sua integração, fale com api@viashopmoda.com.br.
Como processar #
- Responda rápido com HTTP 2xx assim que receber; faça o processamento pesado depois, numa fila do ERP.
- Trate repetição: o mesmo evento pode chegar mais de uma vez. Antes de criar, verifique se o registro já existe no ERP (pedido pelo
numero_pedido, cliente pelo CPF/CNPJ ou e-mail). - Respeite a ordem em alterações de pedido: processe o cancelamento antes de reservar o pedido novo.
- Busque dados completos se precisar:
pedido/consultar?pedido=,cliente/consultar?email=,sacola_abandonada/consultar?sessao=. - Confira periodicamente: uma consulta de pedidos alterados no período (por exemplo, de hora em hora) recupera eventos perdidos enquanto o ERP estava fora do ar.
Erros comuns de integração #
- URL do ERP que demora para responder porque processa tudo antes do 2xx.
- Criar pedido em dobro quando o webhook chega duas vezes.
- Desligar o webhook e passar a consultar a API a cada minuto: consome o limite da loja inteira.