Skip to main content
POST
/
events
/
chat
Log customer chat event
curl --request POST \
  --url http://sandbox.mintlify.com/events/chat \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sessionId": "<string>",
  "userId": "<string>",
  "messageType": "text",
  "timestamp": "2023-11-07T05:31:56Z",
  "content": "<string>"
}
'
{
  "eventId": "<string>",
  "status": "success",
  "timestamp": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Chat event details

​
sessionId
string
required

Unique identifier for the chat session

​
userId
string
required

ID of the user in the chat

​
messageType
enum<string>
required

Type of chat message

Available options:
text,
file,
system
​
timestamp
string<date-time>
required

When the message was sent

​
content
string

Content of the message

Response

201 - application/json

Chat event logged

​
eventId
string
required

Unique identifier for the logged event

​
status
enum<string>
required

Status of the event logging

Available options:
success,
failed
​
timestamp
string<date-time>

Time when the event was logged