You can configure Outbound Webhooks to receive a copy of delivery status notifications for Email channel and for a copy of incoming messages/events by navigating to 'Assets -> Integrations -> Outbound Webhooks' sections in the platform. Please note that the email delivery notifications are available only for AWS SES based Email Assets.
Outbound Webhook configuration for tracking email delivery status
If you want to track email message delivery status, select the Webex Connect Service you are sending the Email from under 'Entity' dropdown.
{
"deliveryInfoNotification": {
"deliveryInfo": {
"deliveryChannel": "email",
"Description": "Submitted",
"destinationType": "emailid",
"timeStamp": "2016-07-21T12:44:23.644",
"code": "7501",
"deliveryStatus": "Submitted",
"destination": "[email protected]"
},
"correlationid": "3bd8edf31c81-4b72d8a2-290d-49e2-993e",
"callbackData": "return callbackdata",
"transid": "4b72d8a2-290d-49e2-993e-3bd8edf31c81"
}
}
{
"deliveryInfoNotification": {
"deliveryInfo": {
"deliveryChannel": "email",
"Description": "Delivered",
"destinationType": "emailid",
"timeStamp": "2016-07-21T12:44:23.644",
"code": "7500",
"deliveryStatus": "Delivered",
"destination": "[email protected]"
},
"correlationid": "3bd8edf31c81-4b72d8a2-290d-49e2-993e",
"callbackData": "return callbackdata",
"transid": "4b72d8a2-290d-49e2-993e-3bd8edf31c81"
}
}
{
"deliveryInfoNotification": {
"deliveryInfo": {
"timeStamp": "2022-04-14T22:13:17.290-04:00",
"Description": "Read",
"code": "7502",
"deliveryChannel": "email",
"additionalInfo": "",
"destination": "[email protected]",
"destinationType": "email",
"deliveryStatus": "Read"
},
"subtid": "e1187b83-9566-48e2-85c4-29474c7c39c0",
"transid": "c71c2927-6bb3-2021-9c8e-226b48d66ba0_0",
"callbackData": "",
"correlationid": ""
}
}
{
"deliveryInfoNotification": {
"deliveryInfo": {
"deliveryChannel": "email",
"Description": "https://your.link.tld/files/sample.pdf|192.0.2.1",
"destinationType": "email",
"timeStamp": "2016-07-21T12:44:23.644Z",
"additionalInfo":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/60.0.3112.90 Safari/537.36",
"code": "7528",
"deliveryStatus": "Clicked",
"destination": "[email protected]"
},
"correlationid": "3bd8edf31c81-4b72d8a2-290d-49e2-993e",
"callbackData": "return callbackdata",
"transid": "4b72d8a2-290d-49e2-993e-3bd8edf31c81"
}
}
{
"deliveryInfoNotification": {
"deliveryInfo": {
"deliveryChannel": "email",
"Description": "Account in sandbox mode. Destination email address is not verified",
"destinationType": "emailid",
"timeStamp": "2016-07-21T12:44:23.644",
"code": "7522",
"deliveryStatus": "Not Verified",
"destination": "[email protected]"
},
"correlationid": "3bd8edf31c81-4b72d8a2-290d-49e2-993e",
"callbackData": "return callbackdata",
"transid": "4b72d8a2-290d-49e2-993e-3bd8edf31c81"
}
}
{
"deliveryInfoNotification": {
"deliveryInfo": {
"timeStamp": "2021-03-04T17:00:07.538Z",
"Description": "Invalid email address",
"code": "7523",
"deliveryChannel": "email",
"additionalInfo": "",
"destination": "gvmpavankumar",
"destinationType": "email",
"deliveryStatus": "Failed"
},
"subtid": "",
"transid": "1a893a24-6517-486b-82ef-e7801be60f88",
"callbackData": "call back data",
"correlationid": "124521i1"
}
}
{
"deliveryInfoNotification": {
"deliveryInfo": {
"deliveryChannel": "email",
"Description": "Permanent_General/Permanent_NoEmail/Permanent_Suppressed/Transient_General/Transient_MailboxFull/Transient_MessageTooLarge/Transient_ContentRejected/Transient_AttachmentRejected",
"destinationType": "emailid",
"timeStamp": "2016-07-21T12:44:23.644",
"code": "7520",
"deliveryStatus": "Bounce",
"destination": "[email protected]"
},
"correlationid": "3bd8edf31c81-4b72d8a2-290d-49e2-993e",
"callbackData": "return callbackdata",
"transid": "4b72d8a2-290d-49e2-993e-3bd8edf31c81"
}
}
{
"deliveryInfoNotification": {
"deliveryInfo": {
"deliveryChannel": "email",
"Description": "abuse/auth-failure/fraud/not-spam/other/virus",
"destinationType": "emailid",
"timeStamp": "2016-07-21T12:44:23.644",
"code": "7521",
"deliveryStatus": "Complaint",
"destination": "[email protected]"
},
"correlationid": "3bd8edf31c81-4b72d8a2-290d-49e2-993e",
"callbackData": "return callbackdata",
"transid": "4b72d8a2-290d-49e2-993e-3bd8edf31c81"
}
}
{
"deliveryInfoNotification": {
"deliveryInfo": {
"timeStamp": "2021-06-04T12:52:04.009Z",
"Description": "Email address max length reached",
"code": "7524",
"deliveryChannel": "email",
"additionalInfo": "",
"destination": "te[email protected]gmail.com",
"destinationType": "email",
"deliveryStatus": "Failed"
},
"subtid": "",
"transid": "3df50805-464c-4d6c-99fd-c4197789538d",
"callbackData": "",
"correlationid": "124521i1"
}
}
{
"deliveryInfoNotification": {
"deliveryInfo": {
"timeStamp": "2021-06-04T13:23:59.091Z",
"Description": "already bounced : [email protected]",
"code": "7240",
"deliveryChannel": "email",
"additionalInfo": "",
"destination": "[email protected]",
"destinationType": "email",
"deliveryStatus": "Failed"
},
"subtid": "",
"transid": "44970e48-6eae-493f-9262-4258f116771d",
"callbackData": "",
"correlationid": "124521i1"
}
}
Multiple Recipients Scenario
- For email transactions with multiple recipients, the Status field in Debug Console and Export Logs, and Error Codes details, will only be updated for entries with the ‘Submitted’ Status. Email delivery status for each of the individual recipients will need to be tracked using Outbound Webhooks. Separate outbound notifications will be sent for email delivery or failure to each of the recipients mentioned in To, CC, and BCC sections with the same transaction ID. For outbound email transactions, destination will contain an email ID for scenarios where only one email ID has been mentioned (that can in be in either of to, bcc, or cc fields but overall one email ID is mentioned in one outbound request).
- The platform will not trigger or resume a flow, nor trigger a rule or an outbound webhook notification for incoming emails where Sender Email ID is same as the Recipient Email ID. However, details of such incoming emails will be available within Export Logs.
- For email sent via SMTP channel, we do not support delivery tracking.
- AWS SES doesn’t provide the recipient details for events such as opening and/or clicking the link of an email by a specific recipient. The counts for Open and Click events can be higher than the Submit count. For multiple recipient scenarios, given the lack of information of unique recipient info from AWS SES, the redundancy is not uniquely identified, and all Open events are accounted for in reports.
| Field Name | Description |
|---|---|
| deliveryChannel | This is “Email” in case of a email |
| Description | Detailed description of the delivery status |
| destinationType | This contains the email id |
| timeStamp | Timestamp of the event |
| code | Status code as mentioned in the documentation |
| deliveryStatus | Status of the Email |
| destination | This contains the destination email id |
| correlationid | The CorrelationID is a unique identifier that you can attach to every request as a reference a particular transaction or event. This is configured as a part of the request |
| callbackData | Data that you have configured to receive on the notify Url. This is configured as a part of the request |
| transid | Unique transaction reference id of the request |
Outbound Webhook configuration for tracking incoming emails
If you want to track incoming emails, select the Email app asset you are sending and receiving the emails from under 'Entity' dropdown.
{
"to": ["[email protected]"],
"ts": "2017-09-27T18:56:42.099Z",
"textMessage": "\r\n\r\nCheers,\r\nK Siva Krishna\r\nExtn: 604\r\n\r\nFrom: Siva Krishna Kesanapalli\r\n\r\n",
"subject": "FW: 2 attachment",
"event": "MO",
"from": "[[email protected]]",
"attachments": [{
"content": "****REMOVED FOR READABILITY****",
"name": "build-impl.xml",
"contentType": "application/xml",
"contentTransferEncoding": "base64"
}, {
"content": "****REMOVED FOR READABILITY****",
"name": "project.xml",
"contentType": "application/xml",
"contentTransferEncoding": "base64"
}, {
"content": "****REMOVED FOR READABILITY****",
"name": "groovy-build.xml",
"contentType": "application/xml",
"contentTransferEncoding": "base64"
}
],
"tid": "1866c6b7-4f53-4ad3-bf40-e4a30ac6c114",
"messageId": "2dbk2k9580a7nhra16t4t553v8dnjusad6kjk101",
"returnPath": "[email protected]",
"htmlMessage": "<html xmlns:v=\"urn:schemas-microsoft-com:vml\" xmlns:o=\"urn:schemas-microsoft-com:office:office\" \r\n ****REMOVED FOR READABILITY****",
"channel": "email"
}
{
"deliveryInfoNotification": {
"deliveryInfo": {
"timeStamp": "2018-07-26T09:52:46.339Z",
"Description": "unsubscribed : [email protected]",
"code": "7241",
"deliveryChannel": "email",
"additionalInfo": "",
"destination": "[email protected]",
"destinationType": "email",
"deliveryStatus": "Failed"
},
"subtid": "f06b174e-8830-475f-898f-dd9e893cc147",
"transid": "9736689f-0e7c-4b48-a517-79ea21170354",
"callbackData": "",
"correlationid": "12345"
}
}
| Field Name | Description |
|---|---|
| channel | Channel is email always for incoming emails |
| from | Sender Id used for sending the email from Webex Connect |
| to | Recipient's Email Id |
| ts | Timestamp - when incoming email was received by Webex Connect |
| event | Describes the incoming event type. For inbound email message it will be 'MO'. |
| textMessage | Email text message context |
| subject | Email subject |
| attachments | Email attachment details |
| tid | Transaction ID |
| messageId | Message ID |
| returnPath | Email Id mentioned in the replyTo field |
| htmlMessage | Email HTML Content |