Speech-to-speech (EVI)Chat Webhooks

Chat Started

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
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`).
Allowed values:
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](/docs/empathic-voice-interface-evi/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](/docs/empathic-voice-interface-evi/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.