Les événements personnalisés déclenchent des workflows d'automatisation via l'API et transmettent des données supplémentaires pour la personnalisation. Chaque événement peut inclure des champs personnalisés, tels que des numéros de suivi, des détails sur le produit ou des liens d'examen, à utiliser dans le contenu du Workflow.
Alors que les déclencheurs standard (comme Commande passée ou Panier abandonné) couvrent des événements courants, les Événements personnalisés vous permettent d'automatiser des actions uniques telles que l'examen soumis ou le bon cadeau créé qui vont au-delà des déclencheurs intégrés d'Omnisend.
Avant de commencer
Lorsque vous intégrez votre boutique avec Omnisend, un ensemble de événements standard devient disponible, y compris Abonné au Marketing, Commande Passée et Panier abandonné. Si vous souhaitez déclencher un Workflow pour un type d'action différent, vous devrez utiliser un Custom event.
Les Événements Personnalisés peuvent être :
Créé manuellement via l'API, ou ;
Ajouté automatiquement via l'intégration avec une application tierce.
Omnisend prend en charge et recommande d'utiliser uniquement l'API v5 pour les événements personnalisés. Les versions antérieures, comme la v3, sont toujours fonctionnelles mais ne sont plus activement supportées.
Si vous n'avez jamais travaillé avec des API auparavant, nous vous recommandons fortement d'impliquer un développeur pour aider à configurer les Événements Personnalisés.
La documentation de l'API explique comment l'intégration fonctionne, mais un développeur est le mieux équipé pour l'implémenter correctement en utilisant les détails techniques fournis.
Les événements personnalisés n'apparaissent dans le menu déroulant des déclencheurs d'automatisation qu'après avoir été déclenchés au moins une fois.
Les événements personnalisés nécessitent un contact identifié (email ou numéro de téléphone) pour fonctionner. Les visiteurs anonymes renverront une erreur 400.
💡 Exemples d'Événements Personnalisés Ajoutés par des Outils Tiers
AfterShip : Info Reçue– Déclenche le workflow lorsqu'une commande est expédiée.
Champs personnalisés : numéro de suivi, URL de suivi.
Intercom : Revue créée– Déclenche le workflow lorsqu'un contact laisse un commentaire pour un agent de support.
Champs personnalisés : évaluation, contenu de la revue.
Growave: Liste de souhaits De nouveau en stock– Déclenche le workflow lorsque un article de la liste de souhaits est de nouveau en stock.
Champs personnalisés : détails du produit.
Junip : Revue créée– Déclenche le Workflow lorsqu'un avis sur un produit est soumis.
Champs personnalisés : informations sur le produit, lien de soumission de l'avis.
Créer un Custom event
Pour que le Custom event commence à fonctionner, vous devrez l'ajouter à votre compte Omnisend et le configurer du côté tiers.
Étape 1. Accéder aux Événements Personnalisés.
Naviguez vers Paramètres de la boutique → API → Custom events → Cliquez sur Créer un événement personnalisé pour commencer.
Étape 2. Configurer via la documentation de l'API.
Vous serez redirigé vers la documentation de l'API, où votre développeur pourra finaliser la configuration et créer l'événement personnalisé. Ici, vous devez :
Sélectionnez v5 comme version de la référence API ;
Naviguez vers API des événements → Événements → Envoyer l'événement Client (e).
Étape 3. Copiez la Clé API.
Allez dans Paramètres de la Boutique → API → Créer une clé API et copiez votre Clé API.
Étape 4. Ajoutez la Clé API à l'en-tête.
Dans la documentation de l'API, sélectionnez En-tête et collez votre Clé API dans le champ En-tête.
Étape 5. Compléter les Paramètres du Corps.
Suivez l'assistant pour entrer les détails requis de l'événement :
Contact (e) – Vous devez inclure au moins un identifiant de contact : une adresse email ou un numéro de téléphone d'un contact avec lequel vous souhaitez passer l'événement.
Vous pouvez également inclure des données supplémentaires telles que l'adresse, tags, date de naissance, ou propriétés personnalisées. Ces dernières sont stockées sur le profil de contact et persistent dans le temps.
ID de l'événement – Par exemple,
60ba330da4a60c8ed682c5bd:Nom de l'événement – Par exemple,
Révision soumise ;Heure de l'événement -Facultatif. Si utilisé, cela doit être une date passée ou présente. Les dates futures entraîneront l'échec de l'événement.
Version de l'événement - Facultatif. Peut être laissé vide pour les Événements Personnalisés.
Origine - Cela doit toujours être défini sur
"api"Propriétés (optionnel) – Ajoutez des données supplémentaires pour personnaliser votre workflow (voir la structure d'exemple ci-dessous).
Une fois terminé, cliquez sur Essayez-le pour créer l'événement.
Étape 6. Testez votre événement.
Vérifiez la création de l'événement :
Vérifiez un code d'état 200 dans la réponse de l'API après avoir cliqué sur "Essayez-le."
Allez à Paramètres de la Boutique → API → Événements personnalisés pour confirmer que l'événement apparaît dans votre liste.
Si vous rencontrez des erreurs, vérifiez Paramètres de la Boutique → API → journaux API pour plus de détails.
💡 Déclencher un événement de test :
Utilisez le POST /events point de terminaison pour déclencher l'événement manuellement. Cela le fait apparaître dans les déclencheurs d'automatisation.
Notes importantes :
Pour modifier un événement personnalisé, vous devez supprimer l'événement existant et en créer un nouveau en utilisant la documentation de l'API.
Désactiver un Custom event l'empêchera de fonctionner, et toutes les automatisations l'utilisant comme déclencheur seront interrompues.
Réactiver un Custom event le fait ne pas réactiver automatiquement le workflow associé. Vous devez réactiver l'automatisation manuellement.
La suppression de la Clé API créée pour le Custom event entraînera l'échec de votre événement.
Ajouter des Propriétés d'Événement
Propriétés(également étiqueté comme champs personnalisés dans Omnisend)passer des données supplémentaires avec chaque événement (par exemple, nom du produit, URL de suivi, note de révision). Ces données peuvent être utilisées dans des filtres de workflow, des conditions de séparation et la personnalisation des messages.
Pour ajouter des propriétés d'événement, allez à Propriétés → Objet de propriétés. Entrez le nom de la propriété et sa valeur. Pour inclure des propriétés supplémentaires, cliquez sur Ajouter un champ, puis entrez le nom de la prochaine propriété et sa valeur.
Une fois que votre événement personnalisé est transmis à Omnisend, vous pouvez revoir les propriétés de l'événement synchronisé en allant dans Paramètres de la boutique → API → Custom Events.
Cliquez sur le nom de l'événement pour voir les champs personnalisés associés.
Remarque : Une fois que le custom event est synchronisé avec Omnisend, les propriétés de l'événement apparaissent dans l'interface comme champs personnalisés. Ces termes se réfèrent aux mêmes données ; la seule différence est l'étiquette utilisée, selon que vous les consultez dans la documentation de l'API ou dans Omnisend.
Notes Importantes :
Les noms de propriété sont des étiquettes internes utilisées pour référencer les données dans les automatisations et la personnalisation des messages.
Les noms des propriétés ne peuvent pas être changés après la création de l'événement. Pour mettre à jour un nom de propriété, supprimez et recréez l'événement.
Les valeurs des propriétés peuvent changer au fil du temps en envoyant de nouveaux événements avec des valeurs mises à jour.
Exemple : Si un contact laisse un avis de 1 étoile, envoyez un événement avec
reviewType: "1 étoile". S'ils le mettent à jour plus tard à 2 étoiles, envoyez un nouvel événement avecreviewType: "2 étoiles".
Vous ne pouvez pas passer plusieurs valeurs dans une seule propriété (par exemple,
"1 étoile, 2 étoiles"). Envoyez un événement par changement de valeur.Le seul type de valeur pris en charge pour les champs de propriété est chaîne.
💡 Nous vous recommandons de consulter votre développeur ou votre fournisseur d'intégration tiers pour déterminer le format de données correct pour chaque champ personnalisé.
Utilisez des événements personnalisés dans l'automatisation
Étape 1 : Créer un Workflow.
Allez à Automatisations → Créer un workflow → Créer à partir de zéro.
Dans le menu déroulant des déclencheurs, trouvez votre Custom event.
Étape 2 : Configurer les paramètres du Workflow.
Une fois que vous ajoutez le déclencheur Custom event, tous les paramètres du Workflow se remplissent avec les données de l'événement :
Filtre de déclencheur – Filtrer par les valeurs de champ personnalisé (ce sont les propriétés d'événement que vous avez définies via l'API).
Bloc de séparation – Brancher les flux de travail en fonction des champs personnalisés.
Étape 3 : Personnaliser le Contenu du Message
Vous pouvez utiliser les données des champs personnalisés pour personnaliser le contenu de vos messages, y compris l'Email, le SMS et les notifications Push.
Si vous passez un lien en tant que propriété d'événement, vous pouvez également l'utiliser avec un bouton dans votre Email.
Utilisez le lien de désinscription dans l'automatisation
Lors de l'utilisation d'un Custom event pour déclencher un workflow d'automatisation, le bloc de contenu du pied de page inclut un lien de désinscription par défaut.
Nous recommandons d'inclure ce lien dans tous les messages. Cependant, ce n'est pas requis si le message est transactionnel (par exemple, lié à une commande que le client a passée).
Important : Les flux de travail d'automatisation déclenchés par des événements personnalisés enverra des messages aux contacts non abonnés par défaut. Si vous ne ne souhaitez pas envoyer de messages aux contacts non abonnés, mettez à jour le Paramètres du canal Workflow en cliquant sur le bloc de déclencheur et en ajustant les préférences.
Dépannage
Problème 1 : Le custom event n'apparaît pas dans le menu déroulant des déclencheurs d'automatisation.
Cela est attendu puisque les événements n'apparaissent dans la liste des déclencheurs d'automatisation qu'après avoir été déclenchés au moins une fois.
Utilisez le POST /events point de terminaison pour déclencher l'événement manuellement. Cela le fait apparaître dans les déclencheurs d'automatisation.
Exemple d'appel API (v5) :
POST https://api.omnisend.com/v5/events
Headers:
X-API-KEY: your-api-key
Content-Type: application/json
Body:
{
"origin": "api",
"email": "[email protected]",
"eventName": "Product Back in Stock",
"fields": {
"productName": "Blue Widget",
"productURL": "https://yourstore.com/products/blue-widget"
}
}
Problème 2 : Obtention d'une erreur 400 lors du déclenchement de l'événement.
Une erreur 400 indique un problème lié à la charge utile, ce qui signifie que la requête envoyée à Omnisend est invalide. Ces erreurs proviennent du côté de l'expéditeur, et non d'Omnisend.
Pour résoudre cela, allez dans Paramètres de la Boutique → API → journaux API et examinez les erreurs 400.
💡 Vous pouvez utiliser le filtre déroulant pour afficher uniquement les erreurs de niveau 400.
Problème 3 : les champs personnalisés de Shopify Flow n'apparaissent pas.
Shopify Flow utilise un point de terminaison et une structure JSON différents de l'API Omnisend standard, donc les champs personnalisés peuvent ne pas apparaître comme prévu.
Pour résoudre cela :
Utilisez la syntaxe de variable de modèle
##{{}}lors de la cartographie des champs dans les actions Shopify Flow.Assurez-vous que les noms de champs correspondent exactement à ceux définis dans Paramètres de la Boutique → API → Événements personnalisés (ils sont sensibles à la casse).
Gardez à l'esprit : les événements Shopify Flow n'apparaissent pas dans les journaux API dans Omnisend, car c'est un comportement attendu.
Pour des instructions complètes sur la configuration, consultez l'article Intégrer Shopify Flow avec Omnisend.
Problème 4 : L'événement fonctionnait, maintenant il ne se déclenche plus.
Si votre événement cesse soudainement de se déclencher :
Allez dans Paramètres de la Boutique → API → Événements personnalisés pour vérifier si l'événement est toujours activé.
Si l'événement a été supprimé, vous devrez le recréer et mettre à jour tous les flux de travail l'utilisant comme déclencheur.
Vérifiez les journaux API sous Paramètres de la Boutique → API → journaux API pour les erreurs récentes ou les demandes échouées.
Foire aux questions
Pourquoi la documentation de l'API les appelle-t-elle "propriétés d'événement" mais Omnisend les appelle-t-il "champs personnalisés" ?
C'est une différence de terminologie entre la documentation de l'API et l'interface Omnisend. Lorsque vous créez des propriétés d'événement dans la documentation de l'API, elles se synchronisent avec Omnisend et sont affichées comme champs personnalisés dans les workflows d'automatisation, les déclencheurs, les répartitions et la personnalisation des messages. Les deux termes se réfèrent aux mêmes données : les informations supplémentaires transmises avec chaque custom event.
Quelle est la différence entre les propriétés personnalisées de Contact (e) et les propriétés d'événement ?
Les propriétés personnalisées de Contact (e)sont stockées sur le profil de contact et persistent dans le temps. Ils sont passés en utilisant le
objet customProperties à l'intérieur dubloc d'objet de contact dans la charge utile de l'événement. Ces valeurs sont visibles sur le profil de contact (e) et peuvent être réutilisées dans les campagnes, les automatisations et la segmentation.Les propriétés de l'événement, en revanche, sont passées dans le
bloc des propriétés de l'événement. Elles sont uniquement liées à l'événement qui a été déclenché, étiquetées comme champs personnalisés, et ne persistent pas sur le profil de contact. Ceci est utile pour des conditions spécifiques à un événement, telles que le filtrage par nom de produit, score d'évaluation ou total de commande dans les flux de travail d'automatisation.
Puis-je modifier les noms des propriétés de l'événement après avoir créé un événement ?
Non. Les noms des propriétés ne peuvent pas être changés une fois l'événement créé. Si vous devez renommer une propriété, vous devrez supprimer l'événement existant et en créer un nouveau avec le nom de propriété mis à jour.
Remarque : Supprimer un événement actif désactivera tous les flux de travail qui l'utilisent comme déclencheur.
Quelle version de l'API devrais-je utiliser pour les événements personnalisés – v3 ou v5 ?
Utilisez v5 : https://api.omnisend.com/v5/events et incluez "origin": "api" dans le corps de votre requête.
Bien que les événements créés dans l'UI soient compatibles avec les versions v3 et v5, la v5 est la norme actuelle et recommandée pour toutes les nouvelles implémentations.
Puis-je passer des URL dans les propriétés de l'événement ?
Oui. Les URL peuvent être passées en tant que valeurs de chaîne dans les propriétés de l'événement. Ils peuvent être utilisés dans des filtres d'automatisation, des conditions de séparation, des règles de segmentation, ou directement dans le contenu des messages en utilisant des variables de personnalisation comme [[event.referralLink]].
Pour toute assistance supplémentaire concernant les événements personnalisés, n'hésitez pas à nous contacter à [email protected] ou via le chat dans l'application.