Webhooks - Documentation - Meta for Developers

Présentation

Les webhooks permettent d’abonner les applications d’intégration personnalisées à des évènements dans Workplace et de recevoir des mises à jour en temps réel. Quand une modification est apportée dans Workplace, une requête HTTPS POST est envoyée à une URL de rappel pour chaque application d’intégration personnalisée abonnée au sujet webhook pertinent.

Les applications sont ainsi plus efficaces, car elles savent exactement quand une modification a été apportée et ne dépendent plus des requêtes continues ou même périodiques de l’API Graph pour obtenir les contenus les plus récents.

La prise en charge des webhooks pour Workplace est assurée par le même framework qui alimente les webhooks pour Facebook.

Abonnement aux sujets de webhook

La boîte de dialogue Modifier l’intégration personnalisée contient un onglet par sujet de webhook disponible pour les applications dans Workplace.

Onglet Webhooks dans la boîte de dialogue Modifier l’intégration personnalisée

Pour ajouter un nouvel abonnement webhook à un sujet donné, fournissez une URL de rappel et un token de vérification, puis sélectionnez les champs d’abonnement dont vous avez besoin pour les fonctionnalités que proposera votre application.

Vous ne pouvez abonner qu’une seule URL à chaque sujet de webhook, mais vous pouvez utiliser la même URL pour plusieurs sujets.

Gestion des requêtes de vérification

Quand vous ajoutez un nouvel abonnement ou modifiez un abonnement existant, les serveurs de Facebook envoient une requête GET à votre URL de rappel afin de vérifier la validité du serveur de rappel.

Une chaîne de requête est ajoutée à cette URL avec les paramètres suivants :

hub.mode : la chaîne subscribe est transmise dans ce paramètre
hub.challenge : une chaîne aléatoire
hub.verify_token : la valeur du verify_token spécifiée lors de la création de l’abonnement

Quand vous recevez la requête HTTP GET sur votre URL de rappel, vous pouvez utiliser le paramètre verify_token pour vérifier que la requête provient d’un serveur de Facebook.

Sécurité des webhooks

Tous les appels webhook aux URL de rappel définies par le développeur sont réalisés via HTTPS pour garantir la sécurité des charges utiles des webhooks pendant le transport.

Pour renforcer la sécurité, une X-Hub-Signature-256 avec un en-tête HTTP est intégrée dans chaque charge utile POST, que nous vous recommandons d’utiliser pour vérifier que la charge utile provient d’un serveur de Facebook.

Pour tout savoir sur ce processus, consultez la documentation sur le cadre Webhook de Facebook.

Sujets de webhooks

Les activités réalisées dans Workplace sont regroupées en sujets. Chaque sujet contient un certain nombre de champs associés à des évènements sur un sujet donné. Les applications peuvent être abonnées aux notifications webhook de chaque sujet ou à certains champs de chaque sujet.

Les webhooks sont actuellement disponibles pour les sujets et groupes suivants dans Workplace :

Page

Pour en savoir plus, consultez les documents de référence sur le sujet Page.

Champ d’abonnement	Comportement
`mention`	Déclenché quand une page d’intégrations personnalisées (bot) est mentionnée dans un groupe.
`messages`	Déclenché quand un message est envoyé dans Workplace Chat à une page d’intégrations personnalisées (bot).
`message_deliveries`	Déclenché quand un message envoyé par une page d’intégrations personnalisées (bot) est reçu.
`messaging_postbacks`	Déclenché quand quelqu’un appuie sur le bouton de postback dans Workplace Chat.
`message_reads`	Déclenché quand un message envoyé d’une page d’intégrations personnalisées (bot) est lu par le destinataire.

Groupe

Pour en savoir plus, consultez les documents de référence sur le sujet Groupe.

Champ d’abonnement	Comportement
`posts`	Déclenché quand une publication est ajoutée, mise à jour ou supprimée dans un groupe.
`comments`	Déclenché à chaque fois qu’un commentaire est ajouté, mis à jour ou supprimé sur une publication dans un groupe.
`membership`	Déclenché quand l’adhésion à un groupe est modifiée.

Utilisateur·trice

Pour en savoir plus, consultez les documents de référence sur le sujet Utilisateur·trice.

Champ d’abonnement	Comportement
`status`	Déclenché quand un utilisateur ou une utilisatrice publie ou modifie une mise à jour de statut sur son profil.
`events`	Déclenché à chaque fois qu’un utilisateur ou une utilisatrice crée, accepte ou refuse un évènement.
`message_sends`	Déclenché chaque fois qu’un utilisateur ou une utilisatrice envoie un message Workplace Chat.

Lien

Pour en savoir plus, consultez les documents sur les aperçus authentifiés.

Champ d’abonnement	Comportement
`preview`	Déclenché lorsque Workplace doit récupérer des informations sur une URL.
`collection`	S’applique uniquement aux applications figurant dans la liste d’éléments autorisés prenant en charge la navigation hiérarchique de l’éditeur de publication.

Sécurité

Pour en savoir plus, consultez les documents de référence sur le sujet Sécurité.

`sessions`

Évènements déclenchés quand un utilisateur ou une utilisatrice se connecte ou se déconnecte de Workplace.

Évènement Comportement

Évènement	Comportement
`log_in`	Un utilisateur ou une utilisatrice s’est connecté·e à Workplace avec son mot de passe ou l’authentification unique, sur le web ou une application mobile.
`log_out`	Un utilisateur ou une utilisatrice s’est déconnecté·e de Workplace, sur le web ou une application mobile. Ne comprend pas les déconnexions forcées à l’initiative de l’admin (consultez `admin_force_log_out`).

log_in

Un utilisateur ou une utilisatrice s’est connecté·e à Workplace avec son mot de passe ou l’authentification unique, sur le web ou une application mobile.

log_out

Un utilisateur ou une utilisatrice s’est déconnecté·e de Workplace, sur le web ou une application mobile.

Ne comprend pas les déconnexions forcées à l’initiative de l’admin (consultez admin_force_log_out).

`passwords`

Évènements déclenchés quand un utilisateur ou une utilisatrice modifie son mot de passe ou demande à le réinitialiser.

Évènement	Comportement
`password_change`	Le mot de passe d’un utilisateur ou d’une utilisatrice a été modifié, suite à une procédure de récupération ou via les paramètres du compte.
`password_reset_request`	Une procédure de récupération du mot de passe d’un·e utilisateur·ice a été initiée, et un code a été envoyé à l’adresse e-mail de l’utilisateur·ice.
`password_reset_wrong_code`	Un utilisateur ou une utilisatrice a saisi un code de récupération/réinitialisation du mot de passe incorrect.
`password_reset_success`	Une procédure de récupération du mot de passe a été suivie avec succès.

`admin_activity`

Évènements déclenchés quand un admin rejoint ou quitte une communauté Workplace.

Évènement	Comportement
`admin_set_to_unclaimed`	Un·e admin a défini l’état d’un compte utilisateur·ice sur non revendiqué, via le panneau d’administration ou l’API Account Management.
`admin_force_log_out`	Un·e admin a forcé la déconnexion d’un utilisateur ou d’une utilisatrice de tous les appareils à partir du panneau d’administration.
`admin_deactivate`	Un·e admin a désactivé un compte utilisateur·trice à partir du panneau d’administration ou via l’API Account Management.
`admin_activate_account`	Un·e admin a désactivé un compte à partir du panneau d’administration ou via l’API Account Management.
`force_password_reset`	Un·e admin a forcé la réinitialisation du mot de passe d’un utilisateur ou d’une utilisatrice à partir du panneau d’administration.
`admin_create_account`	Un·e admin a créé un compte à partir du panneau d’administration.

`two_factor`

Évènements déclenchés quand un utilisateur ou une utilisatrice active ou désactive l’authentification à deux facteurs.

Évènement	Comportement
`two_factor_enable`	Un utilisateur ou une utilisatrice a activé l’authentification à deux facteurs à partir de l’onglet Paramètres. Cela indique uniquement que la fonctionnalité a été activée, et non le moment où l’utilisateur·trice active la fonctionnalité sur un téléphone en particulier.
`two_factor_disable`	Un utilisateur ou une utilisatrice a désactivé l’authentification à deux facteurs à partir de l’onglet Paramètres. Cela indique uniquement que la fonctionnalité a été désactivée, et non le moment où l’utilisateur·trice supprime la fonctionnalité d’un téléphone en particulier.