Instalação do Service Worker Inngage via Plugin para VTEX IO.

Written by Inngage
Updated 1 week ago

Este plugin permite que clientes VTEX utilizem os recursos de Web Push Notifications da Inngage diretamente em seus sites, mesmo utilizando o serviceWorkerMerged da VTEX, o qual limita o uso simultâneo de múltiplos service workers.

 Indicado para:

  • Lojas VTEX que utilizam o serviceWorkerMerged padrão da VTEX.
  • Clientes que desejam ativar notificações push em navegadores compatíveis com o protocolo Web Push.

 🚀 O que o plugin faz?

Ao instalar o plugin, ele:

  • Estende o serviceWorkerMerged da VTEX sem sobrescrevê-lo completamente.
  • Adiciona o tratamento do protocolo Web Push da Inngage diretamente no service worker existente.
  • Garante compatibilidade com as políticas de segurança e performance da VTEX IO.
  • Elimina conflitos causados por múltiplos service workers no mesmo domínio.

🛠️ Como instalar:

Execute o comando abaixo no terminal, utilizando o VTEX CLI já autenticado no ambiente da loja desejada:

vtex install [email protected]

📍 Pré-requisitos:

Antes de instalar, certifique-se de que:

  • O ambiente VTEX IO da loja está com o VTEX Toolbelt configurado.
  • Você tem permissão de Admin para instalar apps personalizados.
  • O serviceWorkerMerged está ativo (padrão na maioria das lojas VTEX).

⚙️ Configurações adicionais:

Após a instalação:

1. Acesse o painel da Inngage e vá em:

Configurações do App → Plataformas → Web Push

2. Copie seu token de integração.

3. Adicione o token no arquivo de manifest.json do app da loja (se aplicável), ou insira como variável de ambiente se o token estiver sendo consumido via API.

🔍 Verificação:

Após a instalação:

  • Acesse o site da loja.
  • No console do navegador, verifique se o service worker foi registrado com sucesso.
  • O evento pushsubscriptionchange ou push deverá ser interceptado com os handlers da Inngage.

🖋️ Teste:

Para validar o funcionamento:

  1. Acesse o site no navegador.
  2. Aceite a permissão de notificações.
  3. Envie uma campanha de Web Push via Inngage.
  4. Verifique se a notificação foi recebida com sucesso.

❓ Suporte:

Em caso de dúvidas ou problemas na instalação:

Did this answer your question?