Flux de données

• Le solde de récompenses actuel d’un utilisateur
• Le dernier statut de commande
• Des recommandations de produits personnalisées

​

Comment fonctionnent les flux de données

1. Créez un flux de données – Configurez la façon dont OneSignal se connecte à votre API.
2. Attachez le flux de données à un modèle de message.
3. Insérez les champs de réponse dans votre message en utilisant la syntaxe Liquid.
4. Au moment de l’envoi, OneSignal effectue un appel API pour chaque destinataire, analyse la réponse et injecte les données dans votre message.

​

Exemple : Afficher les points de récompense

Hi {{ first_name }},

You have {{ data_feed.rewards.points }} points!
Your membership status is {{ data_feed.rewards.status_level }}.

Keep shopping to earn more points!

​

Création et utilisation d’un flux de données

​

1. Configurez votre flux de données

• Nom : Un nom descriptif comme “API de récompenses client” pour vous aider à le distinguer dans votre liste de flux. Nous recommandons que ceux-ci soient uniques, mais ce n’est pas obligatoire.
• Alias : Un nom court comme rewards que vous utiliserez dans la syntaxe Liquid. Ceux-ci doivent être uniques, ne contenir aucun espace et ne peuvent contenir que des caractères alphanumériques en minuscules sans symboles spéciaux.
• Méthode : Comment nous devrions contacter votre API. Généralement, c’est GET mais POST est également pris en charge.
• URL : L’adresse de l’API. Vous pouvez inclure la syntaxe Liquid, ce qui nous permet d’appeler l’API pour récupérer des données spécifiques à l’utilisateur.

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

• En-têtes : Entrez les paires clé-valeur d’en-tête selon les spécifications de votre API. Une utilisation importante typique sera d’inclure des informations d’authentification. Ces champs prennent également en charge la syntaxe Liquid si nécessaire.
• Corps : Si votre API l’exige, vous pouvez inclure un corps dans la requête au format JSON. Cet éditeur prend en charge la syntaxe Liquid, tout comme les webhooks Journey.

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

Exemple de configuration de flux de données

​

2. Attachez le flux de données à votre modèle de message

1. Accédez à Messages > Templates
2. Dans la section Message, sélectionnez le bouton Personalization

Options du bouton de personnalisation

3. Activez Data Feeds et sélectionnez votre flux

Section des flux de données dans le compositeur de messages

4. Enregistrez votre modèle

​

3. Utilisez les données dans votre message

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

You have {{ data_feed.rewards.points }} points!
Your membership status is {{ data_feed.rewards.status_level }}.

• Utilisez un flux de données
• Utilisez le flux de données rewards
  • Rappel : le flux rewards sait appeler l’API avec l’external_id du destinataire
• À partir de la réponse, insérez la valeur de l’élément points (193) et de l’élément status_level (Gold)

​

Exigences et limites

• Accepter l’authentification en une seule étape avec des jetons d’authentification dans les en-têtes
• Répondre rapidement. Moins de 250 ms recommandé (cela affecte directement la vitesse d’envoi)
• Renvoyer du JSON. Les autres formats ne sont pas pris en charge pour le moment.
  • Si vous avez un cas d’utilisation reposant sur un format alternatif, nous voulons l’entendre de votre part ! Remplissez cette courte enquête ici.
• Gérer votre volume et votre taux d’envoi de messages. Si votre API a une limite de taux faible, cela nous empêchera de délivrer vos messages rapidement.
• Renvoyer des charges utiles de taille raisonnable. Nous recommandons de maintenir les réponses en dessous de 50 ko pour de meilleures performances.

• Un flux de données par modèle. Nous prévoyons d’augmenter cette limite à l’avenir. Remplissez cette courte enquête ici pour nous faire savoir que vous en avez besoin.
• Un appel API par flux de données par message. Récupérez tout ce dont vous avez besoin en un seul appel.
• Journeys uniquement. Pas encore disponible pour d’autres méthodes d’envoi. Remplissez cette courte enquête ici pour nous faire savoir que vous en avez besoin.
• Pas d’enchaînement d’appels. La charge utile d’un flux de données ne peut pas être utilisée pour appeler un autre.

​

Configuration de votre API

​

Authentification

Authorization: Bearer YOUR_TOKEN

X-API-Key: YOUR_KEY

​

Corps de requête JSON

​

Réponse JSON

​

Paramètres de personnalisation

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 taux

​

Gestion des erreurs

​

Liste de contrôle de démarrage

• Quelles données veux-je afficher dans mon message ? Travailler à rebours à partir d’un simple plan avec les éléments à remplir depuis votre API identifiés vous aidera à organiser votre réflexion.
• Ces données sont-elles disponibles via un seul point de terminaison API ?
• Comment vais-je authentifier les requêtes API ?
• Quel identifiant ou autre élément de données vais-je utiliser pour récupérer les données personnalisées ?
• Cet identifiant est-il déjà stocké dans OneSignal ? Si non, comment sera-t-il rempli ?
• Mon API peut-elle gérer le volume de requêtes que je vais générer ?
• Que se passe-t-il si mon API n’a pas de données pour un utilisateur ?

​

Exemples et cas d’utilisation avancés

​

Itération avec des boucles : panier abandonné

{
  "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
- <running shoes image>
- Protein Bar
- $5.99
- <protein bar image>
Cart total: $89.99

​

Propriétés d’événements personnalisés

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
      }
    }
  ]
}'

Événement personnalisé pour l'entrée dans le Journey

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

1. La valeur cart_id de 98765 sera stockée dans le Journey
2. Lorsque l’étape d’e-mail est atteinte, le flux de données cart référencera cette valeur cart_id et l’utilisera pour appeler l’API du panier
3. Les propriétés JSON renvoyées seront analysées et insérées dans l’e-mail comme dans l’exemple précédent ci-dessus

​

Affichage conditionnel : statut de commande

Your order is {{data_feed.order.status}}!

{% if data_feed.order.tracking_number != empty %}
Track it here: {{data_feed.order.tracking_url}}
{% endif %}

​

Automatisation sans personnalisation

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

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

​

Dépannage

​

Mes données ne s’affichent pas

1. Vérifiez que votre flux de données est attaché au modèle
2. Vérifiez que votre syntaxe Liquid correspond exactement à votre structure JSON
3. Testez votre point de terminaison API manuellement pour vous assurer qu’il renvoie des données
4. Vérifiez que l’utilisateur a les balises de données requises (comme external_id)

​

Les messages s’envoient lentement

1. Vérifiez le temps de réponse de votre API
2. Assurez-vous que votre API peut gérer les requêtes simultanées

​

Certains destinataires ne reçoivent pas de messages

1. Votre API pourrait ne pas avoir de données pour ces utilisateurs
2. Vérifiez le journal des erreurs dans la configuration du flux de données pour les erreurs 404 ou autres erreurs
3. Vérifiez vos journaux API pour les erreurs 404 ou autres erreurs
4. Vérifiez que ces utilisateurs ont les identifiants requis dans OneSignal