Mensagens
As mensagens no TagPushEvent são artefatos que representam os conteúdos que serão enviados nas notificações push.
Diferente da campanha em si, que define quando e em quais condições os envios acontecem, as mensagens definem o que será enviado ao usuário.
Uma campanha pode reutilizar uma ou mais mensagens pré-definidas, permitindo maior flexibilidade e reutilização de conteúdo.
Como funciona
- As mensagens são previamente cadastradas no sistema, como artefatos
- Cada mensagem define o conteúdo e comportamento da notificação;
- A campanha (TagPushEvent) seleciona quais mensagens utilizar;
- A campanha também define quando cada mensagem será enviada.
Campos
| Campo | Tipo | Obrigatório | Valor Padrão | Descrição |
|---|---|---|---|---|
| Nome | string | Sim | - | Identificador único da mensagem dentro do cliente |
| Título | string | Sim | - | Título principal da notificação |
| Corpo | string | Não | - | Texto complementar da notificação |
| Ícone | string | Não | - | URL do ícone exibido na notificação |
| Imagem | string | Não | - | URL de imagem exibida na notificação (quando suportado) |
| Badge | string | Não | - | URL do badge (geralmente monocromático, usado em Android) |
| Requer interação | boolean | Sim | false | Indica se a notificação deve permanecer até interação do usuário |
| Silencioso | boolean | Sim | false | Indica se a notificação será exibida sem som |
| Utiliza CTA | boolean | Sim | false | Define se a mensagem possui botão de ação (Call To Action) |
| Texto do CTA | string | Não | - | Texto exibido no botão de ação |
| Ícone do CTA | string | Não | - | Ícone exibido no botão de ação |
| Link | string | Não | - | URL aberta ao interagir com a notificação ou botão |
name
Identificador único da mensagem.
title
Título principal da notificação.
- É o texto de maior destaque;
- Deve ser claro e objetivo.
Exemplo:
"Você tem novidades!"
body
Conteúdo complementar da notificação.
- Campo opcional;
- Utilizado para fornecer mais contexto ao usuário.
Exemplo:
"Confira as novas ofertas disponíveis para você."
icon
URL do ícone da notificação.
- Geralmente exibido ao lado do título;
- Pode representar a marca ou o tipo de mensagem.
image
Imagem maior exibida na notificação.
- Opcional;
- Suportado apenas em alguns dispositivos/navegadores.
badge
Ícone de badge (geralmente monocromático).
- Utilizado principalmente em dispositivos Android;
- Representa a identidade visual da notificação.
requireInteraction
Define se a notificação deve permanecer visível até interação do usuário.
- true: a notificação não desaparece automaticamente;
- false: comportamento padrão do sistema.
Uso comum:
- Alertas importantes;
- Ações que exigem atenção imediata.
silent
Define se a notificação será exibida sem som.
- true: notificação silenciosa;
- false: notificação com som padrão.
useCTA
Indica se a mensagem utiliza um botão de ação (Call To Action).
- Quando true, os campos de CTA devem ser configurados.
titleCTA
Texto exibido no botão de ação.
- Utilizado quando useCTA = true.
Exemplo:
"Ver oferta"
iconCTA
Ícone exibido no botão de ação.
- Opcional;
- Pode reforçar visualmente a ação.
link
URL de destino ao interagir com a notificação ou CTA.
- Pode ser utilizado tanto no clique da notificação quanto no botão;
- Deve direcionar o usuário para uma página relevante.