Skip to main content
POST
/
api
/
webhook
/
webchat
Handle inbound webchat message
curl --request POST \
  --url https://your-instance.example.com/api/webhook/webchat \
  --header 'Content-Type: application/json' \
  --data '
{
  "webchatId": "<string>",
  "webchatConfigId": "<string>",
  "message": "<string>",
  "deviceId": "<string>",
  "visitorName": "<string>",
  "visitorEmail": "<string>",
  "visitorPhone": "<string>",
  "metadata": {}
}
'
{}

Body

application/json
webchatId
string
required
webchatConfigId
string
required
message
string
required
deviceId
string
visitorName
string
visitorEmail
string
visitorPhone
string
metadata
object

Response

Message accepted

Generic response envelope. Endpoint-specific fields are intentionally open.