Référence des événements

Chaque type d'événement, les webhooks et les functions qui le reçoivent, et les champs de ses données.

9 min de lecture

Les abonnements webhook et les functions d'événement de plateforme puisent dans les mêmes types d'événements. Copiez les noms exactement comme ils sont écrits ici : un événement personnalisé mal orthographié est accepté sans avertissement et ne se déclenche jamais.

Lire les tableaux d'événements

Le tableau de chaque famille comporte une colonne Webhooks et une colonne Functions. Chaque cellule indique ce que propose le sélecteur d'abonnement correspondant, et si l'événement arrive réellement :

Dans la colonneCe que cela signifie
Un libellé en gras, comme GagnéLe sélecteur le propose sous ce libellé, et l'événement est envoyé
Événement personnaliséL'événement est envoyé, mais le sélecteur ne le propose pas : ajoutez-le avec le bouton Ajouter un élément personnalisé
Jamais envoyéLe sélecteur le propose, mais la plateforme ne l'envoie jamais. Ignorez-le
RefuséUn abonnement qui l'inclut ne peut pas être enregistré
Ne se déclenche jamaisIl est accepté comme événement personnalisé, mais n'atteint jamais aucune function

Les functions ajoutent leurs propres règles de déclenchement : voir Livraison des événements de plateforme.

Exemple de livraison

Dans cet exemple, le CRM de Lindenhall reçoit un événement reward.won.v1. Les en-têtes sont expliqués dans À propos des webhooks.

Request line and headers
POST /omnilab/events HTTP/1.1
Host: crm.lindenhall.example
Content-Type: application/json
User-Agent: OmniLab-Webhook/1.0
webhook-id: msg_6abe2823c1e5b2a9d4f81c3e:callbacks/3bb6d5ca-a587-4a81-84e0-7e200394b9c5
webhook-timestamp: 1790847012
webhook-signature: v1,LXEWQrcmsEQBYnyp+6wy9chTD7GQPMTbAiWHF5IaSIE=

Le corps est un document CloudEvents : l'identité de l'événement en haut, ses détails dans data. Il est mis en forme ici pour faciliter la lecture. Le vrai corps tient sur une seule ligne de JSON compact, et la signature couvre exactement ces octets.

Body
{
  "specversion": "1.0",
  "id": "6abe2823c1e5b2a9d4f81c3e",
  "type": "reward.won.v1",
  "subject": "d96c390f-5753-441c-baa3-0689a8c83716",
  "time": "2026-10-01T09:30:11.482Z",
  "datacontenttype": "application/json",
  "tenantid": "tenants/1e3f8137-9ea4-4d99-a7be-023d88c4f8c1",
  "data": {
    "contact": {
      "contact_id": "contacts/922eb227-f65a-4998-b116-a53edaf0d325",
      "unique_visitor_id": "e1bcce15-7972-4afc-bd6d-871ca666b7d0",
      "external_contact_id": "LH-0042817"
    },
    "tenant_context": {
      "subdomain": "lindenhall"
    },
    "group_context": {
      "group_id": "groups/6946c01f-8542-471c-9e2f-dac2661027c6",
      "unique_key": "lindenhall-riverside"
    },
    "interaction": {
      "interaction_id": "interactions/6cc002c6-2be1-412c-ac0d-c5d16a8c7cc6",
      "interaction_display_name": "Autumn Prize Draw",
      "interaction_public_key": "autumn-prize-draw"
    },
    "web_context": {
      "utm": { "source": "instagram", "medium": "social" },
      "user_agent": {
        "os": "iOS",
        "device": "iPhone",
        "is_mobile": true,
        "is_desktop": false,
        "is_tablet": false,
        "is_bot": false
      }
    },
    "reward_id": "d96c390f-5753-441c-baa3-0689a8c83716",
    "internal_reward_id": "rewards/42101441-81cd-45c9-bca0-993039133359",
    "reward_display_name": "£10 food court voucher",
    "reward_winning_method": "FIRST_COME_FIRST_SERVE",
    "coupon_code_id": "coupons/3bb6d5ca-a587-4a81-84e0-7e200394b9c5",
    "coupon_code_value": "LH10-7QK2"
  }
}

Quelques attributs de premier niveau, qui ne servent qu'à identifier l'expéditeur, ne figurent pas ci-dessus. Les champs vides sont souvent omis. Considérez chaque champ comme facultatif, et ignorez ceux que vous n'utilisez pas.

Une function reçoit les mêmes type, id, time, source et data, sans les en-têtes : voir PlatformEvent.

Champs communs à la plupart des événements

En plus de ses propres champs, data contient des blocs de contexte :

BlocChampsPrésent dans
contactcontact_id, unique_visitor_id, external_contact_id, custom_fieldsTous les événements. contact_id est vide pour un visiteur anonyme. Les événements de réservation, de billet, d'enregistrement et de soumission ne renseignent que contact_id. Les événements Smart Link ne renseignent que unique_visitor_id.
tenant_contextsubdomainTous les événements
group_contextgroup_id, et unique_key sur les événements de campagneTous les événements. Certains événements de réservation et de billet le laissent vide.
interactioninteraction_id, interaction_display_name, interaction_public_key, interaction_snapshot_id, session_id, visit_idLes événements de campagne : les familles point de contact, récompense, contact et autres
web_contextutm (campaign, source, medium, term, content), user_agent (os, device, raw, is_mobile, is_desktop, is_tablet, is_bot), referrer, query_paramsLes événements de campagne. Les événements Smart Link contiennent utm, user_agent, referrer, url et une ip_address dont la dernière partie est mise à zéro.

Aucun bloc ne contient l'email ni le nom du contact. Une function les lit avec OmniLab.Contact.get(data.contact.contact_id).

Correspondance des filtres

Un filtre d'abonnement webhook compare une valeur de l'événement à celle que vous saisissez : les deux doivent être identiques.

Clé de filtreCorrespond quandFormat de la valeur
group_iddata.group_context.group_id est égal à la valeur. L'ID d'une organisation parente ne correspond pas aux événements de ses organisations enfants.groups/<id>, comme dans une livraison que vous avez reçue
tenant_idLe tenantid de premier niveau est égal à la valeur. Tous les événements de votre compte ont le même : ce filtre ne restreint donc rien.Le tenantid d'une livraison que vous avez reçue
interaction_idAucun événement n'y correspond aujourd'hui. Les événements de campagne placent la campagne dans data.interaction, que le filtre n'examine pas. Les événements de réservation ne la contiennent pas.N'utilisez pas ce filtre

Pour ne recevoir qu'une seule campagne, filtrez dans votre récepteur à partir de data.interaction.interaction_public_key. Les abonnements des functions ont leurs propres clés de filtre : voir Restreindre un abonnement avec des filtres.

Événements de point de contact

Type d'événementQuand il se déclencheWebhooksFunctions
touchpoint.page_visit.v1Une page de point de contact est consultéeVisite de pageRefusé
touchpoint.started.v1Une session de point de contact démarreDémarréDémarré
touchpoint.participated.v1Un participant entre dans l'expérienceA participéA participé
touchpoint.participation_form_filled.v1Un formulaire de participation est envoyéFormulaire de participation rempliFormulaire de participation rempli
touchpoint.completed.v1Une session de point de contact se termineTerminéTerminé
touchpoint.terms_accepted.v1Des conditions ou un consentement sont acceptésConditions acceptéesConditions acceptées
cta.clicked.v1Un bouton d'appel à l'action configuré est sélectionnéCTA cliquéCTA cliqué
Type d'événementAjoute à data
touchpoint.page_visit.v1, touchpoint.started.v1, touchpoint.participated.v1, touchpoint.completed.v1touchpoint_id, touchpoint_title, touchpoint_type, interactive_totem_type, instant_game_type, event_id
touchpoint.participation_form_filled.v1Les champs ci-dessus, plus form_level, form_frequency, form_schema_id, et submitted_data : un field_id, un field_label, un field_type et une value par réponse
touchpoint.terms_accepted.v1term_and_condition_text, terms_and_conditions_accepted_at, terms_and_conditions_uri, opt_in_level, collectible_id, collectible_title
cta.clicked.v1cta_label, cta_url

Événements de récompense

Type d'événementQuand il se déclencheWebhooksFunctions
reward.eligible.v1Un participant devient éligible à une récompenseÉligibleÉligible
reward.won.v1Un participant gagne une récompenseGagnéGagné
reward.lost.v1Un participant ne gagne pas de récompensePerduPerdu
reward.redeemed.v1Une récompense gagnée est utiliséeÉchangé(s)Échangé(s)
reward.temporary_won.v1Un gain temporaire est comptabiliséGagné temporairementGagné temporairement
reward.temporary_lost.v1Une perte temporaire est comptabiliséePerdu temporairementPerdu temporairement
reward.temporary_blocked.v1Un état de récompense temporaire est bloquéBloqué temporairementBloqué temporairement
reward.expired.v1Jamais : le libellé Expiré du sélecteur ne correspond à aucun événementJamais envoyéJamais envoyé
Type d'événementAjoute à data
Tous les événements de récompensereward_id, internal_reward_id, reward_display_name, reward_winning_method
reward.won.v1, reward.temporary_won.v1Les champs de récompense, plus coupon_code_id, coupon_code_value et reward_time_id
reward.redeemed.v1Les champs de récompense, plus coupon_code_id et coupon_code_value

Événements de contact et autres

Les deux sélecteurs les listent sous Contact et Autre.

Type d'événementQuand il se déclencheWebhooksFunctions
contact.created.v1Un nouveau contact est crééCrééCréé
contact.identified.v1Un visiteur anonyme est relié à un contact connuIdentifiéIdentifié
contact.authenticated.v1Un contact se connecteAuthentifiéAuthentifié
notification.sent.v1Une notification est envoyée à un participantNotification envoyéeNotification envoyée
feedback.submitted.v1Un participant envoie un avis ou une note de satisfactionAvis envoyéAvis envoyé
question.answered.v1Une réponse à une question ou à un quiz est envoyéeQuestion répondueQuestion répondue
Type d'événementAjoute à data
contact.created.v1contact_id, touchpoint_id, touchpoint_title, touchpoint_type, event_id, game_id
contact.identified.v1, contact.authenticated.v1Les champs de contact.created.v1, plus identification_type (SIGN_UP ou LOGIN) et identification_timestamp
notification.sent.v1notification_event_type, notification_by_type, touchpoint_id, touchpoint_title. Avec le module Fournisseur d'e-mail personnalisé, aussi provider (CUSTOM_EMAIL_PROVIDER), rendered (subject, preheader, html) et sender (from_name, from_email, reply_to_name, reply_to_email) : voir Envoyer les notifications de campagne via votre plateforme
feedback.submitted.v1rating, comment
question.answered.v1question, question_answer

Événements de réservation, de billet et de présence

Le sélecteur des webhooks les liste sous Réservation et billet et Participation.

Type d'événementQuand il se déclencheWebhooksFunctions
booking.created.v1Une réservation est crééeRéservation crééeÉvénement personnalisé
booking.deleted.v1Une réservation est suppriméeRéservation suppriméeÉvénement personnalisé
ticket.confirmed.v1Un billet est confirméBillet confirméÉvénement personnalisé
ticket.canceled.v1Un billet confirmé est annuléBillet annuléÉvénement personnalisé
ticket.waitlisted.v1Jamais : rejoindre une liste d'attente ne crée aucun billet, le libellé Billet en liste d'attente du sélecteur ne correspond donc à aucun événementJamais envoyéNe se déclenche jamais
ticket.deleted.v1Un billet est suppriméBillet suppriméÉvénement personnalisé
participation.checked_in.v1Un participant est enregistré à une activitéCheck-in effectuéÉvénement personnalisé
participation.deleted.v1Une fiche de participation est suppriméeÉvénement personnaliséÉvénement personnalisé

Dans ces événements, event_id et event_name désignent l'activité réservable, pas l'événement de plateforme.

Rejoindre ou quitter une liste d'attente n'envoie aucun événement. Quand une personne en liste d'attente obtient une place, booking.created.v1 et ticket.confirmed.v1 arrivent comme pour toute autre réservation.

Type d'événementAjoute à data
booking.created.v1booking_id, event_id, event_name, tickets_number, reserver_id, host_id, ticket_type_id, ticket_type_display_name, slot_start_date, slot_end_date, booked_at
ticket.confirmed.v1, ticket.canceled.v1ticket_id, booking_id, event_id, event_name, host_id, ticket_type_id, ticket_type_display_name, slot_start_date, slot_end_date, puis ticket_confirmed_at ou ticket_canceled_at
participation.checked_in.v1participation_id, ticket_id, event_id, event_name, ticket_type_id, ticket_type_display_name, check_in_method (SELF ou SCAN), slot_start_date, slot_end_date, check_in_time
booking.deleted.v1booking_id, event_id, reserver_id, deleted_at, deletion_user
ticket.deleted.v1ticket_id, booking_id, event_id, contact_id, deleted_at, deletion_user
participation.deleted.v1participation_id, ticket_id, event_id, contact_id, deleted_at, deletion_user
booking.created.v1 data fields
{
  "booking_id": "2394d604-afcc-4f7f-98c1-ef3676c20d6b",
  "event_id": "8f1c2a47-3b9e-4d6a-9c05-71e2b4d8a913",
  "event_name": "VIP styling session",
  "tickets_number": 2,
  "reserver_id": "contacts/922eb227-f65a-4998-b116-a53edaf0d325",
  "host_id": "host_K7m2Qx9",
  "ticket_type_id": "ticket_5d0e9b3c-6f1a-4c2e-8a7d-2b9f4e6c1a08",
  "ticket_type_display_name": "VIP",
  "slot_start_date": "2026-05-03T14:00:00Z",
  "slot_end_date": "2026-05-03T14:30:00Z",
  "booked_at": "2026-04-26T09:15:00Z"
}

Événements de soumission de ticket de caisse

Type d'événementQuand il se déclencheWebhooksFunctions
submission.created.v1Une soumission de ticket de caisse est crééeÉvénement personnaliséÉvénement personnalisé
submission.status_changed.v1Une soumission change de statut de validation ou de vérificationÉvénement personnaliséÉvénement personnalisé
submission.amended.v1Une soumission est modifiéeÉvénement personnaliséÉvénement personnalisé
submission.replaced.v1Une soumission en remplace une autreÉvénement personnaliséÉvénement personnalisé
Type d'événementAjoute à data
Tous les événements de soumissionsubmission_id, session_id, game_id, player_id, game_name
submission.created.v1validation_mode, merchant_name, amount, currency, receipt_date, duplicate_reference_id, is_resubmission, original_submission_id, submitted_at
submission.status_changed.v1previous_status, new_status, trigger_source (ocr, policy_auto ou operator_action), reason, changed_at
submission.amended.v1amended_fields, merchant_name, amount, currency, amended_at
submission.replaced.v1new_submission_id, replaced_at
Type d'événementQuand il se déclencheWebhooksFunctions
smartlink.redirected.v1Un Smart Link redirige un visiteurÉvénement personnaliséNe se déclenche jamais

Il ajoute smart_link_id, slug, title, destination_url, redirection_status, variant_id, variant_name et variant_variables à data. Il identifie le visiteur, jamais un contact : il ne peut donc pas déclencher de function.

Types du groupe Événement

Le groupe Événement du sélecteur des webhooks propose six types que la plateforme n'envoie jamais. Un abonnement à ces types est accepté, mais ne reçoit rien : ignorez-les.

  • event.created.v1, event.deleted.v1 et event.type.updated.v1
  • event.availability.updated.v1, event.slot.reached_capacity.v1 et event.fully_booked.v1

Choisir les événements pour l'analytics

Vous alimentez un entrepôt de données ou un outil de BI ? Voici les événements auxquels les équipes abonnent le plus souvent un webhook :

  • touchpoint.page_visit.v1
  • touchpoint.participated.v1
  • touchpoint.completed.v1
  • reward.won.v1
  • reward.redeemed.v1
  • smartlink.redirected.v1

Ne vous abonnez qu'aux événements que la destination exploite. Un abonnement filtré ne coûte rien, alors qu'une livraison inutile vous coûte quand même une requête.

Étapes suivantes

Sur cette page