Référence sur les évènements webhook `messaging_referrals`

Ce rappel a lieu lorsque l’utilisateur·ice a déjà une discussion avec le bot et qu’il ou elle vient sur cette discussion après avoir :

suivi un lien m. me avec un paramètre de référence ;
cliqué sur une publicité de conversation Messenger ;
engagé ou repris une conversation à l’aide du plugin de discussion clientèle.

Pour suivre les références dans de nouvelles discussions, consultez Évènement postback.

Pour recevoir ces évènements, vous devez vous abonner à messaging_referrals dans les paramètres webhook de votre application.

Exemples

Lien m.me

{
  "sender": {
    "id": "<PSID>"
  },
  "recipient": {
    "id": "<PAGE_ID>"
  },
  "timestamp": 1458692752478,
  "referral": {
    "ref": <REF_DATA_PASSED_IN_M.ME_PARAM>,
    "source": "SHORTLINK",
    "type": "OPEN_THREAD",
  }
}

Référence publicitaire

{
  "sender": {
    "id": "<PSID>"
  },
  "recipient": {
    "id": "<PAGE_ID>"
  },
  "timestamp": 1458692752478,
  "referral": {
    "ref": <REF_DATA_IF_SPECIFIED_IN_THE_AD>,
    "ad_id": <ID_OF_THE_AD>,
    "source": "ADS",
    "type": "OPEN_THREAD",
    "ads_context_data": {
      "ad_title": <TITLE_OF_THE_AD>,
      "photo_url": <URL_OF_THE_IMAGE_FROM_AD_THE_USER_IS_INTERESTED_IN>,
      "video_url": <THUMBNAIL_URL_OF_THE_VIDEO_FROM_THE_AD>,
      "post_id": <ID_OF_THE_POST>,
      "product_id": <PRODUCT_ID>
    }
  }
}

Plugin de discussion clientèle

Modification importante (5 mai 2020)

L’évènement webhook messaging_referrals pour l’API Graph 7.0 (et versions ultérieures) du plugin de discussion ne renverra pas de champ sender.id. Il renverra un nouveau champ sender.user_ref. Cette modification prendra effet dans toutes les anciennes versions de l’API Graph à compter du 2 novembre 2020.

Nouvel évènement webhook de référence (API Graph version 7.0 et ultérieures, et toutes les versions de l’API Graph à compter du 2 novembre 2020)

{
  "sender":{
    "user_ref":"<USER_REF>"
  },
  "recipient":{
    "id":"<PAGE_ID>"
  },
  "timestamp": 1458692752478,
  "referral": {
     "ref": "<REF_DATA_PASSED_IN_CODE>",
     "source": "CUSTOMER_CHAT_PLUGIN",
     "type": "OPEN_THREAD",
     "referer_uri": "<WEBSITE_URL>"
  }
}

Ancien évènement webhook de référence (API Graph version 6.0 et antérieures, disponibles jusqu’au 2 novembre 2020)

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<PAGE_ID>"
  },
  "timestamp": 1458692752478,
  "referral": {
     "ref": "<REF_DATA_PASSED_IN_CODE>",
     "source": "CUSTOMER_CHAT_PLUGIN",
     "type": "OPEN_THREAD",
     "referer_uri": "<WEBSITE_URL>"
  }
}

Propriétés

`sender`

Propriété	Type	Description
`id`	Chaîne	PSID de la personne qui a déclenché l’évènement webhook.
`user_ref`	Chaîne	Référence user_ref de la personne qui a déclenché l’évènement webhook. Uniquement disponible pour l’évènement webhook du plugin de discussion.

`recipient`

Propriété	Type	Description
`id`	Chaîne	ID de votre page.

`referral`

Propriété	Type	Description
`source`	Chaîne	Source de cette référence. Valeurs prises en charge : `ADS` `SHORTLINK` `CUSTOMER_CHAT_PLUGIN`
`type`	Chaîne	Type de référence. Valeur acceptée : `OPEN_THREAD`.
`ref`	Chaîne	Attribut `ref` optionnel défini dans le référent. Seuls les caractères alphanumériques ainsi que -, _ et = sont pris en charge.
`referer_uri`	Chaîne	URI du site où le message a été envoyé dans le plugin de discussion Facebook.
`is_guest_user`	Chaîne	Indicateur qui précise s’il s’agit d’un·e utilisateur·ice invité·e du Plugin de discussion Facebook
`ads_context_data`	Objet	Données contenant des informations sur la publicité clic vers Messenger à partir de laquelle la discussion a été lancée.

`ads_context_data`

Property	Type	Description
`ad_title`	String	Title of the Ad.
`photo_url`	String	[Optional] Url of the image from the Ad the user is interested.
`video_url`	String	[Optional] Thumbnail url of the the video from the ad.
`post_id`	String	ID of the post.
`product_id`	String	[Optional] Product ID from the Ad the user is interested.

Référence sur les évènements webhook messaging_referrals