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

Un évènement webhook d’abonnement aux messages est déclenché lorsqu’une personne accepte de recevoir des messages marketing ou appuie sur un plugin Envoyer vers Messenger.

Lorsque vous utilisez le plugin Envoyer vers Messenger, le paramètre optin.ref est défini sur le plugin par le champ data-ref. Les développeur·ses peuvent utiliser ce champ pour associer un rappel à un évènement de clic sur le plugin.

Notification webhook d’abonnement aux messages

Votre application reçoit une notification webhook d’abonnement dans les cas suivants :

  • Une personne s’abonne.
  • Une personne renouvelle son abonnement en cliquant sur le bouton Continuer les messages avant que le token de messages de notification expire.
  • Une personne modifie son statut d’abonnement, interrompant ou reprenant ainsi les notifications.
{
  "sender": {
    "id": "PSID",
  },
  "recipient": {
    "id": "PAGE-ID",
  },
  "timestamp": "TIMESTAMP",
  "optin": {
    "type": "notification_messages", 
    "payload": "ADDITIONAL-INFORMATION",
    "notification_messages_token": "NOTIFICATION-MESSAGES-TOKEN", 
    "notification_messages_frequency": "FREQUENCY",  
    "notification_messages_timezone": "TIMEZONE-ID",
    "token_expiry_timestamp": "TIMESTAMP",
    "user_token_status": "TOKEN-STATUS",  
    "notification_messages_status": "NOTIFICATION-STATUS",
    "title": "TITLE" 
    }
}

optin

PropriétéDescription

payload

chaîne

Informations supplémentaires que vous souhaitez inclure dans la notification webhook

title

chaîne

Titre affiché dans le modèle

notification_messages_token

chaîne

Token représentant la personne qui s’est abonnée (indiquant le sujet et la fréquence des messages sélectionnés) et qui sera utilisé pour envoyer les messages marketing

notification_messages_frequency

énumération { DAILY, WEEKLY, MONTHLY }

Les valeurs possibles sont les suivantes :

  • DAILY : envoyer une notification par période de 24 heures, pendant 6 mois à partir de la date d’abonnement
  • WEEKLY : envoyer une notification par semaine pendant 9 mois à partir de la date d’abonnement
  • MONTHLY : envoyer une notification par mois pendant 12 mois à partir de la date d’abonnement

(Supprimé dans l’API version 16)

notification_messages_timezone

chaîne

Fuseau horaire de la personne qui reçoit le message

notification_messages_status

énumération { STOP NOTIFICATIONS, RESUME NOTIFICATIONS }
Ce champ n’est présent que lorsque l’utilisateur·ice arrête ou reprend les messages marketing.

Les valeurs possibles sont les suivantes :

  • STOP NOTIFICATIONS : l’utilisateur·ice a cliqué sur Arrêter ces messages.
  • RESUME NOTIFICATIONS : l’utilisateur·ice a cliqué sur Reprendre ces messages.

token_expiry_timestamp

horodatage unix

Date et heure d’expiration du token de message de notification

type

chaîne

La valeur doit être notification_messages

user_token_status

énumération { REFRESHED, NOT_REFRESHED }

Les valeurs possibles sont les suivantes :

  • REFRESHED : valeur définie lorsque l’utilisateur·ice choisit de se réabonner aux messages marketing après l’expiration du token.
  • NOT_REFRESHED : valeur par défaut définie lorsque l’utilisateur·ice choisit de ne pas se réabonner aux messages marketing après l’expiration du token.