Email

Navigate to Integrations -> Outbound Webhooks

Email Delivery Receipts

  • Select the service you are sending the emails from
  • Select the channel as Email
{
    "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": "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"
  }
}
{ 
"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"
}
}

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

Email Incoming Messages & Events

  • Select the app that you expect to receive messages or events from as the Entity
{
                "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"
}