Newsletter – Webhooks

Comprendre les Webhooks pour les Newsletters

Les webhooks sont des appels HTTP/HTTPS que votre blog WordPress effectue vers un système externe lorsqu’un événement se produit. Le plugin Newsletter a la capacité de signaler plusieurs événements à des systèmes externes, notamment lorsqu’un utilisateur s’inscrit, annule son abonnement ou lorsqu’une newsletter est envoyée. Cette fonctionnalité permet d’intégrer vos flux de travail avec d’autres outils, offrant ainsi une grande flexibilité et un contrôle accru sur la gestion de vos abonnés.

Mise en Place d’un Webhook

Configurer un webhook est relativement simple. Tout ce dont vous avez besoin est l’URL que le système externe va appeler, par exemple, https://externalapi.org/something, et de sélectionner l’événement que vous souhaitez surveiller. L’URL est fournie par le système externe capable de gérer cet appel.

Lorsque l’événement spécifié se produit, le plugin Newsletter envoie un appel à l’URL en transmettant un ensemble de données, que ce soit des détails sur le nouvel abonné ou des informations sur la newsletter envoyée. Vous avez la possibilité de choisir le format de données transmis lors de la configuration du webhook. Deux options principales sont disponibles : une « requête HTTP standard » où les champs peuvent être accédés via $_POST['email'] en PHP, ou un « HTTP post brut » où vous devrez lire le corps du POST et le décoder pour en extraire les données.

Il est à noter que ces appels ne se font pas de manière synchrone. Au lieu de cela, ils sont planifiés pour être envoyés dès que possible après l’événement déclencheur. Cela est particulièrement important pour les événements liés aux abonnés, car un appel fait en « temps réel » pourrait ralentir le flux d’inscription.

Pour vous assurer que votre configuration fonctionne comme prévu, vous pouvez utiliser la fonction de test qui permet de simuler des appels sans procéder à de véritables inscriptions.

Données des Abonnés

Lorsqu’il s’agit d’un événement lié à un abonné, comme la confirmation d’une inscription ou l’annulation d’un abonnement, chaque champ du profil de l’abonné est envoyé à l’URL spécifiée, que ce soit sous forme de POST standard ou sous forme d’un POST brut en JSON. Voici les principaux champs compris dans ces données :

• id : l’identifiant unique de l’abonné
• nom : le prénom ou le nom complet
• prénom : le nom de famille
• sexe : le genre
• list_N (avec N de 1 à 40) : indique à quelles listes l’abonné est associé (valeur 1) ou non (valeur 0)
• profile_N (avec N de 1 à 20) : champs supplémentaires de profil (texte)

D’autres champs mineurs ou techniques pourraient également être envoyés.

Accès aux Données avec un POST Standard

Si vous optez pour le POST standard pour transférer les données, votre point de terminaison traitera cela comme des champs de requête habituels. Par exemple, en PHP, vous pouvez y accéder comme ceci :

php
$email = $_POST['email'];
$id = $_POST['id'];

Il peut être utile de dump l’intégralité du contenu POST dans un fichier pour déboguer l’appel et voir l’intégralité des données « postées » :

php
file_put_contents('debug.txt', print_r($_POST, true));

Accès aux Données avec un POST JSON

Au cas où vous choisiriez la méthode du POST HTTP encodé en JSON, les données doivent être extraites du corps du POST. Voici un exemple élémentaire :

php
$json_body = file_get_contents('php://input');
$data = json_decode($json_body, true);
$id = $data['id'];
$email = $data['email'];

Ou pour traiter les données comme un objet standard :

php
$data = json_decode($json_body);
$id = $data->id;
$email = $data->email;

Données des Newsletters

Les données représentant une newsletter comprennent plusieurs champs principaux :

• id : l’identifiant unique de la newsletter
• sujet : le titre de la newsletter
• message : le message HTML complet
• sent : le nombre d’emails envoyés
• open_count : combien d’abonnés l’ont ouverte
• click_count : combien d’abonnés ont cliqué sur un lien dans le corps de la newsletter

Pour le format des données et comment les traiter, référez-vous aux instructions sur les données d’abonnés ci-dessus.

Tests et Validation

Une fois qu’un webhook a été défini, il figure dans une liste avec un bouton de test. Ce test génère un ensemble fictif de données et exécute l’appel. Si quelque chose ne fonctionne pas correctement, une alerte doit être affichée, et les logs doivent enregistrer la raison du problème, offrant ainsi un chemin de débogage utile.

Questions Fréquemment Posées

Combien de webhooks peuvent être définis ?

Vous pouvez définir autant de webhooks que nécessaire. Cette flexibilité vous permet d’adapter le système à vos divers besoins en fonction des événements spécifiques que vous souhaitez suivre.

Que faire si quelque chose ne fonctionne pas ?

Le module complémentaire enregistre toutes les actions internes dans un log accessible sur le panneau Newsletter System > Logs. Vous y trouverez une explication technique en cas de défaillance. Il est important de définir un niveau de log adéquat dans les paramètres principaux du plugin. Pour les tests, il est recommandé de régler le niveau sur « débogage » pour obtenir le maximum d’informations possibles. Cela vous aide à identifier rapidement et facilement les problèmes rencontrés.

Les webhooks pour newsletters représentent une puissante opportunité d’améliorer votre communication et une meilleure gestion de vos abonnés. En intégrant ces appels dans votre stratégie, vous pouvez automate les échanges de données entre votre blog et d’autres outils marketing, améliorant ainsi l’efficacité de vos actions et enrichissant l’expérience utilisateur. Que ce soit pour l’inscription, l’annulation ou l’envoi de newsletters, les webhooks vous offrent une granularité dans le suivi et l’analyse des interactions de vos abonnés avec votre contenu, apportant une couche de professionnalisme et de précision à votre stratégie marketing numérique.