Réponses Webhook - Campagnes Email et Contacts

Qu'est-ce qu'un webhook ?

 

Un webhook est une appel fait à une URL quand un événement, tel qu'un hard bounce, une ouverture, une suppression de contact etc, se produit.

 

Quand un événement ou un changement de statut se produit, une requête HTTP POST est envoyée en temps réel à l'URL renseignée. Cet appel POST contient des informations sur l'événement.

 

Réponses Webhook

 

Les réponses sont envoyées en format JSON et sont transmises en POST à l'URL renseignée.

 

Vous trouverez ci-dessous les différents événements webhook ainsi que les réponses attendues.

 

 

Note :

 

ts, ts_sent, ts_event Fuseau horaire UTC.
date_sent, date_event Fuseau horaire local
date Fuseau horaire CET/CEST 

 

Signalé comme spam

 

LABEL TYPE DESCRIPTION
event string "spam"
email string Email du destinataire
id integer ID interne du webhook
date_sent string Date d'envoi de la campagne (année-mois-jour, heure:minute:seconde)
date_event string Date de l'événement (année-mois-jour, heure:minute:seconde)
ts_sent integer Timestamp en secondes de la date d'envoi de la campagne
ts_event integer Timestamp en secondes de la date de l'événement
camp_id integer ID de la campagne
campaign name string Nom de la campagne
reason string Motif du spam
ts integer Timestamp en secondes de la date de l'appel webhook
tag string Tag de la campagne

 

Exemple de réponse

 

{"id":139911,"camp_id":253,"email":"abc@example.com","campaign name":"Campaign ABC","date_sent":"2019-07-30 08:00:51","date_event":"2019-07-30 08:00:51","event":"spam","tag":"abc","reason":"lorem ipsum","ts_sent":1564466451,"ts_event":1564466451,"ts":1564466452}

 

Ouverture

 

LABEL TYPE DESCRIPTION
event string "opened"
email string Email du destinataire
id integer ID interne du webhook
date_sent string Date d'envoi de la campagne (année-mois-jour, heure:minute:seconde)
date_event string Date de l'événement (année-mois-jour, heure:minute:seconde)
ts_sent integer Timestamp en secondes de la date d'envoi de la campagne
ts_event integer Timestamp en secondes de la date de l'événement
camp_id integer ID de la campagne
campaign name string Nom de la campagne
tag string Tag de la campagne
ts integer Timestamp en secondes de la date de l'appel webhook

 

Exemple de réponse

 

{"id":139911,"camp_id":253,"email":"abc@example.com","campaign name":"Campaign ABC","date_sent":"2019-07-30 11:30:50","date_event":"2019-07-30 11:39:15","event":"opened","tag":"abc","ts_sent":1564479050,"ts_event":1564479555,"ts":1564466956} 

 

Cliqué

 

LABEL TYPE DESCRIPTION
event string "clicked"
email string Email du destinataire
id integer ID interne du webhook
date_sent string Date d'envoi de la campagne (année-mois-jour, heure:minute:seconde) (Fuseau horaire local)
date_event string Date de l'événement (année-mois-jour, heure:minute:seconde)
ts_sent integer Timestamp en secondes de la date d'envoi de la campagne
ts_event integer Timestamp en secondes de la date de l'événement
camp_id integer ID de la campagne
campaign name string Nom de la campagne
tag string Tag de la campagne
ts integer Timestamp en secondes de la date de l'appel webhook
URL string URL cliqué

 

Exemple de réponse

 

{"id":139911,"camp_id":253,"email":"abc@example.com","campaign name":"Campaign ABC","date_sent":"2019-07-30 11:30:50","date_event":"2019-07-30 11:39:15","event":"clicked","tag":"abc","ts_sent":1564479050,"ts_event":1564479555,"URL":"https://example.com","ts":1564466956} 

 

Hard Bounce

 

LABEL TYPE DESCRIPTION
event string "hard_bounce"
email string Email du destinataire
id integer ID interne du webhook
date_sent string Date d'envoi de la campagne (année-mois-jour, heure:minute:seconde) (Fuseau horaire local)
date_event string Date de l'événement (année-mois-jour, heure:minute:seconde)
ts_sent integer Timestamp en secondes de la date d'envoi de la campagne
ts_event integer Timestamp en secondes de l'événement
camp_id integer ID de la campagne
campaign name string Nom de la campagne
sending_ip string IP d'envoi
reason string Raison du hard bounce
ts integer Timestamp en secondes de la date de l'appel webhook
tag string Tag de la campagne

 

Exemple de réponse

 

{"id":139911,"camp_id":253,"email":"abc@example.com","campaign name":"Campaign ABC","date_sent":"2019-07-30 08:00:51","date_event":"2019-07-30 08:00:51","event":"hard_bounce","tag":"abc","reason":"lorem ipsum","ts_sent":1564466451,"ts_event":1564466451,"sending_ip":"111.11.11.1","ts":1564466452} 

 

Soft Bounce

 

LABEL TYPE DESCRIPTION
event string "soft_bounce"
email string Email du destinataire
id integer ID interne du webhook
date_sent string Date d'envoi de la campagne (année-mois-jour, heure:minute:seconde) (Fuseau horaire local)
date_event string Date de l'événement (année-mois-jour, heure:minute:seconde)
ts_sent integer Timestamp en secondes de la date d'envoi de la campagne
ts_event integer Timestamp en secondes de l'événement
camp_id integer ID de la campagne
campaign name string Nom de la campagne
reason string Raison du soft bounce
sending_ip string IP d'envoi
ts integer Timestamp en secondes de la date de l'appel webhook
tag string Tag de la campagne

 

Exemple de réponse

 

{"id":139911,"camp_id":253,"email":"abc@example.com","campaign name":"Campaign ABC","date_sent":"2019-07-30 08:00:51","date_event":"2019-07-30 08:00:51","event":"soft_bounce","tag":"abc","reason":"lorem ipsum","ts_sent":1564466451,"ts_event":1564466451,"sending_ip":"111.11.11.1","ts":1564466452}

 

Delivré

 

LABEL TYPE DESCRIPTION
event string "delivered"
email string Email du destinataire
id integer ID interne du webhook
date_sent string Date d'envoi de la campagne (année-mois-jour, heure:minute:seconde) (Fuseau horaire local)
date_event string Date de l'événement (année-mois-jour, heure:minute:seconde)
ts_sent integer Timestamp en secondes de la date d'envoi de la campagne
ts_event integer Timestamp en secondes de l'événement
sending_ip string IP d'envoi
camp_id integer ID de la campagne
campaign name string Nom de la campagne
ts integer Timestamp en secondes de la date de l'appel webhook
tag string Tag de la campagne

 

Exemple de réponse

 

{"id":139911,"camp_id":253,"email":"abc@example.com","campaign name":"Campaign ABC","date_sent":"2019-07-30 08:00:51","date_event":"2019-07-30 08:00:51","event":"delivered","tag":"abc","ts_sent":1564466451,"ts_event":1564466451,"sending_ip":"111.11.11.1","ts":1564466452}

 

Désinscrit

 

LABEL TYPE DESCRIPTION
event string "unsubscribe"
email string Email du destinataire
id integer ID interne du webhook
date_sent string Date d'envoi de la campagne (année-mois-jour, heure:minute:seconde)
date_event string Date de l'événement (année-mois-jour, heure:minute:seconde)
ts_sent integer Timestamp en secondes de la date d'envoi de la campagne
ts_event integer Timestamp en secondes de l'événement
camp_id integer ID de la campagne
campaign name string Nom de la campagne
list_id array of integers ID de la ou des liste(s) desquelle(s) le contact a été désinscrit
ts integer Timestamp en secondes de la date de l'appel webhook
tag string Tag de la campagne

 

Exemple de réponse

 

{"id":139911,"camp_id":253,"email":"abc@example.com","campaign name":"Campaign ABC","date_sent":"2019-07-30 11:30:50","date_event":"2019-07-30 11:39:15","event":"unsubscribe","tag":"abc","list_id":[63,61],"ts_sent":1564479050,"ts_event":1564479555,"ts":1564466956} 

 

Contact ajouté à une liste

 

LABEL TYPE DESCRIPTION
event string "list_addition"
email string Email du contact ajouté
id integer ID interne du webhook
key string Clé interne
list_id array of integers ID de la ou des liste(s) où le contact a été ajouté
date string Date de l'événement (année-mois-jour, heure:minute:seconde)
ts integer Timestamp en secondes de la date de l'appel webhook

 

Exemple de réponse

 

{"id":139911,"email":"lu.sykora@demo.domain","event":"list_addition","key":"fsn920nfsv6h0gfkkqrb5","list_id":[63,61],"date":"2019-07-30 08:48:11","ts":1564469292}

 

Contact mis à jour

 

LABEL TYPE DESCRIPTION
event string "contact_updated"
email string Email du contact mis à jour
id integer ID interne du webhook
key string Clé interne
date string Date de l'événement (année-mois-jour, heure:minute:seconde)
ts integer Timestamp en secondes de la date de l'appel webhook
content array of strings Données mises à jour

 

Exemple de réponse

 

{"id":139911,"event":"contact_updated","key":"fsn920nfsv6h0gfkkqrb5","date":"2019-07-30 08:52:02","ts":1564469523,"content":[{"email":"lu.sykora@demo.domain","attributes":{"FIRSTNAME":"Luke","LASTNAME":"Sykora","SMS":"30764261246","SHOPIFY_LAST_30_DAYS_CA":0,"SHOPIFY_ORDER_TOTAL":0,"SHOPIFY_CA_USER":0}}]}

 

Contact supprimé

 

LABEL TYPE DESCRIPTION
event string "contact_deleted"
email string Email du contact supprimé
id integer ID interne du webhook
key string Clé interne
date string Date de l'événement (année-mois-jour, heure:minute:seconde)
ts integer Timestamp en secondes de la date de l'appel webhook

 

Exemple de réponse

 

{"id":139911,"email":["lu.sykora@demo.domain"],"event":"contact_deleted","key":"fsn920nfsv6h0gfkkqrb5","date":"2019-07-30 08:53:17","ts":1564469598}