Data feeds

• Saldo de recompensas atual de um usuário
• Status de pedido mais recente
• Recomendações personalizadas de produtos

​

Como funcionam os Data Feeds

1. Criar um Data Feed – Configure como o OneSignal se conecta à sua API.
2. Anexar o Data Feed a um template de mensagem.
3. Inserir campos de resposta na sua mensagem usando sintaxe Liquid.
4. No momento do envio, o OneSignal faz uma chamada de API para cada destinatário, analisa a resposta e injeta os dados na sua mensagem.

​

Exemplo: Exibir pontos de recompensa

Olá {{ first_name }},

Você tem {{ data_feed.rewards.points }} pontos!
Seu status de membro é {{ data_feed.rewards.status_level }}.

Continue comprando para ganhar mais pontos!

​

Criando e usando um Data Feed

​

1. Configurar sua configuração de Data Feed

• Name: Um nome descritivo como “Customer Rewards API” para ajudá-lo a distingui-lo na sua lista de feeds. Recomendamos que sejam únicos, mas não é obrigatório.
• Alias: Um nome curto como rewards que você usará na sintaxe Liquid. Estes devem ser únicos, não conter espaços e só podem conter caracteres alfanuméricos minúsculos sem símbolos especiais.
• Method: Como devemos contatar sua API. Geralmente isso é GET, mas POST também é suportado.
• URL: O endereço da API. Você pode incluir sintaxe Liquid, permitindo-nos chamar a API para buscar dados específicos do usuário.

https://acme.com/customers/user_id={{ external_id }}/rewards

• Headers: Insira pares chave-valor de cabeçalho conforme necessário pelas especificações da sua API. Um uso importante típico será incluir informações de autenticação. Esses campos também suportam sintaxe Liquid caso seja necessário.
• Body: Se sua API exigir, você pode incluir um body na solicitação em formato JSON. Este editor suporta sintaxe Liquid, assim como Webhooks de Journey.

{
	"customer_id": "{{ external_id }}"
}

Exemplo de configuração de Data Feed

​

2. Anexar o Data Feed ao seu template de mensagem

1. Navegue até Messages > Templates
2. Na seção Message, selecione o botão Personalization

Opções do botão de personalização

3. Ative Data Feeds e selecione seu feed

Seção Data Feeds no compositor de mensagens

4. Salve seu template

​

3. Usar os dados na sua mensagem

{
	"external_id": a1-b2c3,
	"points": 193,
	"status_level": "Gold"
}

Você tem {{ data_feed.rewards.points }} pontos!
Seu status de membro é {{ data_feed.rewards.status_level }}.

• Use um Data Feed
• Use o Data Feed rewards
  • Lembre-se: o feed rewards sabe chamar a API com o external_id do destinatário
• Da resposta, insira o valor do item points (193) e do item status_level (Gold)

​

Requisitos e limites

• Aceitar autenticação de etapa única com tokens de autenticação em cabeçalhos
• Responder rapidamente. Menos de 250ms recomendado (isso afeta diretamente a velocidade de envio)
• Retornar JSON. Outros formatos não são suportados neste momento.
  • Se você tem um caso de uso que depende de um formato alternativo, queremos ouvir de você! Preencha esta breve pesquisa aqui.
• Lidar com seu volume e taxa de envio de mensagens. Se sua API tem um limite de taxa baixo, isso impedirá que entreguemos suas mensagens rapidamente.
• Retornar payloads de tamanho razoável. Recomendamos manter as respostas abaixo de 50kb para melhor performance.

• Um Data Feed por template. Esperamos aumentar esse limite no futuro. Preencha esta breve pesquisa aqui para nos informar que você precisa disso.
• Uma chamada de API por Data Feed por mensagem. Busque tudo o que você precisa em uma chamada.
• Apenas Journeys. Ainda não disponível para outros métodos de envio. Preencha esta breve pesquisa aqui para nos informar que você precisa disso.
• Sem encadeamento de chamadas. O payload de um Data Feed não pode ser usado para chamar outro.

​

Configurando sua API

​

Autenticação

Authorization: Bearer YOUR_TOKEN

X-API-Key: YOUR_KEY

​

Body de solicitação JSON

​

Resposta JSON

​

Parâmetros de personalização

https://api.example.com/users/{{external_id}}/data
https://api.example.com/rewards?email={{email | url_encode}}

{
	"customer_id": "{{ external_id }}",
	"email": "{{ subscription.email }}"
}

​

Limites de taxa

​

Tratamento de erros

​

Checklist de primeiros passos

• Quais dados eu quero mostrar na minha mensagem? Trabalhar de trás para frente a partir de um esboço simples com os itens a serem preenchidos pela sua API identificados ajudará você a organizar seu pensamento.
• Esses dados estão disponíveis através de um único endpoint de API?
• Como vou autenticar solicitações de API?
• Qual identificador ou outro item de dados vou usar para buscar dados personalizados?
• Esse identificador já está armazenado no OneSignal? Se não, como será preenchido?
• Minha API pode lidar com o volume de solicitações que vou gerar?
• O que acontece se minha API não tiver dados para um usuário?

​

Exemplos e casos de uso avançados

​

Iterando com loops: carrinho abandonado

{
  "items": [
    {
      "name": "Blue Running Shoes",
      "price": 84.00,
      "image_url": "https://acme.com/blue-running-shoes.png"
    },
    {
      "name": "Protein Bar",
      "price": 5.99,
      "image_url": "https://acme.com/protein-bar.png"
    }
  ],
  "total": 89.99
}

<ul>
  {% for item in data_feed.cart.items %}
    <li>
      <strong>{{ item.name }}</strong><br>
      ${{ item.price }}<br>
      <img src="{{ item.image_url }}" alt="{{ item.name }}">
    </li>
  {% endfor %}
</ul>

<p>Cart total: ${{ data_feed.cart.total }}</p>

- Blue Running Shoes
- $84.00
- <imagem de tênis de corrida>
- Protein Bar
- $5.99
- <imagem de barra de proteína>
Cart total: $89.99

​

Propriedades de eventos personalizados

curl --request POST \
  --url https://api.onesignal.com/apps/{app_id}/custom_events \
  --header 'Accept: application/json' \
  --data '{
  "events": [
    {
      "name": "cart_abandoned",
      "external_id": "user_12345",
      "properties": {
        "cart_id": 98765
      }
    }
  ]
}'

Evento personalizado para entrada de Journey

https://acme.com/carts/{{ journey.event.cart_abandoned.data.cart_id }}

1. O valor cart_id de 98765 será armazenado na Journey
2. Quando a etapa de email for alcançada, o Data Feed cart referenciará aquele valor cart_id e o usará para chamar a API do carrinho
3. As propriedades JSON retornadas serão analisadas e inseridas no email como no exemplo anterior acima

​

Exibição condicional: status do pedido

Seu pedido está {{data_feed.order.status}}!

{% if data_feed.order.tracking_number != empty %}
Rastreie aqui: {{data_feed.order.tracking_url}}
{% endif %}

​

Automação sem personalização

https://acme.com/assets/email-banner

{
	"banner_url": "https://acme.com/assets/email-banner/2025july.png"
}

​

Solução de problemas

​

Meus dados não estão aparecendo

1. Verifique se seu Data Feed está anexado ao template
2. Verifique se sua sintaxe Liquid corresponde à sua estrutura JSON exatamente
3. Teste seu endpoint de API manualmente para garantir que está retornando dados
4. Verifique se o usuário tem as tags de dados necessárias (como external_id)

​

As mensagens estão sendo enviadas lentamente

1. Verifique o tempo de resposta da sua API
2. Certifique-se de que sua API pode lidar com solicitações simultâneas

​

Alguns destinatários não estão recebendo mensagens

1. Sua API pode não ter dados para esses usuários
2. Verifique o log de erros na configuração do Data Feed para 404s ou erros
3. Verifique os logs da sua API para 404s ou erros
4. Verifique se esses usuários têm os identificadores necessários no OneSignal