Skip to main content
The webchat.message.received webhook event is triggered whenever a visitor sends a message in a webchat session. This can be used to track incoming communication and trigger real-time integrations.

​
Payload

{
  "event": "webchat.message.received",
  "data": {
    "sessionId": "550e8400-e29b-41d4-a716-446655440000",
    "orgId": "org-abc123",
    "profile": "Default Profile",
    "origin": "https://example.com/pricing",
    "messageId": "msg_7b1d2e9c",
    "content": "Hi, do you offer annual plans?",
    "createdAt": "2024-01-15T14:30:00Z"
  },
  "timestamp": "2024-01-15T14:30:00Z"
}

​
Properties

PropertyTypeDescription
eventstringThe webhook event type (webchat.message.received).
data.sessionIdstringThe unique identifier for the webchat session.
data.orgIdstringThe Apten organization ID that owns the session.
data.profilestringThe name of the webchat profile that handled the session.
data.originstringThe URL of the page where the webchat widget was opened. Only included if set.
data.messageIdstringThe unique identifier for the message.
data.contentstringThe content of the message sent by the visitor.
data.createdAtstringThe ISO 8601 timestamp when the message was received.
timestampstringThe ISO 8601 timestamp when the webhook was sent.