WebHook
Rappel de statut d'e-mail
URL
Remplissage défini par l'utilisateur sur la page
Content-Type :
application/json; charset=utf-8
Méthode de requête HTTP
post
En-têtes de la requête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| X-WebHook-Timestamp | String | true | horodatage |
| X-WebHook-AppKey | String | true | valeur fixe : "email" |
| X-WebHook-Signature | String | true | signature numérique |
Corps de la requête
| Paramètre | Type | Description |
|---|---|---|
| message_id | string | identifiant du message |
| from | string | expéditeur (vide dans le message cible) |
| subject | string | sujet (vide dans le message cible) |
| to | string | destinataire (vide dans le message cible) |
| server | string | |
| itime | long | horodatage de génération du message |
| custom_args | json | champs définis par le client |
| status | json | rappel de statut du message |
Astuce :
- Algorithme de signature : utilisez la clé d'application utilisateur comme clé de chiffrement pour effectuer une opération HmacSHA256 sur l'horodatage afin d'obtenir des caractères hexadécimaux.
Message de statut cible d'e-mail
Condition de déclenchement : requête d'e-mail réussie.
status
| Paramètre | Type | Description |
|---|---|---|
| message_status | string | target |
| status_data | objet json | données de statut |
| message | string | requête réussie |
| task_id | int | identifiant de tâche |
| api_user | string | utilisateur api |
| from | string | expéditeur |
| subject | string | sujet |
| tos | array | tableau des destinataires |
| email_ids | array | tableau d'identifiants e-mail des destinataires |
| label_id | int | identifiant d'étiquette |
{
"server": "email",
"message_id": "1676615711309_104117_18546_8821.sc-10_43_7_16-inbound",
"itime": 1676615711325,
"status": {
"message_status": "target",
"status_data": {
"email_ids": [
"1676615711309_104117_18546_8821.sc-10_43_7_16-inbound0$12345@hotmail.com"
],
"task_id": "-1",
"api_user": "scgp_email_system_trigger",
"from": "newsletter@mail.engagelab.com",
"subject": "Envoi via interface de modèle-variables dynamiques-Envoi unicast",
"tos": [
"12345@hotmail.com"
],
"message": "requête réussie",
"label_id": 0
}
},
"custom_args": {}
}
Message de statut envoyé d'e-mail
Condition de déclenchement : e-mail envoyé avec succès depuis EngageLab.
status
| Paramètre | Type | Description |
|---|---|---|
| message_status | string | sent |
| status_data | objet json | données de statut |
| message | string | envoyé avec succès |
| task_id | int | identifiant de tâche |
| api_user | string | utilisateur api |
| email_id | string | identifiant e-mail |
| label_id | int | identifiant d'étiquette |
{
"server": "email",
"message_id": "1676615711309_104117_18546_8821.sc-10_43_7_16-inbound0$12345@hotmail.com",
"from": "newsletter@mail.engagelab.com",
"subject": "Envoi via interface de modèle-variables dynamiques-Envoi unicast",
"to": "12345@hotmail.com",
"itime": 1676615714397,
"status": {
"message_status": "sent",
"status_data": {
"email_id": "1676615711309_104117_18546_8821.sc-10_43_7_16-inbound0$12345@hotmail.com",
"task_id": "-1",
"api_user": "scgp_email_system_trigger",
"message": "envoyé avec succès",
"label_id": 0
}
},
"custom_args": {}
}
Message de statut délivré d'e-mail
Condition de déclenchement : livraison d'e-mail réussie.
status
| Paramètre | Type | Description |
|---|---|---|
| message_status | string | delivered |
| status_data | objet json | données de statut |
| message | string | délivré avec succès |
| task_id | int | identifiant de tâche |
| api_user | string | utilisateur api |
| email_id | string | identifiant e-mail |
| label_id | int | identifiant d'étiquette |
{
"server": "email",
"message_id": "1675758375681_15_6393_8309.sc-10_2_226_96-test0$12345@gmail.com",
"from": "newsletter@mail.engagelab.com",
"subject": "Envoi via interface de modèle-variables dynamiques-Envoi unicast",
"to": "12345@gmail.com",
"itime": 1675758376586,
"status": {
"message_status": "delivered",
"status_data": {
"email_id": "1675758375681_15_6393_8309.sc-10_2_226_96-test0$12345@gmail.com",
"task_id": "-1",
"api_user": "1224_xjm",
"message": "délivré avec succès",
"label_id": 0
}
},
"custom_args": {}
}
Message de statut invalid_email d'e-mail
Condition de déclenchement : échec de la livraison de l'e-mail.
status
| Paramètre | Type | Description |
|---|---|---|
| message_status | string | invalid_email |
| status_data | objet json | données de statut |
| task_id | int | identifiant de tâche |
| api_user | string | utilisateur api |
| email_id | string | identifiant e-mail |
| label_id | int | identifiant d'étiquette |
| error_code | int | code d'erreur |
| error_detail | json | détail de l'erreur |
| message | string | journal de retour de la boîte mail |
| sub_stat | int | sous-catégorie d'erreur. 4xx indique que la catégorie est invalid email |
| sub_stat_desc | string | description de la sous-catégorie d'erreur |
{
"server": "email",
"message_id": "1676537131885_95_4921_8644.sc-10_2_226_96-test0$12345@gmail.com",
"from": "newsletter@mail.engagelab.com",
"subject": "Envoi via interface de modèle-variables dynamiques-Envoi unicast",
"to": "12345@gmail.com",
"itime": 1676537132783,
"status": {
"message_status": "invalid_email",
"error_code": 409,
"error_detail": {
"sub_stat": 409,
"message": "Le domaine peut ne pas exister ou la vérification DNS a échoué [MF99jssew+U8hyLhCJdZwkffXOKzGzvvQq5UZaSZR1BIotz1+sUrL6gFET3lJu6KdQ== IP: 8.219.236.47].",
"sub_stat_desc": "Autre"
},
"status_data": {
"email_id": "1676537131885_95_4921_8644.sc-10_2_226_96-test0$12345@gmail.com",
"task_id": "-1",
"api_user": "postmaster@sendcloud.io",
"label_id": 0
}
},
"custom_args": {}
}
Message de statut soft_bounce d'e-mail
Condition de déclenchement : le message e-mail a atteint le serveur de messagerie du destinataire mais a ensuite été retourné.
status
| Paramètre | Type | Description |
|---|---|---|
| message_status | string | soft_bounce |
| status_data | objet json | données de statut |
| task_id | int | identifiant de tâche |
| api_user | string | utilisateur api |
| email_id | string | identifiant e-mail |
| label_id | int | identifiant d'étiquette |
| error_code | int | code d'erreur |
| error_detail | json | détail de l'erreur |
| message | string | journal de retour de la boîte mail |
| sub_stat | int | sous-catégorie d'erreur. 5XX indique que la catégorie est soft bounce |
| sub_stat_desc | string | description de la sous-catégorie d'erreur |
{
"server": "email",
"message_id": "1676537131885_95_4921_8644.sc-10_2_226_96-test0$12345@gmail.com",
"from": "newsletter@mail.engagelab.com",
"subject": "Envoi via interface de modèle-variables dynamiques-Envoi unicast",
"to": "12345@gmail.com",
"itime": 1676537132783,
"status": {
"message_status": "soft_bounce",
"error_code": 509,
"error_detail": {
"sub_stat": 509,
"message": "Le domaine peut ne pas exister ou la vérification DNS a échoué [MF99jssew+U8hyLhCJdZwkffXOKzGzvvQq5UZaSZR1BIotz1+sUrL6gFET3lJu6KdQ== IP: 8.219.236.47].",
"sub_stat_desc": "Autre"
},
"status_data": {
"email_id": "1676537131885_95_4921_8644.sc-10_2_226_96-test0$12345@gmail.com",
"task_id": "-1",
"api_user": "postmaster@sendcloud.io",
"label_id": 0
}
},
"custom_args": {}
}
Rappel de réponse d'e-mail
URL
Remplissage défini par l'utilisateur sur la page
Content-Type :
application/json; charset=utf-8
Méthode de requête HTTP
post
En-têtes de la requête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| X-WebHook-Timestamp | String | true | horodatage |
| X-WebHook-AppKey | String | true | valeur fixe : "email" |
| X-WebHook-Signature | String | true | signature numérique |
Corps de la requête
| Paramètre | Type | Description |
|---|---|---|
| message_id | string | identifiant du message |
| from | string | expéditeur (vide dans le message de routage) |
| subject | string | sujet (vide dans le message de routage) |
| to | string | destinataire |
| server | string | |
| itime | long | horodatage de génération du message |
| custom_args | json | champs définis par le client |
| response | json | rappel de réponse du message |
Astuce :
- Algorithme de signature : utilisez la clé d'application utilisateur comme clé de chiffrement pour effectuer une opération HmacSHA256 sur l'horodatage afin d'obtenir des caractères hexadécimaux.
Message de réponse open d'e-mail
Condition de déclenchement : le destinataire ouvre l'e-mail.
response
| Paramètre | Type | Description |
|---|---|---|
| event | string | open |
| response_data | objet json | données de réponse |
| message | string | ouverture de l'e-mail |
| task_id | int | identifiant de tâche |
| api_user | string | utilisateur api |
| email_id | string | identifiant e-mail |
| label_id | int | identifiant d'étiquette |
| ip | string | IP de l'opération |
| explorer_name | string | nom du navigateur |
| explorer_ver | string | version du navigateur |
| os_name | string | nom du système d'exploitation |
| os_ver | string | version du système d'exploitation |
{
"server": "email",
"message_id": "1676618583015_104117_18546_8822.sc-10_43_7_16-inbound0$12345@hotmail.com",
"from": "newsletter@mail.engagelab.com",
"subject": "Envoi via interface de modèle-variables dynamiques-Envoi unicast",
"to": "12345@hotmail.com",
"itime": 1676620370426,
"response": {
"event": "open",
"response_data": {
"email_id": "1676618583015_104117_18546_8822.sc-10_43_7_16-inbound0$12345@hotmail.com",
"explorer_ver": "101.0.4951",
"os_ver": "8",
"explorer_name": "Chrome",
"ip": "8.219.124.204",
"os_name": "Windows",
"task_id": "0",
"api_user": "JGgkm3wedVik_test_y1mQMX",
"message": "ouverture de l'e-mail",
"label_id": 0
}
},
"custom_args": {}
}
Message de réponse click d'e-mail
Condition de déclenchement : le destinataire clique sur le lien de l'e-mail.
response
| Paramètre | Type | Description |
|---|---|---|
| event | string | click |
| response_data | objet json | données de réponse |
| message | string | clic sur l'e-mail |
| task_id | int | identifiant de tâche |
| api_user | string | utilisateur api |
| email_id | string | identifiant e-mail |
| label_id | int | identifiant d'étiquette |
| url | string | url cliquée |
| ip | string | IP de l'opération |
| explorer_name | string | nom du navigateur |
| explorer_ver | string | version du navigateur |
| os_name | string | nom du système d'exploitation |
| os_ver | string | version du système d'exploitation |
{
"server": "email",
"message_id": "1676618583015_104117_18546_8822.sc-10_43_7_16-inbound0$12345@hotmail.com",
"from": "newsletter@mail.engagelab.com",
"subject": "Envoi via interface de modèle-variables dynamiques-Envoi unicast",
"to": "12345@hotmail.com",
"itime": 1676620370426,
"response": {
"event": "click",
"response_data": {
"email_id": "1676618583015_104117_18546_8822.sc-10_43_7_16-inbound0$12345@hotmail.com",
"explorer_ver": "101.0.4951",
"os_ver": "8",
"explorer_name": "Chrome",
"ip": "8.219.124.204",
"url": "https://www.engagelab.com/zh_CN/email/",
"os_name": "Windows",
"task_id": "0",
"api_user": "JGgkm3wedVik_test_y1mQMX",
"message": "clic sur l'e-mail",
"label_id": 0
}
},
"custom_args": {}
}
Message de réponse unsubscribe d'e-mail
Condition de déclenchement : le destinataire clique pour se désabonner.
response
| Paramètre | Type | Description |
|---|---|---|
| event | string | unsubscribe |
| response_data | objet json | données de réponse |
| message | string | désabonnement de l'e-mail |
| task_id | int | identifiant de tâche |
| api_user | string | utilisateur api |
| email_id | string | identifiant e-mail |
| label_id | int | identifiant d'étiquette |
| ip | string | IP de l'opération |
| explorer_name | string | nom du navigateur |
| explorer_ver | string | version du navigateur |
| os_name | string | nom du système d'exploitation |
| os_ver | string | version du système d'exploitation |
{
"server": "email",
"message_id": "1676460128030_100669_28018_8253.sg-10_1_253_26-inbound86$12345@gmail.com",
"from": "newsletter@mail.engagelab.com",
"subject": "Envoi via interface de modèle-variables dynamiques-Envoi unicast",
"to": "12345@gmail.com",
"itime": 1676623616503,
"response": {
"event": "unsubscribe",
"response_data": {
"email_id": "1676460128030_100669_28018_8253.sg-10_1_253_26-inbound86$12345@gmail.com",
"explorer_ver": "16.2",
"os_ver": "16.2",
"explorer_name": "Mobile Safari",
"ip": "80.14.210.102",
"os_name": "iOS",
"task_id": "0",
"api_user": "1224_xjm",
"message": "désabonnement de l'e-mail",
"label_id": 221223
}
},
"custom_args": {}
}
Message de réponse report_spam d'e-mail
Condition de déclenchement : le destinataire signale l'e-mail comme spam.
response
| Paramètre | Type | Description |
|---|---|---|
| event | string | report_spam |
| response_data | objet json | données de réponse |
| api_user | string | utilisateur api |
| email_id | string | identifiant e-mail |
| label_id | int | identifiant d'étiquette |
{
"server": "email",
"message_id": "1676857822846_15_23558_89.sg-10_1_253_26-inbound0$12345@gmail.com",
"from": "newsletter@mail.engagelab.com",
"subject": "Envoi via interface de modèle-variables dynamiques-Envoi unicast",
"to": "12345@gmail.com",
"itime": 1677548340323,
"response": {
"event": "report_spam",
"response_data": {
"email_id": "1676857822846_15_23558_89.sg-10_1_253_26-inbound0$1406064670@gmail.com",
"api_user": "huangli",
"label_id": 0
}
},
"custom_args": {}
}
Message de réponse route d'e-mail
Condition de déclenchement : le destinataire répond ou envoie vers la route de réception.
response
| Paramètre | Type | Description |
|---|---|---|
| event | string | route |
| response_data | objet json | données de réponse |
| message | string | routage mx |
| html | string | html de l'e-mail |
| text | string | texte brut de l'e-mail |
| headers | string | en-tête de l'e-mail routé |
| from_name | string | nom de l'expéditeur |
| subject | string | sujet de l'e-mail |
| from | string | adresse de l'expéditeur |
| reference | string | référence |
| email_id | string | identifiant e-mail |
| raw_message | string | message brut |
| raw_message_url | string | url de téléchargement du message brut |
| x_mx_mailfrom | string | x_mx_mailfrom |
| x_mx_rcptto | string | x_mx_rcptto |
| label_id | int | identifiant d'étiquette |
{
"server": "email",
"message_id": "01b6f68b-da52-4f6f-a049-68d0ca01dd8c",
"to": "Goblin <12345@gmail.com>;Illidan <12345@hotmail.com>",
"itime": 1676618346192,
"response": {
"event": "route",
"response_data": {
"headers": {
"Cc": "Malfurion <12345@gmail.com>",
"To": "Goblin <12345@gmail.com>",
"Content-Type": "multipart/alternative; boundary=\"00000000000092f9ca05f4e02010\"",
"From": "Archimonde <12345@outlook.com>",
"MIME-Version": "1.0",
"Date": "Fri, 17 Feb 2023 12:48:48 +0530",
"Subject": "Re: Plan de travail pour le mois prochain"
},
"raw_message": "Received: from MAIL-ED1-F51.GOOGLE.COM (unknown [209.85.208.51])by mx2.sendcloud.org with SMTP ......",
"subject": "Re: Plan de travail pour le mois prochain",
"x_mx_rcptto": "12345@icloud.com",
"html": "<div dir=\"ltr\">Bonjour l'équipe,<div><br></div><div>Commençons ......",
"from": "Archimonde <12345@outlook.com>",
"text": "Bonjour l'équipe,Commençons ......",
"x_mx_mailfrom": "12345@hotmail.com",
"message": "routage mx",
"from_name": "Sargeras",
"raw_message_url": "https://......eml"
"label_id": 0
}
},
"custom_args": {}
}
