Push Notifications (Webhooks)

O que são Push Notifications?

Push Notifications são mensagens enviadas pela Shopee diretamente para a Callback URL configurada pela sua aplicação quando ocorre um evento relevante.

Por exemplo:

• Um pedido foi criado;
• O status de um pedido foi alterado;
• Um produto foi atualizado;
• Uma autorização foi cancelada;
• Uma atualização logística ocorreu.

Objetivo

Permitir que a Shopee envie atualizações automaticamente para sua integração quando determinados eventos ocorrerem, sem que sua aplicação precise consultar as APIs repetidamente.

O que você fará nesta etapa

Você configurará uma Callback URL, selecionará os eventos que sua aplicação precisa receber e preparará seu sistema para processar as notificações enviadas pela Shopee.

Antes de continuar você precisa saber:

• No Shopee Open Platform, Push Mechanism é o mesmo conceito conhecido como Webhook em outras plataformas.
• Push NÃO substitui API. O Push só diz: "Algo mudou." Depois disso o desenvolvedor chama a API correspondente.
• Nem todo App possui todos os Push. Verifique os webhooks disponíveis na documentação.
• Callback URL precisa ser verificada. A Shopee faz um POST para validar a URL.
• Cada Push enviado pela Shopee contém um Authorization Header, que pode ser validado utilizando sua Partner Key para confirmar que a requisição realmente foi enviada pela Shopee.
• Callback deve responder 2xx.
• Consulte a documentação para obter detalhes sobre a lógica de reenvio das notificações (Push Mechanism Retry Logic) e sobre os critérios de aviso e desabilitação automática do Push Mechanism (Push Mechanism Warning/Disable Logic).

Como configurar

• Acesse o Open Platform Console.
• No menu lateral, clique em Push Mechanism.
• Selecione a aplicação que deseja configurar.
• Informe a Callback URL da sua integração.
• Selecione ou habilite os eventos necessários.
• Realize a validação solicitada pelo Console.
• Salve a configuração.
• Confirme que sua aplicação consegue receber e processar os eventos.

No Sandbox V2, é possível configurar a Test Callback URL, concluir sua validação e utilizar a opção Push Test Data para enviar dados de teste à aplicação. O Push de Sandbox é independente da configuração de Produção.

Próximo passo

Após configurar Push Notifications, monitore o recebimento dos eventos e valide se sua aplicação está atualizando corretamente pedidos, produtos e demais recursos relacionados.

📚 Leia a documentação completa

• Push Mechanism notifications
• Push APIs List