Événements d’espace de travail

Un événement d’espace de travail est un événement que votre espace de travail déclare avant que quiconque l’envoie : son nom, un titre facultatif et les propriétés qu’il contient, chacune avec un type. Les événements de ce type sont envoyés sous la forme w:<name>, et Emailit rejette ceux qui ne correspondent pas. Cette page explique comment les définir et comment fonctionne la validation.

Si vous ne voulez pas déclarer de structure, envoyez plutôt un événement personnalisé (c:<name>). Les événements d’espace de travail et les événements personnalisés sont inclus dans les forfaits Pro, Business et Custom.

Définir un événement d’espace de travail

curl -X POST https://api.emailit.com/v2/workspace/events \
  -H "Authorization: Bearer $EMAILIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "customer.type",
    "title": "Customer type",
    "properties": [
      { "name": "segment", "type": "string", "required": true },
      { "name": "since", "type": "date" }
    ]
  }'

Envoyez-le ensuite comme n’importe quel autre événement, avec le script de suivi ou l’API :

curl -X POST https://api.emailit.com/v2/events \
  -H "Authorization: Bearer $EMAILIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "type": "w:customer.type", "email": "jane@example.com", "properties": { "segment": "b2b", "since": "2026-10-01" } }'

Types de propriétés

Vérification des événements

Lorsqu’un événement w: arrive, Emailit compare ses properties à la définition :

• Chaque propriété doit figurer dans la définition. Les propriétés inconnues sont rejetées : une faute de frappe ne passe donc pas inaperçue.
• Les propriétés obligatoires doivent être présentes et ne pas valoir null.
• Une propriété facultative peut être omise, ou envoyée avec la valeur null pour indiquer qu’elle est vide.
• Chaque valeur doit correspondre à son type.

Un événement w: dont le nom n’est pas défini est rejeté lui aussi. L’API répond 422, avec chaque problème indexé par son chemin, par exemple properties.since. Le script de suivi ignore les événements invalides et, avec le débogage activé, en consigne la raison.

Modifier ou supprimer une définition

Dans l’onglet Workspace events, sélectionnez Edit ou Delete sur une définition. Avec l’API, utilisez Mettre à jour un événement d’espace de travail et Supprimer un événement d’espace de travail.

• Une définition ne vérifie que les nouveaux événements. Les événements déjà enregistrés conservent les propriétés qu’ils avaient.
• Modifier les propriétés remplace toute la liste. Les émetteurs qui envoient encore une propriété supprimée reçoivent des erreurs : mettez-les donc à jour avant ou en même temps.
• Renommer l’événement change le type à envoyer. Les événements enregistrés conservent l’ancien type, et les nouveaux événements qui portent l’ancien nom sont rejetés.
• La suppression conserve les événements enregistrés, et les nouveaux événements de ce type sont rejetés jusqu’à ce que vous le définissiez de nouveau.

Limites

Un espace de travail peut définir autant d’événements d’espace de travail que son forfait compte de types d’événements : 100 sur Pro et 1 000 sur Business, sans limite sur Custom. Un événement de plus renvoie 422 avec le code workspace_events_limit. Chaque événement d’espace de travail a 50 propriétés au maximum. Les noms comptent 100 caractères au maximum, les noms de propriétés 64, les titres 120 et les descriptions 1 000.

Voir aussi