Metadata fields define additional key-value data that is sent along with every output from AI Cloud. Each field has a name and a type, and is returned to the client as part of the response payload.
How it works with HALO
When a HALO tool sets values during a call, AI Cloud maps them back into the output's metadata, which is returned to the client. This allows HALO agents and tools to surface structured data alongside conversational output — for example, signalling a live chat handover or a page push action.
Managing Metadata Fields
Metadata fields are managed in Configuration → Metadata. Each field has:
-
Name — the key used in the response payload
-
Type — the value type: Text or Yes/No
Use the Type filter to view fields by type, and the + button to add new fields.
Common Use Cases
Metadata is typically used to pass structured signals to the client that trigger downstream actions. Examples include contactEscalation (flagging a handover to a human agent), livechat (opening a live chat session), or pagepush (redirecting the user to a specific page). The client application is responsible for reading these values and acting on them.