Sent when an EVI chat is started.

Payload

The payload of this webhook request is an object.
chat_group_idstringRequired

Unique ID of the Chat Group associated with the Chat session.

chat_idstringRequired

Unique ID of the Chat session.

chat_start_typeenumRequired
Allowed values: new_chat_groupresumed_chat_group

Indicates whether the chat is the first in a new Chat Group (new_chat_group) or the continuation of an existing chat group (resumed_chat_group).

start_timeintegerRequired

Unix timestamp (in milliseconds) indicating when the session started.

caller_numberstringOptional

Phone number of the caller in E.164 format (e.g., +12223333333). This field is included only if the Chat was created via the Twilio phone calling integration.

config_idstringOptional

Unique ID of the EVI Config used for the session.

custom_session_idstringOptional

User-defined session ID. Relevant only when employing a custom language model in the EVI Config.

event_name"chat_started"OptionalDefaults to chat_started

Always chat_started.

Response

200
any
Return a 200 status to indicate that the data was received successfully.
Payload
1{
2 "chat_group_id": "9fc18597-3567-42d5-94d6-935bde84bf2f",
3 "chat_id": "470a49f6-1dec-4afe-8b61-035d3b2d63b0",
4 "chat_start_type": "new_chat_group",
5 "start_time": 1716244940648,
6 "config_id": "1b60e1a0-cc59-424a-8d2c-189d354db3f3",
7 "event_name": "chat_started"
8}
Built with