Comprendre les webhooks dans la CDP de Klaviyo

Objectif de cet article

Découvrez les webhooks et la manière dont vous pouvez les utiliser pour envoyer des données à vos applications tierces en réponse à des événements enregistrés dans Klaviyo. Pour découvrir comment recevoir des webhooks, consultez nos ressources pour développeurs sur l’utilisation des webhooks.

Qu’est-ce qu’un webhook ?

Les webhooks permettent à Klaviyo de transmettre des informations ou « d’appeler » d’autres applications, outils et serveurs via des requêtes HTTP. Ils peuvent envoyer des données sur un événement qui s’est produit (par exemple, une commande passée, un nouvel abonné, etc.) ou informer vos systèmes externes que l’événement s’est produit.

Klaviyo prend en charge 2 types de webhooks :

1. Webhooks dans Klaviyo CDP
   Les webhooks disponibles dans Klaviyo CDP sont utilisés pour notifier à vos systèmes externes qu’un événement particulier s’est produit, et vous permettent d’envoyer des informations en réponse à un large éventail d’événements sans les limitations d’un flux.
2. Webhooks de flux
   Les webhooks de flux ne sont disponibles que dans l’interface des flux et sont déclenchés lorsque le flux atteint un certain stade ou une certaine étape. Ils peuvent être utilisés pour envoyer des données sur l’événement ou le destinataire qui a déclenché le flux.

Composants clés des webhooks

Les webhooks se composent de quelques éléments clés :

• Sujet
  L’événement qui déclenche un webhook.
• Corps (ou « la charge utile »)
  Les données envoyées par le webhook.
• En-tête
  L’emplacement pour transmettre des informations supplémentaires (d’authentification, par exemple).

En quoi les webhooks de Klaviyo CDP diffèrent-ils des webhooks de flux ?

Selon vos besoins, vous pouvez utiliser des webhooks dans la CDP de Klaviyo ou des webhooks de flux.

Événements inclus

Les webhooks de flux ne peuvent répondre qu’à un sous-ensemble d’événements Klaviyo et ne prennent pas en charge les événements liés aux messages tels que Désabonnement, E-mail Reçu ou E-mail Cliqué, car la réception des messages intervient généralement à la fin des flux plutôt qu’au début. Par ailleurs, les webhooks de la CDP de Klaviyo vous permettent d’envoyer des informations en réponse à tout événement de votre compte.

En voici quelques exemples :

• Événements liés aux e-mails (par exemple, E-mail Reçu, E-mail Cliqué, E-mail Marqué comme Spam, Désabonnement) ;
• Événements liés aux SMS (par exemple, SMS Envoyé, SMS Reçu) ;
• Événements liés aux notifications push (par exemple, Push Reçue, Rebond de Push) ;
• Événements provenant d’intégrations (c’est-à-dire les événements provenant d’intégrations first-party créées par Klaviyo) ;
• Événements d’API (par exemple, les événements synchronisés via les API de Klaviyo).

Charge utile

Les webhooks de flux vous permettent de personnaliser les données incluses dans la demande, mais vous devez configurer manuellement la charge utile. En revanche, les webhooks de Klaviyo CDP utilisent une charge utile prédéfinie qui ne nécessite aucune action manuelle de votre part, et servent à notifier des systèmes externes qu’un événement s’est produit.

Limitations du flux

Les webhooks de flux doivent être configurés dans l’interface de flux et ne vous permettent pas d’utiliser plusieurs déclencheurs en même temps. Les différents déclencheurs doivent être créés par le biais de flux individuels et dépendent du statut général du flux (par exemple, un flux à l’état de brouillon n’enverra pas de données par l’intermédiaire d’un webhook de flux). En revanche, les webhooks de Klaviyo CDP existent en dehors de l’interface de flux et ne dépendent pas de la série d’étapes menant à l’action du webhook, comme c’est le cas pour un webhook de flux.

Configurer un webhook

Pour configurer un webhook dans Klaviyo, accédez à Webhooks sous CDP > Gestion des données > Webhooks.

1. Pour ajouter un nouveau webhook, cliquez sur le bouton Créer un webhook.
2. Dans la fenêtre modale Créer un webhook, saisissez les données. Les informations à fournir sont les suivantes :
• Nom
  Comment vous identifierez votre webhook.
• URL du point de terminaison
  L’URL associée à la destination de la demande de webhook.
• Clé secrète
  Un identifiant unique pour identifier les demandes de webhook Klaviyo dans vos autres systèmes.
• Description
  Une description optionnelle de votre webhook.
3. Dans la section Sujets, choisissez les événements qui déclencheront la notification par webhook.

Une fois que vous avez créé votre webhook, il sera répertorié sur la page Webhooks avec les données suivantes :

• Nom du webhook ;
• URL du webhook ;
• Heure de la dernière synchronisation ;
• Statut.

Vous pouvez supprimer ou désactiver votre webhook en utilisant le menu situé à côté de l’élément.

Tester des webhooks

Lorsque vous configurez un webhook dans Klaviyo, vous pouvez le tester pour vous assurer que la connexion fonctionne. Pour tester votre webhook, utilisez le bouton Tester le webhook après avoir rempli les champs obligatoires.

Dans le menu qui apparait, vous pouvez sélectionner un sujet et envoyer un test à votre URL de rappel.

Une fois le test effectué, un message indiquera s’il a fonctionné, et l’en-tête et le corps de la requête apparaitront dans l’onglet Réponse.

Exemple de charge utile

Vous trouverez ci-dessous un exemple de charge utile pour une demande de webhook en réponse au sujet E-mail transmis.

{
  "meta": {
    "timestamp": "2023-08-10T07:25:23.700369+00:00",
    "klaviyo_webhook_id": "ID",
    "version": "2023-06-03"
  },
  "data": [
    {
      "topic": "event: email_delivered",
      "external_id": "ID",
      "payload": {
        "data": {
          "id": "ID",
          "type": "event",
          "links": {
            "self": "https://a.klaviyo.com/api/events/ID/"
          },
          "attributes": {
            "uuid": "96150200-374e-11ee-8001-a163313bc6c2",
            "datetime": "2023-08-10 07:21:56+00:00",
            "timestamp": 1691652116,
            "event_properties": {
              "$ESP": 0,
              "Subject": "? Free (Cool!) Swag Alert ?",
              "$message": "01H7F525FKR31P27Y7PNGVBBKK",
              "$event_id": "01H7F525FKR31P27Y7PNGVBBKK:125423419905414052533228990613763937641",
              "$group_ids": [
                "V7adxq"
              ],
              "$attribution": {
                "$send_ts": 0,
                "$attributed_event_id": ""
              },
              "Email Domain": "klaviyo-demo.com",
              "Campaign Name": "Daily Newsletter: 2023-08-10",
              "Inbox Provider": "Amazon SES Inbound",
              "$_cohort$message_send_cohort": "1691652081:01H7F525FKR31P27Y7PNGVBBKK"
            }
          },
          "relationships": {
            "metric": {
              "data": {
                "id": "ID",
                "type": "metric"
              },
              "links": {
                "self": "https://a.klaviyo.com/api/events/ID/relationships/metric/",
                "related": "https://a.klaviyo.com/api/events/ID/metric/"
              }
            },
            "profile": {
              "data": {
                "id": "ID",
                "type": "profile"
              },
              "links": {
                "self": "https://a.klaviyo.com/api/events/ID/relationships/profile/",
                "related": "https://a.klaviyo.com/api/events/ID/profile/"
              }
            }
          }
        }
      }
    },
  

Ressources complémentaires

Comment ajouter une action webhook à un flux

Comprendre les webhooks de Klaviyo

Travailler avec les webhooks (Webhooks API de Klaviyo)