Suivi des événements

Le suivi des événements vous permet d’enregistrer ce que les gens font dans votre propre produit : une commande, un changement de forfait, une inscription, la consultation d’un produit. Vous envoyez les événements depuis votre site web avec le script de suivi, ou depuis vos serveurs avec l’API. Emailit les stocke à côté des événements qu’il enregistre lui-même, les rattache à des contacts et peut les envoyer à vos webhooks.

Le suivi des événements est inclus dans les forfaits Pro, Business et Custom. Sur Pay as you go, l’envoi d’événements et la définition d’événements d’espace de travail renvoient 403 avec "error": "plan_required", et les requêtes du script de suivi sont refusées.

Trois portées d’événements

Chaque événement a un type, dont le préfixe indique la portée :

Utilisez un événement d’espace de travail lorsque plusieurs systèmes envoient le même événement et que vous voulez qu’ils restent cohérents, ou lorsque des personnes de votre équipe s’appuient sur ses champs. Utilisez un événement personnalisé lorsque vous voulez conserver votre propre structure de données, par exemple le format de commande de votre boutique, sans la déclarer au préalable. Vous pouvez commencer par un événement personnalisé et le définir plus tard comme événement d’espace de travail ; ce sont deux types distincts, donc c:order.completed et w:order.completed ne se mélangent pas.

Noms d’événements

Les noms comptent de 1 à 100 lettres, chiffres, points, tirets ou traits de soulignement, et commencent par une lettre ou un chiffre : customer.type, order-completed, cart_updated. Les noms sont sensibles à la casse.

Les noms des propriétés des événements d’espace de travail suivent les mêmes règles, sans les points, car les filtres de webhook et les modèles utilisent les points pour accéder aux valeurs imbriquées.

Moyens d’envoyer des événements

Il vaut mieux envoyer depuis vos serveurs les événements liés à l’argent, comme les commandes et les paiements. Les événements du navigateur peuvent être bloqués, et n’importe qui peut envoyer des événements avec une clé publique.

Événements et contacts

Un événement peut désigner la personne qu’il concerne, par email ou par contact_id.

• Les contacts sont recherchés, jamais créés. Si aucun contact n’a cette adresse e-mail, l’adresse est tout de même enregistrée, et l’événement apparaît dans l’activité du contact dès que vous le créez.
• Un contact_id doit appartenir à un contact de l’espace de travail.
• Les événements sans personne peuvent porter un anonymous_id. Le script de suivi en ajoute un à chaque événement qu’il envoie.

Les événements rattachés à un contact apparaissent dans l’Activity log du contact, à côté des e-mails qu’il a reçus. Les événements d’espace de travail qui ont un titre y affichent ce titre.

Où vont les événements

• Le journal des événements. Email API›Events liste tous les événements dans l’onglet Log. Filtrez par Scope pour ne voir que les événements système, d’espace de travail ou personnalisés. Avec l’API, utilisez le paramètre scope de Lister les événements.
• Webhooks. Abonnez un webhook à un type comme c:order.completed, ou à tous les événements d’espace de travail ou personnalisés avec w:* et c:*. Un webhook dont l’option All events est activée ne les reçoit pas, sauf si vous les choisissez aussi. Consultez Types d’événements.
• Contacts. Consultez Événements et contacts.
• Automatisations. Un déclencheur Custom event démarre une exécution pour le contact de l’événement, éventuellement uniquement quand ses propriétés correspondent. Les mêmes événements peuvent mettre fin à des exécutions, remplir des objectifs et reprendre des étapes Wait until. Seuls les événements que vous envoyez depuis votre serveur avec l’API des événements ont cet effet : toute personne qui dispose de votre clé de suivi publique peut nommer un visiteur, donc les événements du script de suivi sont enregistrés et parviennent aux webhooks, mais ne démarrent pas, ne terminent pas et ne font pas avancer les exécutions. Le déclencheur Custom event est inclus dans les forfaits Business et Custom, et les conditions de sortie, les objectifs et les attentes sur ces événements dans les forfaits Pro, Business et Custom. Consultez Conditions de sortie et objectifs.

Conservation

Les événements font partie des Logs de votre espace de travail : ils sont donc conservés pendant la durée de conservation des logs de votre forfait, puis supprimés. Consultez Conservation des données. Conservez dans vos propres systèmes les commandes et les autres données dont vous avez besoin plus longtemps.

Limites

• Les types d’événements sont les types distincts d’événements d’espace de travail et personnalisés qu’un espace de travail envoie, comme c:order.completed et w:customer.type. Les types déjà envoyés continuent de fonctionner. Une fois que l’espace de travail a utilisé le nombre de types de son forfait, les événements d’un nouveau type sont rejetés avec 422.
• Événements d’espace de travail : autant que le forfait compte de types d’événements, chacun avec 50 propriétés au maximum.
• Propriétés des événements personnalisés : 32 Ko de JSON et 8 niveaux d’imbrication au maximum.
• 100 événements au maximum par requête de lot.
• 25 clés de suivi par espace de travail.

Les autres limites figurent dans Limites et quotas.

Voir aussi