Email (Async)
Using the Email Status webhook, you can easily integrate VCC Live with another system or CRM to synchronize Email data. The webhook is triggered when an Email is sent or received.
Note: Email webhook is currently only triggered by an inbound or an outbound email sent by an agent. This webhook is not triggered by bulk or disposition-triggered emails.
Table of Contents
Request Object
| Name | Type | Comment |
|---|---|---|
| emailId | integer | Unique identifier of the email within the project. |
| projectId | integer | Unique identifier of the project. |
| entityId | integer | Unique identifier of the customer record within the project. |
| contactId | integer | Unique identifier of the customer record within the project. |
| ticketId | integer | Unique identifier of the ticket within the project. |
| replyEmailId | integer | Unique identifier of the email that this email was a reply to. |
| userId | integer | The ID of the user who sent the email. |
| direction | string | The direction of the email, possible values: out, in |
| from | string | The sender of the email. |
| fromName | string | The Name of the sender. |
| fromAddress | string | The email address of the sender. |
| to | string | The recipient(s) of the email. |
| cc | string | The recipient(s) of the email in cc. |
| bcc | string | The recipient(s) of the email in bcc. |
| lastModifiedTime | string | The last time the email was modified. |
| status | string | The status of the email. |
| forwardEmailId | integer | The ID of the original email that is being forwarded |
| subject | string | The subject of the email. |
| replyTo | string | The address that this email is a reply to. |
| messageId | integer | The unique ID of the message |
| inReplyTo | string | The address that this email is a reply to. |
| sentTime | string | The time of sending. |
| receivedTime | string | The time when the email was received |
| body | string | The body of the email |
Sample Request Body
Outbound email
{
"emailId": 115,
"projectId": 822,
"entityId": 94,
"contactId": 94,
"ticketId": 68,
"replyEmailId": 3,
"userId": 609,
"direction": "out",
"fromName": null,
"fromAddress": null,
"lastModifiedTime": "2024-03-25 14:07:07",
"status": "sending",
"forwardEmailId": null,
"from": "VCC Live Support <[email protected]>",
"to": "John Smith <john.smith@company>",
"cc": null,
"bcc": null,
"subject": "Issue 1234",
"replyTo": null,
"messageId": null,
"inReplyTo": null,
"sentTime": null,
"receivedTime": "2024-03-25 14:07:07",
"body": "This is a test email."
}
Inbound email
{
"emailId": 116,
"projectId": 822,
"entityId": null,
"contactId": null,
"ticketId": null,
"replyEmailId": null,
"userId": null,
"direction": "in",
"fromName": null,
"fromAddress": null,
"lastModifiedTime": null,
"status": "unread",
"forwardEmailId": null,
"from": "Ferenc Hajmási <john.smith@company>",
"to": "[email protected]",
"cc": null,
"bcc": null,
"subject": "Test",
"replyTo": null,
"messageId": null,
"inReplyTo": null,
"sentTime": "2024-03-25 14:33:50",
"receivedTime": "2024-03-25 14:34:03",
"body": "This is a test"
}
Comments
Can’t find what you need? Use the comment section below to connect with others, get answers from our experts, or share your ideas with us.
There are no comments yet.