Créer des webhooks de commentaires pour les campagnes déclenchées par API webhooks

Sur cette page : découvrez comment créer et configurer des webhooks de feedback qui transmettent des mises à jour du statut des messages en temps réel à vos systèmes pour les campagnes déclenchées par API transactionnelle dans Adobe Journey Optimizer.

Les webhooks de commentaires vous permettent de recevoir des mises à jour de statut en temps réel pour les messages envoyés via des campagnes transactionnelles déclenchées par API. En configurant un webhook, vous recevez automatiquement les résultats des diffusions directement dans vos systèmes, ce qui facilite la surveillance, la journalisation et le traitement automatisé.

Vous pouvez gérer les configurations de webhook à partir du menu Administration > Canaux > Paramètres du webhook des commentaires.

NOTE
Une seule configuration de webhook par combinaison organisation + sandbox est autorisée.

Créer un webhook de commentaires feedback-webhook

Pour créer un webhook, procédez comme suit :

  1. Accédez à Administration / Canaux / Paramètres du webhook de commentaires.

  2. Cliquez sur Créer un webhook de commentaires.

  3. Dans la section Configuration de base, fournissez les informations suivantes :

    • Nom du webhook : saisissez un nom explicite pour identifier le webhook.
    • Canaux - Sélectionnez le ou les canaux pour lesquels ce webhook doit recevoir des commentaires (e-mail et/ou mobile).
    • URL du webhook : indiquez le point d’entrée HTTPS où les événements de commentaires doivent être diffusés.
  4. Dans la section Authentification, sélectionnez la méthode d’authentification :

    • Pas d’authentification : aucun en-tête d’authentification n’est ajouté.
    • Authentification JWT : fournissez les informations requises si votre point d’entrée nécessite une authentification JWT.
  5. Dans la section Paramètres d’en-tête, vous pouvez configurer des en-têtes personnalisés supplémentaires à envoyer avec chaque demande de webhook.

  6. Cliquez sur Envoyer pour enregistrer la configuration.

NOTE
Vous pouvez modifier un webhook à tout moment. Pour ce faire, ouvrez-le dans l’inventaire, puis cliquez sur le bouton Modifier.

Structure de la payload du webhook

Après l’exécution d’un message, Journey Optimizer envoie la payload suivante au point d’entrée configuré.

Pour la définition des champs d’événement de retour de message, tels que messageExclusion, consultez la Référence du schéma Adobe Journey Optimizer.

La payload comprend les détails de diffusion de campagne et mobile suivants :

  • messageExecution.campaignType - Type de campagne : Scheduled ou ApiTriggered.
  • messageDeliveryFeedback.encoding - Encodage des SMS signalé par le fournisseur, tel que GSM ou UNICODE.
  • messageDeliveryFeedback.numberOfMessageParts - Nombre de parties SMS (segments) dans lesquelles le message a été divisé, envoyées sous forme de chaîne.
  • messageDeliveryFeedback.deliveryTimestamp - Heure d’événement signalée par le fournisseur au format ISO-8601.
NOTE
Les champs encoding, numberOfMessageParts et deliveryTimestamp sont actuellement renseignés uniquement pour le fournisseur SMS Sinch. Les champs sans valeur sont envoyés en tant que null.

Exemple de payload d’e-mail

{
  "requestId": "8NoByJneShCdCGRnrGS1t1m3CdA73dhR",
  "imsOrg": "myImsOrg",
  "sandbox": {
    "id": "068abf40-575e-11ea-8512-9b1bfdb82603",
    "name": "prod"
  },
  "channel": "email",
  "eventType": "message.feedback",
  "messageExecution": {
    "messageExecutionID": "HUMA-26362805",
    "messageType": "transactional",
    "campaignID": "16f24a15-7e21-477c-848a-d5695ca7f137",
    "campaignVersionID": "2ca10c10-56dd-4505-87cd-fa5da84e7a5d",
    "campaignType": "ApiTriggered"
  },
  "messageDeliveryFeedback": {
    "feedbackStatus": {
      "value": "bounce"
    },
    "offers": null,
    "messageExclusion": null,
    "messageFailure": {
      "category": "sync",
      "type": "Ignored",
      "code": "25",
      "reason": "Admin Failure"
    },
    "retryCount": 0,
    "encoding": null,
    "numberOfMessageParts": null,
    "deliveryTimestamp": null
  },
  "identityMap": {
    "email": [
      {
        "id": "john.doe@luma.com",
        "primary": true
      }
    ]
  }
}

Exemple de payload SMS

L’exemple suivant illustre les commentaires de diffusion pour un SMS envoyé via Sinch :

{
  "requestId": "4f1c2d9e-...",
  "imsOrg": "XXXX@AdobeOrg",
  "sandbox": {
    "id": "...",
    "name": "prod"
  },
  "channel": "sms",
  "eventType": "message.feedback",
  "channelContext": {
    "profileAddress": null,
    "profileNumber": "+15555550123"
  },
  "messageExecution": {
    "messageExecutionID": "UMA-...",
    "messageType": "marketing",
    "campaignID": "...",
    "campaignVersionID": "...",
    "messageID": "...",
    "messageProfileID": "...",
    "campaignType": "ApiTriggered"
  },
  "messageDeliveryFeedback": {
    "feedbackStatus": {
      "value": "delivered"
    },
    "offers": null,
    "messageExclusion": null,
    "messageFailure": null,
    "retryCount": null,
    "responseCode": null,
    "responseDurationMillis": null,
    "encoding": "GSM",
    "numberOfMessageParts": "2",
    "deliveryTimestamp": "2026-10-06T18:22:41.512Z"
  },
  "identityMap": {
    "Phone": [
      {
        "id": "+15555550123"
      }
    ]
  }
}

Le webhook peut capturer les événements suivants :

  • Envoyés
  • Délivrés
  • Rebond (voir l’exemple ci-dessus)
  • Erreurs

Chaque requête entrante inclut également un requestId unique qui est renvoyé au webhook.

Étapes suivantes next

Une fois le webhook de commentaires créé, vous pouvez l’activer lors de la configuration d’une audience de campagne transactionnelle déclenchée par API. Pour en savoir plus, consultez la section Activer des webhooks.

recommendation-more-help
journey-optimizer-help