Skip to main content

​
Por que este canal importa

Push é o jeito de cutucar o usuário de volta para o seu site ou app sem depender de SMS ou e-mail — ideal para lembrete de carrinho, “sua mesa está pronta” ou atualização em tempo quase real. A Notifique trata app, dispositivos e envio de forma uniforme: sua aplicação só precisa dos device IDs corretos e de uma API Key com os escopos certos.

​
O que você encontra no painel

  • Push Apps — criar o “produto” que agrupa credenciais (hoje Web com VAPID; outras plataformas conforme evolução do produto).
  • API Keys — escopos como push:apps:manage, push:devices:register, push:send e push:read, e opcionalmente restrição por pushAppIds.
  • Limites de plano — agendamento e volume seguem as regras da sua conta (como nos outros canais).

​
O que você encontra na API

  1. Criar app — POST /v1/push/apps (push:apps:manage).
  2. Registrar dispositivo — depois que o navegador ou SDK entrega a subscription ao seu front, seu backend chama POST /v1/push/devices com appId, platform e subscription (push:devices:register). A resposta traz o device ID que você usa no envio.
  3. Enviar — POST /v1/push/messages com to = lista de device IDs (até 100) e pelo menos title ou body.
  4. Agendamento e cancelamento — schedule.sendAt para agendar; cancelar só enquanto SCHEDULED.
  5. Idempotência — Idempotency-Key / x-idempotency-key no POST de mensagens.
Se a API Key tiver pushAppIds definidos, só dispositivos daqueles apps podem receber; caso contrário a API responde 403 (PUSH_APP_NOT_ALLOWED).
Resumo de escopos: push:apps:read e push:apps:manage para apps; push:devices:register para cadastrar dispositivos; push:send e push:read para disparar e consultar status.

​
Regras e status em resumo

  • Cobrança — cada notificação consome 1 crédito (plano) ou saldo em Pague pelo uso, validado no envio.
  • Prioridade — options.priority: high, normal ou low (padrão normal).
Status: QUEUED, SCHEDULED (cancelável), SENT, DELIVERED, CLICKED (quando o service worker reporta), FAILED, CANCELLED.

​
Próximos passos

  • Quick Start — fluxo app → dispositivo → envio
  • API Reference (Push) — OpenAPI com schemas e exemplos