Event Streams

• Événements de messages push (envoyés, reçus, cliqués, échoués, désabonnés)
• Événements e-mail (envoyés, ouverts, cliqués, rebondis, désabonnés, etc.)
• Événements SMS (envoyés, échoués, désabonnés, etc.)
• Événements de messages in-app (impression, cliqués, etc.)
• Événements Live Activity (envoyés, livrés, livraison confirmée, échoués, désabonnés, cliqués)

​

Cas d’usage courants

• Centraliser les données d’engagement — Diffusez des événements vers un CRM, un CDP ou un entrepôt de données afin que l’activité multicanale (ouvertures, clics, rebonds) soit regroupée en un seul endroit plutôt que dispersée entre des outils déconnectés.
• Analyse, reporting et conformité — Enregistrez chaque événement de message dans un entrepôt pour l’analyse des tendances, l’audit ou la conservation des registres réglementaires.
• Surveiller le désengagement — Suivez les désabonnements, les rebonds et les rejets dans vos propres systèmes pour détecter les risques de rétention tôt.
• Déclencher des flux de travail externes — Lancez des automatisations dans d’autres outils lorsqu’un utilisateur ouvre ou clique sur un message (p. ex., mettre à jour un score de lead, démarrer une séquence de suivi).
• Remplacer les synchronisations par lots et les intégrations supplémentaires — Réagissez aux événements en temps réel et connectez OneSignal directement à votre destination, réduisant les outils intermédiaires et les coûts de maintenance.

​

Démarrer avec votre équipe technique

1. Décider de la destination et du périmètre — Convenir de l’endroit où les événements doivent arriver (votre propre API, un entrepôt de données, un CDP, etc.), des types d’événements à diffuser (push, e-mail, SMS, IAM, Live Activity) et d’une estimation du volume de messages pour dimensionner correctement l’endpoint.
2. Configurer un endpoint HTTP — Construire ou configurer un endpoint accessible publiquement qui accepte les requêtes POST. Il doit enregistrer les événements rapidement sans traitement lourd pour maintenir des temps de réponse bas. Consultez Nouvelles tentatives / Désactivation pour les attentes de performance et ce qui se passe lorsque l’endpoint prend du retard.
3. Configurer l’Event Stream dans OneSignal — Dans Données > Event Streams, sélectionnez les événements, définissez l’URL et les en-têtes d’authentification, et définissez le corps JSON en utilisant les champs de Données Event Streams avec la syntaxe Liquid.
4. Tester de bout en bout — Utilisez webhook.site pour vérifier la forme du payload et les en-têtes avant de basculer vers votre endpoint de production (voir Tests).

​

Configuration

• Une URL ou adresse IP valide pour un endpoint HTTP(S) accessible publiquement
• Les URL et adresses IP doivent être accessibles publiquement
• Les domaines doivent inclure un domaine de premier niveau reconnu (par ex. “.com”, “.net”)

​

Sélection d’événements

​

Filtres d’event stream

​

Configurer l’Event Stream

​

En-têtes d’authentification

• En-tête Authorization : Ajoutez un en-tête Authorization, où YOUR_TOKEN est fourni par votre système ou un tiers comme :
  • Basic {{YOUR_TOKEN}}
  • Bearer {{YOUR_TOKEN}}
  • ApiKey {{YOUR_API_KEY}}
• En-têtes personnalisés : Vous pouvez également ajouter des en-têtes personnalisés comme :
  • X-API-Key: {{YOUR_API_KEY}}

​

Tester votre configuration

​

En-têtes non autorisés

• content-length
• referer
• metadata-flavor
• x-google-metadata-request
• host
• x-onesignal*

​

Corps

​

Personnalisation

​

Exemple de corps

{
  "Event Data": {
    "event.kind": "{{ event.kind }}",
    "event.id": "{{ event.id }}",
    "event.timestamp": "{{ event.timestamp }}",
    "event.datetime": "{{ event.datetime }}",
    "event.app_id": "{{ event.app_id }}",
    "event.subscription_device_type": "{{ event.subscription_device_type }}",
    "event.subscription_id": "{{ event.subscription_id }}",
    "event.onesignal_id": "{{ event.onesignal_id }}",
    "event.external_id": "{{ event.external_id }}",
    "event.data.page_name": "{{ event.data.page_name}}",
    "event.data.page_id": "{{ event.data.page_id}}",
    "event.data.target_name": "{{ event.data.target_name}}",
    "event.data.target_id": "{{ event.data.target_id}}",
    "event.data.failure_reason": "{{ event.data.failure_reason}}"
  },
  "Message Data": {
    "message.id": "{{ message.id }}",
    "message.name": "{{ message.name }}",
    "message.title": "{{ message.title.en }}",
    "message.contents": "{{ message.contents.en }}",
    "message.template_id": "{{ message.template_id }}",
    "message.url": "{{ message.url }}",
    "message.app_url": "{{ message.app_url }}",
    "message.web_url": "{{ message.web_url }}"
  }
}

​

Utilisation de la syntaxe Liquid dans JSON

• Chaînes → Doivent être enveloppées dans des guillemets.
• Nombres → Ne doivent pas être enveloppés dans des guillemets.
• Objets → Ne doivent pas être enveloppés dans des guillemets.

{
  "user_id": "{{ user.onesignal_id }}"
}

{
  "user_id": {{ user.onesignal_id }}
}

{
  "user_score": {{ user.tags.score }}
}

{
  "user_score": "{{ user.tags.score }}"
}

{
  "user_data": {{ user.tags }}
}

{
  "user_data": "{{ user.tags }}"
}

1. Utilisez des vérifications de langue directes : Vérifiez toujours user.language directement dans les conditionnels, pas dans des variables comme userLang, pour une meilleure compatibilité.
2. Commencez simplement : Commencez par des phrases de base, puis ajoutez progressivement de la complexité.
3. Évitez l’imbrication excessive : Gardez les conditionnels plats pour éviter les problèmes d’analyse.
4. Testez d’abord la ponctuation de base : Commencez par des phrases simples et de la ponctuation avant d’utiliser des caractères spéciaux.
5. Utilisez des solutions de secours : Assurez-vous d’avoir une langue par défaut (par ex. anglais) en cas de traductions manquantes.
6. Tenez-vous-en aux clés standard : Utilisez des clés OneSignal standard comme content/title/en pour la fiabilité.

​

Résultats et débogage

​

Nouvelles tentatives / Désactivation

1. Les administrateurs d’application et d’organisation reçoivent un e-mail lorsque le volume d’échecs devient significatif (avant la désactivation) et à nouveau lorsque le stream est désactivé.
2. Une bannière apparaît également sur la page d’index des Event Streams dans le tableau de bord.
3. Corrigez le problème sous-jacent, testez avec l’onglet Logs ou webhook.site, et réactivez le stream.

• Enregistrez les événements rapidement — Écrivez l’événement entrant dans une file d’attente ou un magasin de données sans traitement inline lourd.
• Évitez les réponses lentes et les 429 — Des temps de réponse constamment lents ou des réponses de limite de débit entraînent l’accumulation d’événements, ce qui pousse OneSignal à désactiver le stream.
• Dimensionnez pour votre volume d’envoi — Si vous envoyez 100k messages, attendez jusqu’à 100k événements par type d’événement sélectionné. Consultez le volume de messages de votre plan et provisionnez en conséquence.

​

Conseils pour réussir

• Pointez d’abord les streams vers vos propres serveurs. Vous pouvez vous connecter directement à une API tierce, mais le débogage, la gestion des limites de débit et la gestion du volume sont plus difficiles lorsque vous ne contrôlez pas l’extrémité réceptrice.
• Mettez en mémoire tampon avant de transmettre à des tiers. OneSignal envoie des événements aussi vite que les utilisateurs les déclenchent — un envoi important peut produire une rafale qui dépasse les limites de débit externes ou fait monter les coûts (surtout avec les fournisseurs SMS). Créez un service léger qui accepte les événements, les met en file d’attente et les transmet aux API externes à un rythme que vous contrôlez.
• Consultez les docs API des tiers. De nombreux services exposent des API HTTP publiques que vous pouvez cibler avec un event stream. Recherchez leur documentation sur l’authentification, le format de payload accepté et les limites de débit avant de configurer votre stream.

​

Limitations des données d’événements de message

​

Tests

• Host : l’adresse IP d’où provient la requête. Voir Aperçu de l’API REST pour une liste des IP possibles.
• Request Content : les données envoyées dans le corps de l’event stream.