Plateforme Messenger

Référence sur les webhooks messaging_postbacks

Ce document explique la charge utile JSON que recevra votre serveur de webhooks lors du déclenchement d’un événement de webhook messaging_postbacks. Un évènement webhook de renvoi (postback) est déclenché lorsqu’une personne clique sur un bouton de renvoi, un bouton Démarrer ou un élément de menu fixe.

Exemple de notification

Voici un exemple de charge utile JSON qui sera envoyée à votre serveur de webhooks.

{
  "field": "messaging_postbacks",
  "value": {
    "sender": {
      "user_ref": "USER-REF-ID"
    },
    "recipient": {
      "id": "PAGE-ID"
    },
    "timestamp": "1527459824",
    "postback": {
      "mid": "m_MESSAGE-ID",
      "title": "TITLE-FOR-THE-CTA",
      "payload": "USER-DEFINED-PAYLOAD",
      "referral": {
        "ref": "USER-DEFINED-REFERRAL-PARAM",
        "source": "SHORT-URL",
        "type": "OPEN_THREAD"
      }
    }
  }
}

Propriétés JSON

Toutes les propriétés JSON dans une notification de webhook sont des chaînes.

PropriétéDescription

postback.mid

ID du message

postback.payload

Informations définies dans le paramètre payload du CTA. Cette propriété est incluse uniquement dans la notification de webhook envoyée à l’application utilisée pour envoyer le message à la personne.

postback.referral

Informations relatives à l’action entreprise par la personne pour prendre part à la conversation.

Les informations relatives à la propriété referral sont incluses dans la notification de webhook uniquement quand une personne démarre une conversation par l’un des moyens suivants, puis clique sur un CTA, comme le bouton Démarrer :

  • Un plugin de discussion
  • Un lien m.me
  • Une publicité Clic vers Messenger
  • Un code QR Messenger
  • Un écran d’accueil

postback.referral.ref

Données arbitraires initialement transmises dans le paramètre ref ajouté au lien m.me. Seuls les caractères alphanumériques ainsi que -, _ et = sont pris en charge

postback.referral.source

URL de cette référence. Pour les liens m.me, la valeur de la source est “SHORTLINK”. Pour les références provenant de publicités de conversation Messenger, la valeur de la source est "ADS"

postback.referral.type

Identifiant de la référence. Pour les références provenant de liens m.me, le type est toujours "OPEN_THREAD".

postback.title

Titre du call-to-action (CTA) sur lequel une personne a cliqué

recipient.id

ID de votre Page Facebook

sender.user_ref

ID de la référence pour une personne à l’origine d’une action ayant déclenché l’envoi d’un message, comme un clic sur Démarrer, le plugin de discussion ou un élément du menu fixe

timestamp

Horodatage Unix correspondant à la date à laquelle la notification de webhook a été envoyée à votre serveur

Voir aussi

Autres documents dédiés aux développeur·ses pour approfondir les concepts abordés dans ce guide sur les webhooks messaging_postbacks.