Pular para o conteúdo

Configurar Webhook de Carrinho VTEX

O webhook de carrinho (Orders Hook) notifica o Implementaê sempre que um pedido é criado ou atualizado na sua loja VTEX. É usado para disparar automações de pós-venda, atualizar status e sincronizar dados de pedidos com plataformas conectadas.

Pré-requisitos

AppKey + AppToken VTEX gerados (veja Gerar AppKey)
Permissões OMS (leitura) e Orders Hooks (leitura e escrita) na chave

Como funciona o Orders Hook VTEX

Passo 1 — Obter o endpoint de webhook no painel

Acesse hub.implementae.com
Vá em Integrações → VTEX → Pedidos
Copie o Endpoint de webhook exibido

Passo 2 — Registrar o Orders Hook na VTEX

A VTEX usa a API de Orders Hooks para registrar notificações. Exemplo:

curl --request POST \
  --url 'https://{accountName}.vtexcommercestable.com.br/api/orders/hook/config' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'X-VTEX-API-AppKey: {appKey}' \
  --header 'X-VTEX-API-AppToken: {appToken}' \
  --data '{
    "filter": {
      "type": "FromWorkflow",
      "status": ["order-created", "payment-approved", "invoiced", "canceled"]
    },
    "hook": {
      "headers": {
        "user-agent": "implementae-hook"
      },
      "url": "https://implementae-webhook.{seu-worker}.workers.dev/vtex/orders"
    }
  }'

Dica: registre apenas os status que você precisa. Menos eventos = menos ruído nos logs.

Passo 3 — Testar com um pedido de teste

Faça um pedido de teste na sua loja VTEX (pode usar o modo sandbox)
Acesse Implementaê → Logs → Pedidos
Verifique se o evento aparece com status 200

Filtros recomendados por caso de uso

Caso de uso	Status recomendados
Pós-venda / CRM	`payment-approved`, `invoiced`
Alertas de cancelamento	`canceled`
Rastreamento completo	`order-created`, `payment-approved`, `invoiced`, `canceled`

Próximos passos