Maitrisez le format des webhook / notifications via URL pour vos emails transactionnels

De manière optionnelle dans l'étape Suivis, vous pouvez renseigner des adresses urls (http…) pour recevoir sur celle-ci les différents types de notifications en retour à chaque envoi d'email transactionnel.

Pour chaque type, les notifications sont transmises une seule fois aux adresses urls que vous aurez éditées en utilisant les codes suivants :

{from} : adresse email de l'émetteur du message
{account} : numéro du compte émetteur
{to} : adresse du destinataire de l'email envoyé
{url} : adresse de l'url du lien cliqué dans l'email envoyé
{yyyy} : format date de l'année sur 4 chiffres (ex : 2016)
{yy} : format date de l'année sur 2 chiffres (ex : 16)
{MM} : format date du mois sur 2 chiffres (ex : 01)
{M} : format date du mois sur 1 chiffre (ex : 1)
{dd} : format date du jours sur 2 chiffres (ex : 01)
{d} : format date du jours sur 1 chiffre (ex : 1)
{HH} : format date de l'heure sur 2 chiffres (ex : 01)
{H} : format date de l'heure sur 1 chiffre (ex : 1)
{mm} : format date des minutes sur 2 chiffres (ex : 01)
{m} : format date des minutes sur 1 chiffre (ex : 1)
{ss} : format date des secondes sur 2 chiffres (ex : 01)
{s} : format date des secondes sur 1 chiffre (ex : 1)
{dateIso} : date sous la forme YYYY-MM-DDTHH:mm:ss.sssZ qui est un format standard (ISO-8601)
{data} : adresse IP de l'ouvreur ou cliqueur de l'email envoyé, détail du retour Soft ou Hard (limité aux 255 premiers caractères)
{xmbcustomid} : ajouter dans l'entête technique (header) de vos messages sortants un commentaire « XMBCustomId:XXXXX » en adaptant le XXXXX à l'ID que vous souhaitez attribuer à chaque message sortant depuis votre back-office d'envoi. Récupérer votre ID en utilisant le code {x-mb-customid} à renseigner dans les paramètres des webhooks des événements suivants : envoyé, accepté, ouverture, clic.
Cette possibilité n'est pas compatible avec des envois via l'appel API sendsmtp. En effet, cet appel s'appuie sur un modèle d'emailing ne permettant pas de gérer l'entête technique des messages.

EXEMPLES D'URL :

http://www.votredomaine.net/notification.php?n=clicdesabo&from={from}&account={account}&to={to}&url={url}&yyyy={yyyy}&MM={MM}&dd={dd}&HH={HH}&mm={mm}&ss={ss}&dateiso={dateIso}&data={data}

Pour être conforme à la RFC 3986, tous les caractères spéciaux éventuellement passés dans les paramètres d'url sont à renseigner en url-encodés ([ par %5B, ] par %5D) et ce, hormis pour les caractères accolades des codes ci-dessus. Exemple :

http://www.votredomaine.net/notification.php?details%5Bdate%5D={yyyy}-{MM}-{dd}