Identificadores chave da API

Este post lista os identificadores essenciais usados nas solicitações da API Pushwoosh. Esses identificadores são necessários para autenticação, criação de mensagens, segmentação, rastreamento e gerenciamento de usuários em seus aplicativos.

Identificadores gerais

Código do aplicativo

Um identificador único atribuído a cada aplicativo em sua conta Pushwoosh. É necessário na maioria das chamadas de API para especificar o aplicativo de destino.

Onde encontrá-lo

Painel de Controle da Pushwoosh → Abaixo do nome do aplicativo.

Token de acesso à API

Um token único atribuído a uma conta Pushwoosh, usado para autenticar solicitações de API. Ele permite o acesso para gerenciar projetos, enviar mensagens, modificar configurações e recuperar dados. Cada conta tem pelo menos um token criado por padrão. Saiba mais

Onde encontrá-lo

Painel de Controle da Pushwoosh → Acesso à API.

Identificadores de dispositivo

ID de Hardware (HWID)

Um identificador único atribuído a um dispositivo pelo SDK da Pushwoosh. Definido automaticamente pelo SDK ou passado durante o registro do dispositivo. Saiba mais

Onde encontrá-lo

Nos logs do dispositivo. Saiba mais
No User Explorer ao pesquisar por ID do Usuário
No arquivo CSV baixado da lista de Segmentos

Token de push

Um token emitido pelos provedores de plataforma que identifica um par aplicativo-dispositivo para a entrega de notificações push. Coletado automaticamente pelo SDK quando as permissões de push são concedidas. Saiba mais

Onde encontrá-lo

Nos logs do dispositivo. Saiba mais
No User Explorer, insira o HWID no campo de busca para encontrar o dispositivo associado, depois abra os detalhes do dispositivo para visualizar o token de push.

Tipo de dispositivo

Indica a plataforma do dispositivo de destino usando um código numérico. Definido automaticamente pelo SDK.

Valores suportados:

1 – iOS
3 – Android
7 – macOS
8 – Windows
9 – Amazon
10 – Safari
11 – Chrome
12 – Firefox
13 – Internet Explorer
14 – Email
17 – Huawei
18 – SMS
20 – Web
21 – WhatsApp
22 – Line
23 – Kakao Talk
24 – Telegram
25 – Apple Wallet
26 – Google Wallet
27 – Viber

Identificadores de usuário

ID do Usuário

Um identificador personalizado atribuído a um usuário, permitindo a segmentação entre dispositivos e personalizada. Saiba mais

Onde encontrá-lo

Painel de Controle da Pushwoosh → Público → User Explorer

Identificadores de mensagens

Código da mensagem

Um identificador único atribuído a cada mensagem no momento da sua criação. Ele segue um formato específico: XXXX-XXXXXXXX-XXXXXXXX.

Este código é essencial para:

Rastrear o status e a entrega de uma mensagem específica
Cancelar (ou excluir) uma mensagem enviada anteriormente
Obter estatísticas da mensagem

Onde encontrá-lo

Painel de Controle da Pushwoosh: Navegue até Campanhas → Mensagens únicas, depois abra as propriedades da mensagem desejada. O Código da Mensagem será exibido lá.
Resposta da API /createMessage: Ao criar uma nova mensagem via API, o Código da Mensagem é incluído na resposta.

ID da Solicitação (Request ID)

Correlaciona uma mensagem com a solicitação HTTP que a criou, permitindo que você rastreie um único envio de ponta a ponta — da chamada HTTP, passando pela camada de roteamento da Pushwoosh, até a mensagem resultante.

Presente em qualquer mensagem criada por uma chamada HTTP para /createMessage ou API de Mensagens v2, incluindo mensagens enviadas do Painel de Controle. Mensagens criadas por Journeys, envios agendados (cron) ou outros gatilhos internos não-HTTP não possuem um ID de Solicitação.

Definindo seu próprio valor

Passe um cabeçalho X-Request-ID com a solicitação. Se o valor tiver de 8 a 128 caracteres e contiver apenas letras latinas, dígitos, pontos, sublinhados e hífens, a Pushwoosh o reutiliza; caso contrário — ou se o cabeçalho for omitido — a Pushwoosh gera um para você. Um valor inválido é substituído silenciosamente, então a solicitação nunca falha por causa disso. A unicidade não é imposta, então use um valor que seja realmente único por solicitação se você depender dele para rastreamento.

Onde encontrá-lo

Painel de Controle da Pushwoosh → abra uma mensagem → Detalhes da Mensagem → Mostrar todas as propriedades → Configurações da mensagem → ID da Solicitação (com um botão de copiar).

Exemplo: a1b2c3d4e5f64a7b8c9d0e1f2a3b4c5d

Código do In-App

Um código único que identifica uma campanha de in-app instantâneo. Onde encontrá-lo

Painel de Controle da Pushwoosh → Campanhas → In-apps instantâneos. Na lista, o código é exibido abaixo do nome da campanha.

Exemplo: AAAAA-BBBBB

Identificadores de conteúdo

Código da predefinição

Um identificador para uma predefinição de mensagem salva (por exemplo, push ou SMS). Saiba mais

Onde encontrá-lo

Painel de Controle da Pushwoosh → Conteúdo → Predefinições.

Você pode encontrar o código da predefinição em dois lugares:

Na visualização de lista, exibido abaixo do nome da predefinição.
Na URL ao editar ou criar uma predefinição (é a última parte da URL).

Exemplo:

URL: https://app.pushwoosh.com/applications/XXXXX-XXXXX/sms-presets/edit/AAAAA-BBBBB

Código da predefinição: AAAAA-BBBBB

Código de Rich Media

Identificador para um modelo de mensagem in-app. Saiba mais

Onde encontrá-lo

Painel de Controle da Pushwoosh → Conteúdo → Rich media.

Exemplo: URL: https://app.pushwoosh.com/applications/XXXXX-XXXXX/rich-media/AAAAA-BBBBB/statistics Código de Rich Media: AAAAA-BBBBB

Código de conteúdo de e-mail

O código de conteúdo de e-mail é um identificador único para o conteúdo de e-mail salvo. Saiba mais

Onde encontrá-lo

Painel de Controle da Pushwoosh → Conteúdo → Conteúdo de e-mail.

O código é a última parte da URL.

Exemplo:

URL: https://app.pushwoosh.com/applications/XXXXX-XXXXX/email-content/edit/AAAAA-BBBBB Código de conteúdo de e-mail: AAAAA-BBBBB

Identificadores de campanha

Código da campanha

Um identificador único usado para referenciar uma campanha específica para rastreamento e análise.

Onde encontrá-lo

O código da campanha aparece na URL ao visualizar estatísticas relacionadas à campanha no Painel de Controle da Pushwoosh. Para localizá-lo, vá para Estatísticas → Estatísticas agregadas, clique na campanha desejada e copie o código encontrado no final da URL.

Exemplo:

URL: https://app.pushwoosh.com/applications/XXXXX-XXXXX/statistics/aggregated-message?campaignCode=YYYYY-YYYYY

Código da campanha: YYYYY-YYYYY

ID da Journey

Um identificador único usado para associar mensagens a campanhas de marketing específicas para rastreamento e análise de desempenho.

Onde encontrá-lo

Na URL da tela da campanha no Painel de Controle da Pushwoosh.
Selecione um ponto na tela e pressione Ctrl+I (Cmd+I) — isso copia <UUID da journey>/<UUID do ponto> para a área de transferência; o ID da Journey é a parte antes da barra.

Exemplo: URL: https://app.pushwoosh.com/journeys/XXXXX-XXXXX/1/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

ID da Journey: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

Identificadores de segmentação e direcionamento

Nome do Segmento / Filtro

O nome de um segmento de usuário predefinido criado na Pushwoosh para segmentação de público. Saiba mais

Onde encontrá-lo

Painel de Controle da Pushwoosh → Segmentos.

Código do Segmento / Filtro

Um código único no formato XXXXX-XXXXX que identifica um segmento (também chamado de filtro) na Pushwoosh. Este código é usado em chamadas de API, lógica de automação e regras de segmentação dinâmica.

Onde encontrá-lo

Através do método da API /listFilters.
Na barra de endereço ao visualizar um segmento no Painel de Controle da Pushwoosh:

Exemplo:

URL: https://app.pushwoosh.com/applications/XXXXX-XXXXX/segments/XXXE9-XXX49/detail Código do segmento: XXXE9-XXX49

Tag

Um atributo personalizado atribuído a usuários ou dispositivos. Usado para segmentação dinâmica e personalização. Saiba mais

Onde encontrá-lo

Painel de Controle da Pushwoosh → Tags ou via API /getTags.

Identificadores de eventos

Nome do evento

O nome de um evento rastreado (por exemplo, purchase, login, subscription). Usado para acionar fluxos de trabalho automatizados ou para análise. Saiba mais

Onde encontrá-lo

Painel de Controle da Pushwoosh → Público → Eventos.

Identificadores de geolocalização

ID da Geozone

Identifica uma área de geofence usada para acionar notificações baseadas em localização. Saiba mais

Onde encontrá-lo

Painel de Controle da Pushwoosh → Geozones.