Subscribe to the per-call event stream (Server-Sent Events)

GET

/v1/sessions/{callId}/stream

The widget opens this immediately after minting a voice token, before starting the Retell call. The server pushes tool-call events here when Retell webhooks powsoo_show_card, plus periodic heartbeat events to keep proxies from idling the connection out. Authentication is via the x-powsoo-session-token header returned by /v1/voice-tokens.

Parameters

Path Parameters

callId

required

string

>= 1 characters

Query Parameters

token

string

>= 1 characters

Header Parameters

x-powsoo-session-token

string

>= 1 characters

Responses

200

Open event stream

One of:

object

object

type

required

string

Allowed values: ready

callId

required

string

>= 1 characters

object

object

type

required

string

Allowed values: tool-call

toolCallId

required

string

>= 1 characters

card

required

object

title

required

string

>= 1 characters <= 200 characters

description

string

<= 500 characters

fields

Array<object>

default: <= 8 items

object

label

required

string

>= 1 characters <= 100 characters

value

string

type

string

default: text

Allowed values: text email phone address date select multiselect consent

editable

boolean

default: true

options

Array<object>

object

id

required

string

>= 1 characters

label

required

string

>= 1 characters

actions

required

Array<object>

>= 1 items <= 4 items

object

label

required

string

>= 1 characters <= 40 characters

value

required

string

>= 1 characters

style

string

default: primary

Allowed values: primary secondary danger

object

object

type

required

string

Allowed values: tool-cancelled

toolCallId

required

string

>= 1 characters

reason

string

object

object

type

required

string

Allowed values: heartbeat

at

required

string format: date-time

401

Missing or invalid session token

object

ok

required

boolean

error

required

object

code

required

string

>= 1 characters

message

required

string

>= 1 characters

requestId

string

>= 1 characters

404

Unknown callId

object

ok

required

boolean

error

required

object

code

required

string

>= 1 characters

message

required

string

>= 1 characters

requestId

string

>= 1 characters