WebHook
E-Mail-Status-Callback
URL
Vom Nutzer auf der jeweiligen Seite festzulegen
Content-Type:
application/json; charset=utf-8
HTTP-Request-Methode
post
Request-Header
| Header | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| X-WebHook-Timestamp | String | ja | Zeitstempel |
| X-WebHook-AppKey | String | ja | Fester Wert: „email“ |
| X-WebHook-Signature | String | ja | Digitale Signatur |
Request-Body
| Parameter | Typ | Beschreibung |
|---|---|---|
| message_id | string | Nachrichten-ID |
| from | string | Absender (bei Zielnachrichten leer) |
| subject | string | Betreff (bei Zielnachrichten leer) |
| to | string | Empfänger (bei Zielnachrichten leer) |
| server | string | |
| itime | long | Zeitstempel der Nachrichtenerstellung |
| custom_args | json | Nutzerdefinierte Felder |
| status | json | Status-Callback der Nachricht |
Hinweis:
- Signaturalgorithmus (HmacSHA256): Verwenden Sie den App-Key des Nutzers als Verschlüsselungsschlüssel, um mit HmacSHA256 den Zeitstempel zu verschlüsseln und hexadezimale Zeichen zu erhalten.
E-Mail Ziel-Status-Nachricht
Auslöser: E-Mail-Anfrage erfolgreich.
status
| Parameter | Typ | Beschreibung |
|---|---|---|
| message_status | string | target |
| status_data | json object | Statusdaten |
| message | string | Anfrage erfolgreich |
| task_id | int | Task-ID |
| api_user | string | API-User |
| from | string | Absender |
| subject | string | Betreff |
| tos | array | Empfänger-Array |
| email_ids | array | Empfänger-E-Mail-ID-Array |
| label_id | int | Label-ID |
{
"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": "Template interface sending-dynamic_vars-Unicast sending",
"tos": [
"12345@hotmail.com"
],
"message": "Anfrage erfolgreich",
"label_id": 0
}
},
"custom_args": {}
}
E-Mail gesendet-Status-Nachricht
Auslöser: E-Mail wurde von EngageLab erfolgreich versendet.
status
| Parameter | Typ | Beschreibung |
|---|---|---|
| message_status | string | sent |
| status_data | json object | Statusdaten |
| message | string | Erfolgreich gesendet |
| task_id | int | Task-ID |
| api_user | string | API-User |
| email_id | string | E-Mail-ID |
| label_id | int | Label-ID |
{
"server": "email",
"message_id": "1676615711309_104117_18546_8821.sc-10_43_7_16-inbound0$12345@hotmail.com",
"from": "newsletter@mail.engagelab.com",
"subject": "Template interface sending-dynamic_vars-Unicast sending",
"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": "Erfolgreich gesendet",
"label_id": 0
}
},
"custom_args": {}
}
E-Mail zugestellt-Status-Nachricht
Auslöser: E-Mail-Zustellung erfolgreich.
status
| Parameter | Typ | Beschreibung |
|---|---|---|
| message_status | string | delivered |
| status_data | json object | Statusdaten |
| message | string | Erfolgreich zugestellt |
| task_id | int | Task-ID |
| api_user | string | API-User |
| email_id | string | E-Mail-ID |
| label_id | int | Label-ID |
{
"server": "email",
"message_id": "1675758375681_15_6393_8309.sc-10_2_226_96-test0$12345@gmail.com",
"from": "newsletter@mail.engagelab.com",
"subject": "Template interface sending-dynamic_vars-Unicast sending",
"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": "Erfolgreich zugestellt",
"label_id": 0
}
},
"custom_args": {}
}
E-Mail invalid_email-Status-Nachricht
Auslöser: E-Mail konnte nicht zugestellt werden.
status
| Parameter | Typ | Beschreibung |
|---|---|---|
| message_status | string | invalid_email |
| status_data | json object | Statusdaten |
| task_id | int | Task-ID |
| api_user | string | API-User |
| email_id | string | E-Mail-ID |
| label_id | int | Label-ID |
| error_code | int | Fehlercode |
| error_detail | json | Fehlerdetails |
| message | string | Rückgabeprotokoll der Mailbox |
| sub_stat | int | Fehlerunterkategorie (4xx = ungültig) |
| sub_stat_desc | string | Beschreibung der Unterkategorie |
{
"server": "email",
"message_id": "1676537131885_95_4921_8644.sc-10_2_226_96-test0$12345@gmail.com",
"from": "newsletter@mail.engagelab.com",
"subject": "Template interface sending-dynamic_vars-Unicast sending",
"to": "12345@gmail.com",
"itime": 1676537132783,
"status": {
"message_status": "invalid_email",
"error_code": 409,
"error_detail": {
"sub_stat": 409,
"message": "Domain existiert möglicherweise nicht oder DNS-Prüfung fehlgeschlagen [MF99jssew+U8hyLhCJdZwkffXOKzGzvvQq5UZaSZR1BIotz1+sUrL6gFET3lJu6KdQ== IP: 8.219.236.47].",
"sub_stat_desc": "Sonstiges"
},
"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": {}
}
E-Mail soft_bounce-Status-Nachricht
Auslöser: E-Mail-Nachricht wurde vom Empfänger-Mailserver angenommen, später aber zurückgesendet.
status
| Parameter | Typ | Beschreibung |
|---|---|---|
| message_status | string | soft_bounce |
| status_data | json object | Statusdaten |
| task_id | int | Task-ID |
| api_user | string | API-User |
| email_id | string | E-Mail-ID |
| label_id | int | Label-ID |
| error_code | int | Fehlercode |
| error_detail | json | Fehlerdetails |
| message | string | Rückgabeprotokoll der Mailbox |
| sub_stat | int | Fehlerunterkategorie (5xx = Soft Bounce) |
| sub_stat_desc | string | Beschreibung der Unterkategorie |
{
"server": "email",
"message_id": "1676537131885_95_4921_8644.sc-10_2_226_96-test0$12345@gmail.com",
"from": "newsletter@mail.engagelab.com",
"subject": "Template interface sending-dynamic_vars-Unicast sending",
"to": "12345@gmail.com",
"itime": 1676537132783,
"status": {
"message_status": "soft_bounce",
"error_code": 509,
"error_detail": {
"sub_stat": 509,
"message": "Domain existiert möglicherweise nicht oder DNS-Prüfung fehlgeschlagen [MF99jssew+U8hyLhCJdZwkffXOKzGzvvQq5UZaSZR1BIotz1+sUrL6gFET3lJu6KdQ== IP: 8.219.236.47].",
"sub_stat_desc": "Sonstiges"
},
"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": {}
}
E-Mail-Response-Callback
URL
Vom Nutzer auf der jeweiligen Seite festzulegen
Content-Type:
application/json; charset=utf-8
HTTP-Request-Methode
post
Request-Header
| Header | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| X-WebHook-Timestamp | String | ja | Zeitstempel |
| X-WebHook-AppKey | String | ja | Fester Wert: „email“ |
| X-WebHook-Signature | String | ja | Digitale Signatur |
Request-Body
| Parameter | Typ | Beschreibung |
|---|---|---|
| message_id | string | Nachrichten-ID |
| from | string | Absender (bei Routingnachrichten leer) |
| subject | string | Betreff (bei Routingnachrichten leer) |
| to | string | Empfänger |
| server | string | |
| itime | long | Zeitstempel der Nachrichtenerstellung |
| custom_args | json | Nutzerdefinierte Felder |
| response | json | Response-Callback der Nachricht |
Hinweis:
- Signaturalgorithmus (HmacSHA256): Verwenden Sie den App-Key des Nutzers als Verschlüsselungsschlüssel, um mit HmacSHA256 den Zeitstempel zu verschlüsseln und hexadezimale Zeichen zu erhalten.
E-Mail geöffnet-Response-Nachricht
Auslöser: Empfänger öffnet die E-Mail.
response
| Parameter | Typ | Beschreibung |
|---|---|---|
| event | string | open |
| response_data | json object | Response-Daten |
| message | string | E-Mail geöffnet |
| task_id | int | Task-ID |
| api_user | string | API-User |
| email_id | string | E-Mail-ID |
| label_id | int | Label-ID |
| ip | string | IP-Adresse der Aktion |
| explorer_name | string | Browsername |
| explorer_ver | string | Browserversion |
| os_name | string | Betriebssystem |
| os_ver | string | Betriebssystem-Version |
{
"server": "email",
"message_id": "1676618583015_104117_18546_8822.sc-10_43_7_16-inbound0$12345@hotmail.com",
"from": "newsletter@mail.engagelab.com",
"subject": "Template interface sending-dynamic_vars-Unicast sending",
"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": "E-Mail geöffnet",
"label_id": 0
}
},
"custom_args": {}
}
E-Mail Klick-Response-Nachricht
Auslöser: Empfänger klickt auf einen Link in der E-Mail.
response
| Parameter | Typ | Beschreibung |
|---|---|---|
| event | string | click |
| response_data | json object | Response-Daten |
| message | string | E-Mail-Link geklickt |
| task_id | int | Task-ID |
| api_user | string | API-User |
| email_id | string | E-Mail-ID |
| label_id | int | Label-ID |
| url | string | Klick-URL |
| ip | string | IP-Adresse der Aktion |
| explorer_name | string | Browsername |
| explorer_ver | string | Browserversion |
| os_name | string | Betriebssystem |
| os_ver | string | Betriebssystem-Version |
{
"server": "email",
"message_id": "1676618583015_104117_18546_8822.sc-10_43_7_16-inbound0$12345@hotmail.com",
"from": "newsletter@mail.engagelab.com",
"subject": "Template interface sending-dynamic_vars-Unicast sending",
"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": "E-Mail-Link geklickt",
"label_id": 0
}
},
"custom_args": {}
}
E-Mail Abmelde-Response-Nachricht
Auslöser: Empfänger klickt auf Abmelden.
response
| Parameter | Typ | Beschreibung |
|---|---|---|
| event | string | unsubscribe |
| response_data | json object | Response-Daten |
| message | string | E-Mail abbestellt |
| task_id | int | Task-ID |
| api_user | string | API-User |
| email_id | string | E-Mail-ID |
| label_id | int | Label-ID |
| ip | string | IP-Adresse der Aktion |
| explorer_name | string | Browsername |
| explorer_ver | string | Browserversion |
| os_name | string | Betriebssystem |
| os_ver | string | Betriebssystem-Version |
{
"server": "email",
"message_id": "1676460128030_100669_28018_8253.sg-10_1_253_26-inbound86$12345@gmail.com",
"from": "newsletter@mail.engagelab.com",
"subject": "Template interface sending-dynamic_vars-Unicast sending",
"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": "E-Mail abbestellt",
"label_id": 221223
}
},
"custom_args": {}
}
E-Mail Spam melden-Response-Nachricht
Auslöser: Empfänger meldet E-Mail als Spam.
response
| Parameter | Typ | Beschreibung |
|---|---|---|
| event | string | report_spam |
| response_data | json object | Response-Daten |
| api_user | string | API-User |
| email_id | string | E-Mail-ID |
| label_id | int | Label-ID |
{
"server": "email",
"message_id": "1676857822846_15_23558_89.sg-10_1_253_26-inbound0$12345@gmail.com",
"from": "newsletter@mail.engagelab.com",
"subject": "Template interface sending-dynamic_vars-Unicast sending",
"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": {}
}
E-Mail Routing-Response-Nachricht
Auslöser: Empfänger antwortet oder sendet an Routing-Adresse.
response
| Parameter | Typ | Beschreibung |
|---|---|---|
| event | string | route |
| response_data | json object | Response-Daten |
| message | string | MX-Route |
| html | string | E-Mail-HTML |
| text | string | E-Mail-Text (nur Text) |
| headers | string | Routing-E-Mail-Header |
| from_name | string | Absendername |
| subject | string | E-Mail-Betreff |
| from | string | Absenderadresse |
| reference | string | Referenz |
| email_id | string | E-Mail-ID |
| raw_message | string | Rohnachricht |
| raw_message_url | string | Download-URL der Rohnachricht |
| x_mx_mailfrom | string | x_mx_mailfrom |
| x_mx_rcptto | string | x_mx_rcptto |
| label_id | int | Label-ID |
{
"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: Arbeitsplan für den nächsten Monat"
},
"raw_message": "Received: from MAIL-ED1-F51.GOOGLE.COM (unknown [209.85.208.51])by mx2.sendcloud.org with SMTP ......",
"subject": "Re: Arbeitsplan für den nächsten Monat",
"x_mx_rcptto": "12345@icloud.com",
"html": "<div dir=\"ltr\">Hallo Team,<div><br></div><div>Legen wir los ......",
"from": "Archimonde <12345@outlook.com>",
"text": "Hallo Team, legen wir los ......",
"x_mx_mailfrom": "12345@hotmail.com",
"message": "MX-Route",
"from_name": "Sargeras",
"raw_message_url": "https://......eml",
"label_id": 0
}
},
"custom_args": {}
}
SEO-Hinweis:
Für eine optimale Auffindbarkeit empfehlen wir, in der Einleitung oder in Überschriften Begriffe wie „Webhook E-Mail Status“, „E-Mail Callback API“ oder „E-Mail Zustellstatus“ zu integrieren, um die Sichtbarkeit für relevante Suchanfragen zu erhöhen.
