Configuração do Web SDK

Adicione web push do OneSignal ao seu site configurando o dashboard, fazendo upload de um service worker e inicializando o SDK JavaScript. O OneSignal suporta Chrome, Firefox, Edge, Safari e outros navegadores principais. Se você usa WordPress ou Shopify, siga a integração da plataforma em vez deste guia do SDK JavaScript. Se você precisa de personalização mais profunda, prompts, opções de init e o caminho do service worker no código, use Custom Code.

Configuração do WordPress

Instale o plugin oficial do OneSignal. O plugin adiciona o SDK e o service worker para você.

Configuração do Shopify

Conecte o Shopify através da integração Vendo. O Vendo implanta o SDK na sua loja sem edições no código do tema.

Configuração Custom Code

Defina prompts, opções de init e o caminho do service worker no OneSignal.init().

Se seu site é construído com Angular, React ou Vue, use o guia do framework correspondente em vez do trecho de código desta página.

Requisitos

Website HTTPS: Web push não funciona em HTTP ou em modos incógnito/privado.
Acesso ao servidor: Você precisa fazer upload de um arquivo service worker para seu site.
Origem única: Web push segue a política de mesma origem. Se você tem múltiplas origens (domínios/subdomínios), precisará de múltiplos apps OneSignal (um por origem). Para cumprir com esta limitação do navegador, você pode:
- Redirecionar tráfego para uma origem única para inscrições.
- Criar múltiplos apps OneSignal, um por origem.

Se sua equipe já criou uma conta com OneSignal, peça para ser convidado como função de admin para que possa configurar o app. Caso contrário, inscreva-se para uma conta gratuita em onesignal.com para começar.

Configure seu app e plataforma OneSignal

No dashboard do OneSignal:

Vá para Settings > Push & In-App > Web.

Página de Configurações do dashboard OneSignal mostrando a ativação da plataforma Web — Ative a plataforma web nas suas configurações OneSignal

Selecione o tipo de integração:

Typical Site (recomendado)

Gerencie prompts e configurações diretamente através do dashboard do OneSignal sem codificação adicional.

WordPress

Necessário se estiver usando WordPress com nosso plugin oficial.

Custom Code

Para desenvolvedores que precisam de controle completo sobre prompts e configuração do SDK.

Configuração do site

Adicione os detalhes do site:

Site Name: O nome do seu site e título de notificação padrão.
Site URL: A URL do seu site. Veja Site URL para mais detalhes.
Auto Resubscribe: Habilite isto para reinscrever automaticamente usuários que limpam seus dados de navegador quando retornam ao seu site (nenhum novo prompt de permissão necessário).
Default Icon URL: Faça upload de um PNG, JPG ou GIF não animado quadrado de 256×256 que aparece em notificações e prompts. Se não definido, um ícone de sino é usado como padrão. Veja Ícones de notificação.

Se os usuários limparem os dados do navegador, eles param de receber push até retornarem. Habilite Auto Resubscribe para que sejam inscritos novamente sem um novo prompt de permissão. Veja Inscrições.

Site URL

Insira a origem exata do seu site, ex.: https://yourdomain.com. Evite usar www. se seu site não estiver configurado dessa forma. Se você tem múltiplas origens, veja Requisitos.

Testes locais

O web SDK pode ser testado em ambientes localhost. Se você está testando em localhost, use um app OneSignal separado do seu app de produção.

Configuração de localhost

Defina a SITE URL para corresponder exatamente à URL do seu ambiente localhost. A URL deve corresponder a um destes formatos comuns de localhost:

http://localhost
https://localhost:3000
http://127.0.0.1
https://127.0.0.1:5000

Se sua URL de localhost usa HTTP, selecione Treat HTTP localhost as HTTPS for testing. O Chrome trata http://localhost e http://127.0.0.1 como origens seguras, então o SDK pode inicializar via HTTP somente nesses hosts. Outros hostnames (por exemplo http://mysite.local) não são tratados como seguros e não podem ser usados para testar web push.

Configuração de localhost do OneSignal com a opção Treat HTTP localhost as HTTPS — Testes locais no dashboard do OneSignal

Adicione allowLocalhostAsSecureOrigin: true às suas opções init do OneSignal ao inicializar em localhost.Se você está testando localhost em HTTPS com um certificado autoassinado, pode ter que pedir ao Chrome para ignorar certificados inválidos para testes com: --allow-insecure-localhost. Firefox e Safari fornecem mecanismos integrados para adicionar exceções para certificados de segurança.

HTML

<script src="https://cdn.onesignal.com/sdks/web/v16/OneSignalSDK.page.js" defer></script>
<script>
  window.OneSignalDeferred = window.OneSignalDeferred || [];
  OneSignalDeferred.push(async function(OneSignal) {
    await OneSignal.init({
      appId: "YOUR_ONESIGNAL_APP_ID",
      allowLocalhostAsSecureOrigin: true,
    });
  });
</script>

Prompt de permissões

A configuração Typical Site permite que você ou seus membros de equipe adicionem, removam e atualizem prompts de permissão através do dashboard do OneSignal a qualquer momento.

Prompts de permissão web

Configure quando e como o diálogo de permissão do navegador aparece para seus usuários.

Notificação de boas-vindas (opcional)

Você também pode definir uma notificação de boas-vindas para ser enviada aos usuários quando eles se inscrevem para notificações push. Typical Site e WordPress definem isso no dashboard. Custom Code define welcomeNotification no OneSignal.init(). Para definir isso no dashboard, vá para Settings > Push & In-App > Web:

Configuração da notificação de boas-vindas

Para configurações Custom Code, veja os parâmetros de welcomeNotification na referência do Web SDK.

Configurações avançadas

Os seguintes recursos são configuráveis no dashboard do OneSignal.

Webhooks

O web SDK pode fazer POST de certos eventos de web push para uma URL de sua escolha. Web Push Webhooks são uma implementação separada de Event Webhooks e não podem ser usados de forma intercambiável.

Webhooks de web push

Envie eventos de web push para seu servidor via requisições POST.

Service workers

O Web SDK procura o OneSignalSDKWorker.js na raiz do seu site (https://yourdomain.com/OneSignalSDKWorker.js), a menos que você informe uma localização diferente. Como você informa ao SDK uma localização fora da raiz depende do tipo de integração que você selecionou. Typical Site: Defina o caminho no dashboard. Não defina serviceWorkerPath no código. Se você hospedar o arquivo na raiz, mantenha as configurações de caminho padrão. Se você hospedá-lo em um subdiretório, deve definir o caminho abaixo, ou o SDK continuará requisitando /OneSignalSDKWorker.js e o registro falhará.

Vá para Settings > Push & In-App > Web.
Abra Advanced Push Settings.
Habilite Customize service worker paths and filenames.
Defina os campos para corresponder à URL pública do arquivo:

Campo	O que inserir	Exemplo
Path to service worker files	Diretório onde você hospedará o arquivo.	`/push/onesignal/`
Service worker filename	O nome do arquivo `.js`. Se o dashboard também mostrar um nome de arquivo atualizador, defina ambos os campos com o mesmo arquivo.	`OneSignalSDKWorker.js`
Service worker registration scope	Mesmo caminho da localização do arquivo.	`/push/onesignal/`

Campos de configuração de caminho, nome de arquivo e escopo do service worker — Configuração do service worker

Com os valores de exemplo acima, o arquivo deve estar publicamente acessível em https://yourdomain.com/push/onesignal/OneSignalSDKWorker.js. Custom Code: Não use os campos de caminho do dashboard. Passe serviceWorkerPath e serviceWorkerParam no OneSignal.init(). Veja Configuração Custom Code para as opções de init, e Service worker do OneSignal para combinar workers e migração.

Comportamento de clique

O comportamento de clique só muda o que acontece quando o usuário já tem seu site aberto em uma aba de mesma origem. Se nenhuma aba correspondente estiver aberta, o navegador abre uma nova aba na URL da notificação. Esta configuração não muda isso. O comportamento de clique funciona no Chrome, Edge, Firefox e Safari. Se nenhuma launch URL estiver definida, a URL da notificação é sua página inicial. Defina uma launch URL para enviar usuários a uma página específica, adicionar rastreamento UTM ou acrescentar ?_osp=do_not_open para descartar sem abrir uma página. Se uma aba de mesma origem já estiver aberta, o comportamento depende da configuração que você escolher:

Configuração	Corresponde em	Ação
Exact Navigate (padrão)	URL exata (ex.: `example.com/product`)	Navega para a URL da notificação na aba correspondente
Origin Navigate	Origem (ex.: `example.com`)	Navega para a URL da notificação na aba correspondente
Exact Focus	URL exata	Foca na aba correspondente sem recarregar
Origin Focus	Origem	Foca na aba correspondente sem recarregar

URLs, links e deep linking

Direcione usuários para uma página específica, adicione rastreamento UTM ou descarte a notificação com ?_osp=do_not_open.

Botões de ação

Permita que usuários realizem uma ação a partir da notificação sem usar o clique padrão.

Listeners de eventos push do Web SDK

Escute eventos de clique e execute comportamento no app com código personalizado.

Persistência

A persistência mantém a notificação na tela até que o usuário interaja com ela. Funciona apenas no Chrome e Edge em desktop. Firefox, Safari e todos os navegadores móveis a ignoram. Uma notificação persistente pode ocultar texto, imagens e botões de ação, então você pode querer desabilitá-la se isso for um problema para seus usuários. Quando o valor não está definido, o SDK atualmente trata a persistência como ativada.

Typical Site: Use a alternância de Persistência em Settings > Push & In-App > Web.
Custom Code: Defina persistNotification no OneSignal.init(). A alternância do dashboard não se aplica. Veja persistNotification.

Mudanças na persistência só entram em vigor para inscritos que visitarem seu site após a atualização. Se você não vir a mudança, aguarde os inscritos revisitarem seu site ou peça a eles que limpem os dados do navegador.

Certificado .p12 do Safari Web Push (opcional, legado)

Deixe isso desativado a menos que você já tenha seu próprio certificado .p12 do Safari Web Push e queira dar suporte a usuários legados do Safari. O Safari moderno (macOS 13+ e iOS 16.4+) usa Web Push baseado em padrões com VAPID (Voluntary Application Server Identification). O OneSignal cuida do VAPID automaticamente. Você não faz upload de um certificado para esses navegadores. A Apple não oferece um token ou chave .p8 para web push do Safari. Apps nativos de iOS e macOS usam um .p8 para autenticar com o APNs. O web push do Safari não usa. A única credencial da Apple que se aplica ao Safari é um certificado .p12 do Safari Web Push, e apenas para o caminho legado de Website Push ID. Esse caminho legado ainda se aplica a:

Safari no macOS 12 e anteriores (sem VAPID)
Inscritos existentes que já concederam permissão através da API mais antiga do Safari (o Safari não migra essas inscrições para VAPID)

O OneSignal ainda pode fornecer um certificado para esse caminho legado remanescente. Um .p12 fornecido pelo cliente não é usado para novos inscritos no Safari 16.4+ (macOS 13+ ou iOS 16.4+). Essas inscrições usam VAPID. Se você já tem seu próprio certificado, habilite Safari Web Push .p12 certificate (optional, advanced) em Settings > Push & In-App > Web > Advanced Push Settings. Faça upload do arquivo .p12 e da sua senha. Typical Site e Custom Code definem isso no dashboard. Você não define isso no OneSignal.init().

Alternância e campos para upload do certificado .p12 do Safari Web Push em Advanced Push Settings — Certificado .p12 do Safari Web Push (opcional, legado)

Fazer upload do arquivo service worker

Adicione o arquivo service worker OneSignalSDKWorker.js ao seu site. Baixe-o do dashboard do OneSignal, ou crie um arquivo chamado OneSignalSDKWorker.js com esta única linha:

importScripts("https://cdn.onesignal.com/sdks/web/v16/OneSignalSDK.sw.js");

Passo de download e configuração do arquivo service worker do OneSignal — Passo de upload do arquivo service worker

O Web SDK procura este arquivo na raiz do seu site, a menos que você informe o contrário. Esta página é sobre Typical Site, então você corresponde a localização do arquivo no dashboard. Se você selecionou Custom Code, defina o caminho no OneSignal.init() em vez disso. Veja Configuração Custom Code. Raiz (padrão): Faça upload do arquivo para que ele esteja disponível em https://yourdomain.com/OneSignalSDKWorker.js. Mantenha as configurações de caminho do service worker inalteradas. O SDK requisita essa URL automaticamente. Subdiretório: Se seu site já tem um service worker (por exemplo, um PWA), coloque o arquivo do OneSignal em um subdiretório como /push/onesignal/ para que ele não entre em conflito com o worker que controla /. Então informe ao SDK onde procurar: siga Service workers e habilite Customize service worker paths and filenames. Defina Path to service worker files e Service worker registration scope para esse subdiretório (por exemplo /push/onesignal/). O arquivo deve estar publicamente acessível em https://yourdomain.com/push/onesignal/OneSignalSDKWorker.js.

Se o arquivo não estiver na raiz do site e você não definir esses campos no dashboard, o SDK continuará buscando https://yourdomain.com/OneSignalSDKWorker.js e o registro do service worker falhará. Configurações Custom Code devem definir serviceWorkerPath no OneSignal.init() em vez desses campos do dashboard.

Uma vez que o arquivo esteja no seu servidor, verifique o seguinte para garantir que funciona:

Verifique a localização

Visite a URL que o SDK está configurado para usar. Se você manteve as configurações padrão, essa URL é a raiz do site. Se você personalizou o caminho, ela deve corresponder a Path to service worker files mais o nome do arquivo:

Padrão: https://yourdomain.com/OneSignalSDKWorker.js
Exemplo de subdiretório: https://yourdomain.com/push/onesignal/OneSignalSDKWorker.js

Deve ser publicamente acessível na sua origem

O arquivo OneSignalSDKWorker.js deve ser publicamente acessível e disponível na sua origem. Não pode ser hospedado via CDN ou colocado em uma origem diferente com redirecionamento.Quando você visitar a URL para o arquivo, você deve ver o código.

Deve ser servido com content-type: application/javascript

Este é um arquivo JavaScript e precisa ser servido como tal. Não pode ter um content-type de text/html.

Service worker do OneSignal

Configuração avançada e migração de outros provedores de web push.

Adicione código ao seu site

Para inicializar o OneSignal no seu site com o SDK JavaScript, copie o código fornecido nas tags <head> do seu website. O dashboard do OneSignal fornece o mesmo trecho pré-preenchido com seu app ID. Se você carrega scripts com o Google Tag Manager, pare aqui e siga a configuração do Google Tag Manager. Aquele guia usa este trabalho de dashboard e service worker, e então inicializa o SDK no GTM em vez de colar o trecho abaixo.

HTML

<script src="https://cdn.onesignal.com/sdks/web/v16/OneSignalSDK.page.js" defer></script>
<script>
  window.OneSignalDeferred = window.OneSignalDeferred || [];
  OneSignalDeferred.push(async function(OneSignal) {
    await OneSignal.init({
      appId: "YOUR_ONESIGNAL_APP_ID",
    });
  });
</script>

Suporte de web push para iOS

A Apple começou a suportar notificações web push em iPhones e iPads rodando iOS 16.4+. Diferente de dispositivos Android, onde web push funciona em um navegador suportado sem configuração extra, a Apple exige um arquivo manifest.json e uma ação do usuário para adicionar seu site à Tela de Início.

Configuração de web push para iOS

Adicione o arquivo manifest.json necessário e guie usuários a adicionar seu site à tela de início deles.

Testando a integração do OneSignal SDK

Este guia ajuda você a verificar se sua integração do OneSignal SDK está funcionando corretamente testando notificações push e registro de inscrição.

Verifique inscrições de web push

Inicie seu site em um dispositivo de teste.

Use Chrome, Firefox, Edge ou Safari durante os testes.
Não use modo Incógnito ou navegação privada. Usuários não podem se inscrever em notificações push nestes modos.
Os prompts devem aparecer baseados na sua configuração de permission prompts.
Clique em Allow no prompt nativo para se inscrever em notificações push.

Prompt de permissão nativo do navegador perguntando ao usuário se permite ou bloqueia notificações — Prompt de permissão nativo de web push

Verifique seu dashboard OneSignal

Vá para Audience > Subscriptions.
Você deve ver uma nova entrada com o status Subscribed.

Você criou com sucesso uma inscrição de web push. Inscrições de web push são criadas quando usuários se inscrevem pela primeira vez em notificações push no seu site.

Configure inscrições de teste

Inscrições de teste são úteis para testar uma notificação push antes de enviar uma mensagem.

Adicione a Test Users.

No dashboard, próximo à inscrição, clique no botão Options (três pontos) e selecione Add to Test Users.

Menu de opções em uma inscrição mostrando a opção Adicionar a Test Users — Adicionando um dispositivo a Test Users

Nomeie sua inscrição.

Nomeie a inscrição para que você possa identificar facilmente seu dispositivo depois na aba Test Users.

Crie um segmento de usuários de teste.

Vá para Audience > Segments > New Segment.

Nomeie o segmento.

Nomeie o segmento Test Users (o nome é importante porque será usado depois).

Adicione o filtro Test Users e clique em Create Segment.

Editor de segmento com filtro Test Users selecionado e segmento nomeado Test Users — Criando um segmento 'Test Users' com o filtro Test Users

Você criou com sucesso um segmento de usuários de teste. Agora podemos testar enviar mensagens para este dispositivo individual e grupos de usuários de teste.

Envie push de teste via API

Obtenha seu App API Key e App ID.

No seu dashboard OneSignal, vá para Settings > Keys & IDs.

Atualize o código fornecido.

Substitua YOUR_APP_API_KEY e YOUR_APP_ID no código abaixo com suas chaves reais. Este código usa o segmento Test Users que criamos anteriormente.

curl -X \
POST --url 'https://api.onesignal.com/notifications' \
 --header 'content-type: application/json; charset=utf-8' \
 --header 'authorization: Key YOUR_APP_API_KEY' \
 --data \
 '{
  "app_id": "YOUR_APP_ID",
  "target_channel": "push",
  "name": "Testing basic setup",
  "headings": {
  	"en": "👋"
  },
  "contents": {
    "en": "Hello world!"
  },
  "included_segments": [
    "Test Users"
  ],
  "chrome_web_image": "https://avatars.githubusercontent.com/u/11823027?s=200&v=4"
}'

Execute o código.

Execute o código no seu terminal.

Verifique imagens e entrega confirmada.

Se todos os passos de configuração foram completados com sucesso, as inscrições de teste devem receber uma notificação.

Apenas Chrome suporta imagens. Imagens aparecerão pequenas na visualização de notificação recolhida. Expanda a notificação para ver a imagem completa.

Notificação push expandida no Chrome macOS exibindo uma imagem personalizada — Notificação push expandida com imagem no Chrome macOS

Verifique por entrega confirmada.

No seu dashboard, vá para Delivery > Sent Messages, depois clique na mensagem para ver as estatísticas. Você deve ver a estatística confirmed, significando que o dispositivo recebeu o push.

Safari não suporta Entrega Confirmada.

Relatórios de mensagens de notificação push

Veja estatísticas de entrega, clique e conversão para suas notificações push.

Você enviou com sucesso uma notificação via API para um segmento.

Se as notificações não estiverem chegando, contate support@onesignal.com com o seguinte:

A requisição e resposta da API (copie e cole em um arquivo .txt)
Seu Subscription ID
A URL do seu website com o código OneSignal

Identificação de usuário

A seção anterior cobriu a criação de Inscrições de web push. Esta seção expande para identificar Usuários através de todas as suas inscrições (incluindo push, email e SMS) usando o OneSignal SDK. Cobre External IDs, tags, inscrições multicanal, privacidade e rastreamento de eventos para ajudá-lo a unificar e engajar usuários em todas as plataformas.

Atribua External ID

Use um External ID para identificar usuários consistentemente através de dispositivos, endereços de email e números de telefone usando o identificador de usuário do seu backend. Isso garante que suas mensagens permaneçam unificadas através de canais e sistemas de terceiros (especialmente importante para Integrações). Defina o External ID com o método login do SDK cada vez que um usuário é identificado pelo seu app.

OneSignal gera IDs únicos somente leitura para inscrições (Subscription ID) e usuários (OneSignal ID).À medida que usuários baixam seu app em diferentes dispositivos, se inscrevem no seu website e/ou fornecem endereços de email e números de telefone fora do seu app, novas inscrições serão criadas.Definir o External ID via o SDK é altamente recomendado para identificar usuários através de todas as suas inscrições, independentemente de como elas são criadas.

Adicione Tags

Tags são pares chave-valor de dados string que você pode usar para armazenar propriedades de usuário (como username, role ou preferências) e eventos (como purchase_date, game_level ou interações de usuário). Tags potencializam Personalização de Mensagem avançada e Segmentação permitindo casos de uso mais avançados. Defina tags com os métodos addTag e addTags do SDK conforme eventos ocorrem no seu app. Neste exemplo, o usuário alcançou o nível 6 identificável pela tag chamada current_level definida com um valor de 6.

Um perfil de usuário no OneSignal com uma tag chamada "current_level" definida como "6"

Podemos criar um segmento de usuários que têm um nível entre 5 e 10, e usar isso para enviar mensagens direcionadas e personalizadas:

Editor de segmento mostrando um segmento direcionado a usuários com um valor current_level maior que 4 e menor que 10

Captura de tela mostrando uma notificação push direcionada ao segmento Nível 5-10 com uma mensagem personalizada

Adicione inscrições de email e/ou SMS

O OneSignal SDK cria inscrições de web push automaticamente quando os usuários optam por receber. Você também pode alcançar usuários através de canais de email e SMS criando as inscrições correspondentes.

Use o método addEmail para criar inscrições de email.
Use o método addSms para criar inscrições de SMS.

Se o endereço de email e/ou número de telefone já existem no app OneSignal, o SDK adicionará ao usuário existente, não criará duplicatas. Você pode visualizar usuários unificados via Audience > Users no dashboard ou com a API View user.

Um perfil de usuário com inscrições push, email e SMS unificadas por External ID

Melhores práticas para comunicação multicanal

Obtenha consentimento explícito antes de adicionar inscrições de email ou SMS.
Explique os benefícios de cada canal de comunicação aos usuários.
Forneça preferências de canal para que usuários possam selecionar quais canais eles preferem.

Privacidade e consentimento do usuário

Para controlar quando OneSignal coleta dados de usuário, use os métodos de controle de consentimento do SDK:

setConsentRequired(true): Previne coleta de dados até que consentimento seja dado.
setConsentGiven(true): Habilita coleta de dados uma vez que consentimento é concedido.

Para mais sobre privacidade e segurança:

Dados coletados pelo SDK

Revise quais dados o OneSignal SDK coleta dos usuários.

Tratamento de dados pessoais

Gerencie e proteja dados de usuários em conformidade com regulamentações de privacidade.

Escute eventos de push, usuário e in-app

Use listeners do SDK para reagir a ações de usuário e mudanças de estado. O SDK fornece vários event listeners para você conectar. Veja nosso guia de referência do SDK para mais detalhes.

Eventos de notificação push

Click event listener: Detecte quando uma notificação é tocada.
Foreground lifecycle listener: Controle como notificações se comportam em foreground.

Mudanças de estado do usuário

User state change event listener: Detecte quando o External ID é definido.
Permission observer: Rastreie a interação específica do usuário com o prompt de permissão push nativo.
Push subscription change observer: Rastreie quando o status de inscrição push muda.

Configuração avançada e capacidades

Explore mais capacidades para melhorar sua integração:

Migrando para o OneSignal

Migre de outro provedor de push para o OneSignal.

Integrações

Conecte o OneSignal com ferramentas e plataformas de terceiros.

Botões de ação

Adicione botões interativos às notificações push.

Mensagens multilíngues

Envie mensagens localizadas aos usuários no idioma de sua preferência.

Verificação de Identidade

Proteja sua integração do SDK com verificação de identidade no servidor.

Custom Outcomes

Rastreie eventos de conversão personalizados vinculados às suas mensagens.

Configuração e referência do Web SDK

Configuração de web push

Habilite todos os recursos principais de web push para sua integração.

Referência do Web SDK

Detalhes completos sobre métodos disponíveis e opções de configuração.

Parabéns! Você completou com sucesso o guia de configuração do Web SDK.

FAQ

O web push funciona em sites HTTP?

Não. O web push requer HTTPS. Os navegadores impõem isso como requisito de segurança. A única exceção é localhost e 127.0.0.1, que os navegadores tratam como origens seguras para fins de desenvolvimento.

Por que preciso de um arquivo service worker?

O service worker é executado em segundo plano e lida com notificações push recebidas mesmo quando o usuário não tem seu site aberto. Sem ele, o navegador não consegue exibir notificações. O arquivo OneSignalSDKWorker.js deve ser publicamente acessível na sua origem.

Onde o Web SDK procura o service worker?

O Web SDK procura o OneSignalSDKWorker.js na raiz do seu site (https://yourdomain.com/OneSignalSDKWorker.js), a menos que você defina um caminho personalizado. Typical Site define o caminho no dashboard: habilite Customize service worker paths and filenames em Settings > Push & In-App > Web > Advanced Push Settings. Custom Code não usa esses campos do dashboard. Passe serviceWorkerPath e serviceWorkerParam no OneSignal.init(). Veja Configuração Custom Code.

Devo usar este guia se meu site está no WordPress ou Shopify?

Não. Use a configuração do WordPress ou a configuração do Shopify. Essas integrações adicionam o SDK e o service worker para você.

Qual é a diferença entre Typical Site e Custom Code?

Typical Site é o caminho recomendado nesta página: você configura prompts, a maioria das configurações e o caminho do service worker no dashboard do OneSignal, e então adiciona o trecho JavaScript. Custom Code é para controle programático. Você define prompts, opções de init e o caminho do service worker no código com serviceWorkerPath e serviceWorkerParam. Veja Configuração Custom Code.

Preciso fazer upload de um certificado Safari?

Não, não para o Safari no macOS 13+ ou iOS 16.4+. O OneSignal usa VAPID automaticamente. Faça upload de um .p12 do Safari Web Push apenas para o caminho legado de Website Push ID (macOS 12 e anteriores, além de inscritos legados existentes). Veja Certificado .p12 do Safari Web Push.

Posso usar uma chave .p8 para web push do Safari?

Não. A Apple não oferece um token ou chave .p8 para web push do Safari. Use um .p8 apenas para apps nativos de iOS ou macOS. Veja Conexão baseada em token .p8 do iOS com o APNs. A única credencial do Safari é um .p12 do Safari Web Push, e apenas para o caminho legado.

Posso usar web push no iOS (iPhone/iPad)?

Sim, a partir do iOS 16.4+. No entanto, a Apple exige um arquivo manifest.json e o usuário deve adicionar seu site à tela de início primeiro. Veja Configuração de web push para iOS para os requisitos completos. O web push do iOS usa VAPID. Você não faz upload de um .p12 do Safari nem de um .p8 para ele.

Por que minhas notificações não estão aparecendo?

Causas comuns incluem um arquivo service worker colocado incorretamente, uma Site URL incompatível no dashboard, ou o usuário ter notificações bloqueadas nas configurações do navegador. Veja Web push: notificações não exibidas para uma lista completa de solução de problemas.

Precisa de ajuda?Converse com nossa equipe de Suporte ou envie email para support@onesignal.comPor favor inclua:

Detalhes do problema que você está enfrentando e passos para reproduzir se disponível
Seu OneSignal App ID
O External ID ou Subscription ID se aplicável
A URL para a mensagem que você testou no Dashboard OneSignal se aplicável
Quaisquer logs ou mensagens de erro relevantes

Estamos felizes em ajudar!

Configuração do WordPress

Configuração do Shopify

Configuração Custom Code

​Requisitos

​Configure seu app e plataforma OneSignal

Typical Site (recomendado)

WordPress

Custom Code

​Configuração do site

​Site URL

​Testes locais

​Prompt de permissões

Prompts de permissão web

​Notificação de boas-vindas (opcional)

​Configurações avançadas

​Webhooks

Webhooks de web push

​Service workers

​Comportamento de clique

URLs, links e deep linking

Botões de ação

Listeners de eventos push do Web SDK

​Persistência

​Certificado .p12 do Safari Web Push (opcional, legado)

​Fazer upload do arquivo service worker

Service worker do OneSignal

​Adicione código ao seu site

​Suporte de web push para iOS

Configuração de web push para iOS

​Testando a integração do OneSignal SDK

​Verifique inscrições de web push

​Configure inscrições de teste

​Envie push de teste via API

Relatórios de mensagens de notificação push

​Identificação de usuário

​Atribua External ID

​Adicione Tags

​Adicione inscrições de email e/ou SMS

​Privacidade e consentimento do usuário

Dados coletados pelo SDK

Tratamento de dados pessoais

​Escute eventos de push, usuário e in-app

​Eventos de notificação push

​Mudanças de estado do usuário

​Configuração avançada e capacidades

Migrando para o OneSignal

Integrações

Botões de ação

Mensagens multilíngues

Verificação de Identidade

Custom Outcomes

​Configuração e referência do Web SDK

Configuração de web push

Referência do Web SDK

​FAQ

​O web push funciona em sites HTTP?

​Por que preciso de um arquivo service worker?

​Onde o Web SDK procura o service worker?

​Devo usar este guia se meu site está no WordPress ou Shopify?

​Qual é a diferença entre Typical Site e Custom Code?

​Preciso fazer upload de um certificado Safari?

​Posso usar uma chave .p8 para web push do Safari?

​Posso usar web push no iOS (iPhone/iPad)?

​Por que minhas notificações não estão aparecendo?

Requisitos

Configure seu app e plataforma OneSignal

Configuração do site

Site URL

Testes locais

Prompt de permissões

Notificação de boas-vindas (opcional)

Configurações avançadas

Webhooks

Service workers

Comportamento de clique

Persistência

Certificado .p12 do Safari Web Push (opcional, legado)

Fazer upload do arquivo service worker

Adicione código ao seu site

Suporte de web push para iOS

Testando a integração do OneSignal SDK

Verifique inscrições de web push

Configure inscrições de teste

Envie push de teste via API

Identificação de usuário

Atribua External ID

Adicione Tags

Adicione inscrições de email e/ou SMS

Privacidade e consentimento do usuário

Escute eventos de push, usuário e in-app

Eventos de notificação push

Mudanças de estado do usuário

Configuração avançada e capacidades

Configuração e referência do Web SDK

FAQ

O web push funciona em sites HTTP?

Por que preciso de um arquivo service worker?

Onde o Web SDK procura o service worker?

Devo usar este guia se meu site está no WordPress ou Shopify?

Qual é a diferença entre Typical Site e Custom Code?

Preciso fazer upload de um certificado Safari?

Posso usar uma chave .p8 para web push do Safari?

Posso usar web push no iOS (iPhone/iPad)?

Por que minhas notificações não estão aparecendo?