Pular para o conteúdo principal

Introdução

Inscreva-se para receber notificações e atualizações relacionadas a produtos.

Mais informações sobre a interface do usuário do módulo https://doc.oneentry.cloud/docs/category/events

🎯 O que este módulo faz?​

O módulo Events permite que você inscreva usuários em notificações de produtos - como um e-mail quando um produto está de volta em estoque, ou um alerta quando o preço cai. Você configura os eventos no painel de administração do OneEntry; o SDK gerencia quem está inscrito em quê.

Pense nisso como um sistema de assinatura de produtos - os usuários se inscrevem em produtos específicos (ou formulários) e recebem notificações quando algo muda.

🚀 Início Rápido​

Inicialize o módulo a partir de defineOneEntry:


const { Events } = defineOneEntry(
  "your-project-url", {
    "token": "your-app-token"
  }
);

Liste os eventos disponíveis (públicos — sem necessidade de autorização):

// Fetch all events configured in the admin panel.
const events = await Events.getAllEvents();

events.forEach((event) => {
  console.log(event);
});

Para inscrever um usuário em um evento de produto, você deve estar autorizado primeiro, depois chame subscribeByMarker(marker, productId, langCode?):

// Requires an authorized user (see AuthProvider).
const ok = await Events.subscribeByMarker("product_price_change", 12345, "en_US");
console.log(ok); // true on success

✨ Conceitos Chave​

O que é um Evento de Produto?​

Um evento de produto é uma notificação acionada por mudanças em um produto:

  • Gatilho - o que acontece com o produto (por exemplo, "de volta em estoque", "queda de preço")
  • Notificação - o que os assinantes recebem (e-mail ou push)
  • Assinantes - usuários que optaram por receber atualizações deste produto
  • Template - o conteúdo da mensagem de notificação (configurado no painel de administração)

O módulo também suporta eventos de formulário: inscreva-se / desinscreva-se de notificações ligadas a uma submissão de formulário com subscribeToForm / unsubscribeFromForm.

Canais de Notificação​

CanalDescriçãoMelhor Para
EmailEnviar mensagens por e-mailAlertas de reabastecimento, quedas de preço, newsletters
Notificação PushAlertas móveis/navegadorAlertas urgentes, vendas relâmpago

📋 O que você precisa saber​

Eventos são configurados no painel de administração​

Gatilhos, canais e templates são configurados no painel de administração do OneEntry. O SDK não cria eventos ou os dispara manualmente — os eventos são acionados automaticamente quando os dados do produto mudam. O SDK é para listar eventos e gerenciar assinaturas.

Autorização​

getAllEvents() é público. Cada método de assinatura (getAllSubscriptions, subscribeByMarker, unsubscribeByMarker, subscribeToForm, unsubscribeFromForm, getFormSubscriptions) exige um usuário autorizado — veja AuthProvider.

Variáveis de Template​

Use marcadores de posição nos templates de notificação para incluir detalhes do produto, como nome, preço e disponibilidade. Os templates são editados no painel de administração.

📊 Tabela de Referência Rápida - Métodos Comuns​

MétodoO que faz
getAllEvents()Obter todos os eventos disponíveis
getAllSubscriptions() 🔐Obter todas as assinaturas de produtos
subscribeByMarker() 🔐Inscrever-se em um evento de produto por marcador
unsubscribeByMarker() 🔐Desinscrever-se de um evento de produto por marcador
subscribeToForm() 🔐Inscrever-se em um evento de formulário por marcador
unsubscribeFromForm() 🔐Desinscrever-se de um evento de formulário por marcador
getFormSubscriptions() 🔐Obter todas as assinaturas de formulário

🔐 métodos exigem autorização do usuário — veja AuthProvider. getAllEvents() é público.

❓ Perguntas Comuns (FAQ)​

Como eu crio ou edito eventos de produtos?​

Os eventos são criados e configurados no painel de administração do OneEntry (seção Events) — configure gatilhos, canais e templates lá, e depois ative o evento. O SDK apenas lista eventos e gerencia assinaturas.

Posso acionar manualmente um evento de produto a partir do meu código?​

Não. O SDK não suporta acionamentos manuais — os eventos são acionados automaticamente com base nos gatilhos configurados no OneEntry quando os dados do produto mudam.

Por que a inscrição falha com um erro de autorização?​

Os métodos de assinatura exigem um usuário autorizado. Autorize primeiro via o módulo AuthProvider, depois chame subscribeByMarker / subscribeToForm. getAllEvents() funciona sem autorização.

🎓 Melhores Práticas​

  • Autorize o usuário antes de chamar qualquer método de assinatura.
  • Use marcadores de evento descritivos (por exemplo, product_back_in_stock, product_price_drop).
  • Sempre ofereça um caminho fácil para desinscrição (unsubscribeByMarker / unsubscribeFromForm).
  • Trate erros de assinatura de forma elegante e verifique a forma de retorno IError.

🔗 Documentação Relacionada​