# Webhook Event Description
# Request ( request )
参数说明
| parameter | type | description |
|---|---|---|
| event | string | event type: “request” |
| message | string | message content |
| maillistTaskId | long | task ID will be generated when you send emails with address list |
| mail_list_task_id | long | task ID will be generated when you send emails with address list |
| messageId | string | messageId |
| apiUser | string | API_USER |
| category | string | message ID |
| recipientArray | list | recipients |
| emailIds | list | emailId array |
| labelId | int | custom label ID |
| labelName | string | custom label name |
| recipientSize | int | count of requests |
| timestamp | long | timestamp |
| token | string | random string of 50 characters |
| signature | string | signature string |
| userHeaders | string | custom header with start of “SC-Custom” |
# Delivery ( deliver )
Parameter description
| parameter | type | description |
|---|---|---|
| event | string | event type: “deliver” |
| message | string | message content |
| apiUser | string | API_USER |
| category | string | API_USER |
| maillistTaskId | long | task ID will be generated when you send emails with address list |
| mail_list_task_id | long | task ID will be generated when you send emails with address list |
| emailId | string | unique ID of each email |
| outIp | string | outbound IP address |
| recipient | string | recipients |
| labelId | int | custom label ID |
| labelName | string | custom label name |
| timestamp | long | timestamp |
| token | string | random string of 50 characters |
| signature | string | signature string |
| userHeaders | string | custom header with start of “SC-Custom” |
# Open ( open )
Parameter description
| parameter | type | description |
|---|---|---|
| event | string | event type: ”open” |
| message | string | message content |
| apiUser | string | API_USER |
| category | string | API_USER |
| maillistTaskId | long | task ID will be generated when you send emails with address list |
| mail_list_task_id | long | task ID will be generated when you send emails with address list |
| emailId | string | unique ID of each email |
| recipient | string | recipients |
| labelId | int | custom label ID |
| labelName | string | custom label name |
| ip | string | opened IP address |
| explorerName | string | browser name |
| explorerVer | string | browser version |
| oSName | string | OS name |
| oSVer | string | OS version |
| timestamp | long | timestamp |
| token | string | random string of 50 characters |
| signature | string | signature string |
| userHeaders | string | custom header with start of “SC-Custom” |
# Click ( click )
Parameter description
| parameter | type | description |
|---|---|---|
| event | string | event type: “type” |
| message | string | message content |
| apiUser | string | API_USER |
| category | string | API_USER |
| maillistTaskId | long | task ID will be generated when you send emails with address list |
| mail_list_task_id | long | task ID will be generated when you send emails with address list |
| emailId | string | unique ID of each email |
| recipient | string | recipients |
| labelId | int | custom label ID |
| labelName | string | custom label name |
| url | string | clicked links |
| ip | string | clicked IP addresses |
| explorerName | string | browser name |
| explorerVer | string | browser version |
| oSName | string | OS name |
| oSVer | string | OS version |
| timestamp | long | timestamp |
| token | string | random string of 50 characters |
| signature | string | signature string |
| userHeaders | string | custom header with start of “SC-Custom” |
# Unsubscribe ( unsubscribe )
Parameter description
| parameter | type | description |
|---|---|---|
| event | string | event type: ”unsubscribe” |
| message | string | message content |
| apiUser | string | API_USER |
| category | string | API_USER |
| labelId | int | custom label ID |
| labelName | string | custom label name |
| maillistTaskId | long | task ID will be generated when you send emails with address list |
| mail_list_task_id | long | task ID will be generated when you send emails with address list |
| emailId | string | unique ID of each email |
| recipient | string | recipients |
| ip | string | IP address |
| explorerName | string | explorer name |
| explorerVer | string | explorer version |
| oSName | string | OS name |
| oSVer | string | OS version |
| timestamp | long | timestamp |
| token | string | random string of 50 characters |
| signature | string | signature string |
| userHeaders | string | custom header with start of “SC-Custom” |
# Spam Reporting ( report_spam )
Parameter description
| parameter | type | description |
|---|---|---|
| event | string | event type: ” report_spam” |
| message | string | message content |
| apiUser | string | API_USER |
| category | string | API_USER |
| labelId | int | custom label ID |
| labelName | string | custom label name |
| emailId | string | unique ID of each email |
| recipient | string | recipients |
| timestamp | long | timestamp |
| token | string | random string of 50 characters |
| signature | string | signature string |
| userHeaders | string | custom header with start of “SC-Custom” |
# Invalid Email ( invalid )
Parameter description
| parameter | type | description |
|---|---|---|
| event | string | event type: ”invalid” |
| message | string | message content |
| apiUser | string | API_USER |
| category | string | API_USER |
| labelId | int | custom label ID |
| labelName | string | custom label name |
| maillistTaskId | long | task ID will be generated when you send emails with address list |
| mail_list_task_id | long | task ID will be generated when you send emails with address list |
| emailId | string | unique ID of each email |
| outIp | string | outbound IP address |
| recipient | string | recipients |
| timestamp | long | timestamp |
| token | string | random string of 50 characters |
| signature | string | signature string |
| userHeaders | string | custom header with start of “SC-Custom” |
| substatdesc | string | invalid subclass description |
| substat | integer | invalid subclass |
Substat's return code and description：
|subStat|subStatDesc| |401 | in SendCloud blacklist| |402 | unsubscribe| |403 | server unreachable| |404 | address format error| |405 IP and domain rejected| |406 | address does not exist| |407 | spam| |408 | sender / recipient rejected| |409 | others|
# Soft Bounce ( soft_bounce )
Parameter description
| parameter | type | description |
|---|---|---|
| event | string | event type: ” soft_bounce” |
| apiUser | string | API_USER |
| category | string | API_USER |
| labelId | int | custom label ID |
| labelName | string | custom label name |
| maillistTaskId | long | task ID will be generated when you send emails with address list |
| mail_list_task_id | long | task ID will be generated when you send emails with address list |
| emailId | string | unique ID of each email |
| outIp | string | outbound IP address |
| recipient | string | recipients |
| timestamp | long | timestamp |
| token | string | random string of 50 characters |
| signature | string | signature string |
| userHeaders | string | custom header with start of “SC-Custom” |
| substatdesc | string | soft drop back subclass description |
| substat | integer | soft drop back subclass |
| cause | string | reasons for soft credit withdrawal |
Substat's return code and description：
| subStat | subStatDesc |
|---|---|
| 503 | service not available |
| 505 | ip or domain rejected |
| 506 | email address does not exist |
| 507 | spam |
| 508 | sender / recipient rejected |
| 509 | others |
# Mail Routing (route)
Parameter description
| parameter | type | description |
|---|---|---|
| event | string | event type: ” route” |
| message | string | message content “mx route” |
| timestamp | long | timestamp |
| from | string | sender email address |
| fromname | string | sender name |
| to | string | recipients address |
| toname | string | recipient name |
| x_mx_mailfrom | string | envelope sender |
| x_mx_rcptto | string | Actual recipient address |
| headers | string | email headers, formatted with JSON |
| html | string | content in html format of routing email |
| text | string | content in text format of routing email |
| subject | string | subject |
| raw_message_url | string | The download link of the route email, the suffix of the download file is '.eml', and the link is valid for 15 days |
| raw_message | string | raw email |
| token | string | random string of 50 characters |
| signature | string | signature string |
| userHeaders | string | Custom header with start of “SC-Custom” |
| reference | string | If there is a value, it is: Message-ID of the email sent by SendCloud |
| emailId | string | The unique id of the parent email. This field allows the reply email to be associated with the parent email. This value is parsed from reference and In-Reply-To. |
| labelId | int | Parent email customized label ID |
| labelName | string | Parent email customized label Name |
Note:
- When you do not pass in a custom Message-ID, the Message-ID in reference is automatically generated according to the platform rules, and the prefix of the Message-ID is the same as the prefix of the emailid. When you pass in a custom Message-ID through an SMTP request, the Message-ID in reference will be the Message-ID you passed in. When the reply email does not match the parent email, it will be empty.
- eg："reference"："1644468027883_1024_25239_6195.sg-10_1_253_1-inbound0@ifaxin.com (opens new window)" #ifaxin.com is the send domain name.
- Java parsing EML file example,click here download