Developer Guides Webhook Async Webhook RequestsChat (Async)

Chat (Async)

Using the Chat webhook, you can easily integrate VCC Live with another system to synchronize Chat data, including the entire Chat transcript. The webhook is triggered when an agent closes a chat.

Request Object
Conversation object
Client Data object
Sample Request Body

Request Object

Name	Type	Comment
chatId	integer	Unique identifier of the chat conversation within the project.
projectId	integer	The ID of the project where the chat conversation is.
ticketId	integer	Unique identifier of the ticket within the project.
ticketNo	string	Unique ticket identifier related to the chat.
firstAgentName	string	The name of the first agent who handled the chat.
lastAgentName	string	The name of the last agent who handled the chat.
visitorName	string	The name of the visitor.
firstQueueName	string	The name of the first queue where the chat conversation was handled.
lastQueueName	string	The name of the last queue where the chat conversation was handled.
contactId	integer	Unique identifier of the customer record within the project.
entityId	integer	Unique identifier of the customer record within the project.
disposition	string	The outcome of the chat session. Possible values: – completed – lost – missed
platform	string	The platform from which the chat conversation was initiated
ipAddress	string	The IP address of the visitor who initiated the chat on the webchat channel
isSpam	integer	Indicates whether the chat conversation was marked as spam.
slaStatus	string	Indicates the status of the chat conversation compared to the SLA
closeTime	string	The timestamp when the chat conversation was closed.
firstResponseTime	integer	The response time of the agent to the first visitor message (in seconds).
averageResponseTime	integer	The average response time of the agent(s) during the chat session (in seconds).
transferCount	integer	The number of times the chat conversation was transferred between agents or queues.
firstURL	string	The URL of the first page the visitor visited when initiating the chat.
lastURL	string	The URL of the last page the visitor visited during the chat session.
firstVisitorMessageTime	string	The timestamp of the first message sent by the visitor.
firstAgentMessageTime	string	The timestamp of the first message sent by an agent.
sessionId	string	Unique identifier of the chat session.
pageName	string	The name of the page where the chat was initiated or active.
sessionStartTime	string	The timestamp when the chat session started.
duration	integer	The total duration of the chat session (in seconds).
lastVisitorMessageTime	string	The timestamp of the last message sent by the visitor.
lastAgentMessageTime	string	The timestamp of the last message sent by an agent.
visitorTranscript	string	The transcript or content of the visitor’s messages.
agentTranscript	string	The transcript or content of the agent’s messages.
ticketTypeId	integer / null	Unique identifier of the ticket type associated with the chat.
ticketType	string / null	The name or category of the ticket type associated with the chat.
conversation	object	Includes the entire chat transcript
clientData	object	Data about the ticket itself.

Conversation object

Name	Type	Comment
from	string	Indicates the sender of the message.
date	string	The date and time of sending the particular message
message	string	The chat message

Client Data object

Name	Type	Comment
phone1	string	First phone number provided for the record
name	string	Name of the record
contacts	object	Contacts object, including contact data.

This object can include additional data added by users via the VCC Live interface or API. Additional data elements are either in string or array format. In case the additional data element is an array, it includes the following attributes:

Sample Request Body

{
  "chatId": 591,
  "projectId": 822,
  "firstAgentName": "John Smith",
  "lastAgentName": "John Smith",
  "visitorName": "",
  "firstQueueName": "Chat",
  "lastQueueName": "Chat",
  "ticketId": 0,
  "ticketNo": null,
  "contactId": 0,
  "entityId": null,
  "disposition": "completed",
  "platform": "webchat",
  "conversation": [
    {
      "from": "System",
      "date": "2026-07-08T13:49:42+02:00",
      "message": "Hello! How can we help?"
    },
    {
      "from": "Visitor",
      "date": "2026-07-08T13:50:45+02:00",
      "message": "Hi"
    },
    {
      "from": "John Smith",
      "date": "2026-07-08T13:51:00+02:00",
      "message": "Thanks"
    },
    {
      "from": "John Smith",
      "date": "2026-07-08T13:51:03+02:00",
      "message": "The agent has left the chat!"
    }
  ],
  "ipAddress": "188.36.25.221",
  "isSpam": 0,
  "slaStatus": "answeredBeforeSLA",
  "clientData": null,
  "closeTime": "2026-07-08 13:51:03",
  "firstResponseTime": 15,
  "averageResponseTime": 15,
  "transferCount": 0,
  "firstURL": "",
  "lastURL": "",
  "firstVisitorMessageTime": "2026-07-08 13:50:45",
  "firstAgentMessageTime": "2026-07-08 13:51:00",
  "sessionId": "webchat/customer/404e470a-30c4-4e72-a74e-3e07f0b22122",
  "pageName": "",
  "sessionStartTime": "2026-07-08 13:49:42",
  "duration": 18,
  "lastVisitorMessageTime": "2026-07-08 13:50:45",
  "lastAgentMessageTime": "2026-07-08 13:51:03",
  "visitorTranscript": "Hi",
  "agentTranscript": "Thanks, The agent has left the chat!",
  "ticketTypeId": null,
  "ticketType": null
}

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.

Click here to cancel reply.