Chat Started | Hume API

Payload

The payload of this webhook request is an object.

• chat_group_id: Unique ID of the Chat Group associated with the Chat session.
• chat_id: Unique ID of the Chat session.
• config_id: Unique ID of the EVI Config used for the session.
• caller_number: Phone number of the caller in E.164 format (e.g., +12223333333). This field is included only if the Chat was created via Twilio phone calling integration.
• chat_start_type: 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: new_chat_group, resumed_chat_group
• custom_session_id: User-defined session ID. Relevant only when employing a custom language model in the EVI Config.
• start_time: Unix timestamp (in milliseconds) indicating when the session started.
• twilio_metadata: Twilio metadata associated with the chat. This field is included only if the Chat was created via Twilio phone calling integration. Fields may include call_sid, account_sid, from_number, to_number, caller_name, caller_number, from_city, from_state, from_zip, from_country, to_city, to_state, to_zip, and to_country. If a specific metadata is not available, this field will be set to an empty string.
• event_name: Always chat_started.