WebSocketConfig

WebSocket configuration for partner transcript streaming. Connects the Advanced Order Confirmation Screen to a partner's WebSocket for real-time transcripts.

authMethod
string
Default: "BEARER_TOKEN"

How the Order Confirmation Screen authenticates to the WebSocket endpoint. Defaults to BEARER_TOKEN.

Enum: "BEARER_TOKEN" "QUERY_PARAM" "CUSTOM_HEADER" "NO_AUTH"
secret
string

The integration partner-provided secret for the WebSocket URL.

url
required
string

WebSocket URL. Must use the secure wss:// protocol.

{
  • "url": "wss://partner-ai.example.com/transcript/session-abc-123",
  • "secret": "temp-secret-for-session-abc-123",
  • "authMethod": "BEARER_TOKEN"
}