v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014102371.0 MB

Webchat

Create a new webchat message.

Creates (sends) a new message on a webchat session. Used for agent/API-authored outbound replies.

post/webchat_messages

Request body

session_idstring uuid required

The session to send the message on. Returned from the POST /sessions or GET /sessions response.

direction'inbound' | 'outbound' required

The direction of the message.

textstring required

The text content of the message.

Example request

{
  "session_id": "7a1bcb1a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  "direction": "inbound",
  "text": "Thanks for reaching out! How can we help?"
}

Response

Details of the created message.

idstring uuid required

The unique identifier of the message. Returned from the POST /messages or GET /messages response.

customer_idstring uuid required

The unique identifier of the associated customer. Returned from the GET /customers response.

widget_idstring uuid required

The widget this message belongs to (denormalized from the session). Returned from the POST /widgets or GET /widgets response.

session_idstring uuid required

The session this message belongs to. Returned from the POST /sessions or GET /sessions response.

direction'inbound' | 'outbound' required

The direction of the message.

status'sent' | 'delivered' | 'failed' required

The status of the message.

sender_idstring uuid

The agent ID for an agent-typed outbound reply; empty for flow/AI-originated or inbound messages.

textstring required

The text content of the message.

tm_createstring date-time

Timestamp when the message was created.

tm_deletestring date-time

Timestamp when the message was deleted.

Example response

{
  "id": "5e9c2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  "widget_id": "550e8400-e29b-41d4-a716-446655440000",
  "session_id": "7a1bcb1a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  "direction": "inbound",
  "status": "sent",
  "sender_id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
  "text": "Hi, I have a question about pricing",
  "tm_create": "2026-01-15T09:30:00.000000Z",
  "tm_delete": "2026-01-15T09:30:00.000000Z"
}