Skip to main content
GET
cURL

Authorizations

X-API-Key
string
header
required

Path Parameters

widget_public_id
string
required

The widget's public id, taken from its embed code (Get widget embed code).

Response

Successful Response

Everything a browser needs to render the widget. Never includes workspace identifier, agent_id, connected service_agent_id, or anything else internal.

Consent text returned by the Sendora API.

greeting_text
string
required

Greeting text returned by the Sendora API.

name
string
required

Name returned by the Sendora API.

position
string
required

Position returned by the Sendora API.

pre_call_form
Pre Call Form · object[]
required

Pre call form returned by the Sendora API.

public_id
string
required

The widget's public id, used in its embed code.

Require consent returned by the Sendora API.

show_transcript
boolean
required

Show transcript returned by the Sendora API.

theme
Theme · object
required

Theme returned by the Sendora API.

avatar_url
string | null

Avatar url returned by the Sendora API.

avatar_video_live_url
string | null

Avatar video live url returned by the Sendora API.

avatar_video_pre_call_url
string | null

Avatar video pre call url returned by the Sendora API.

avatar_video_url
string | null

Avatar video url returned by the Sendora API.

display_mode
enum<string>
default:conversation

Display mode returned by the Sendora API.

Available options:
conversation,
compact,
launcher
display_name
string | null

Display name returned by the Sendora API.

launcher_icon
string
default:iridescent

Launcher icon returned by the Sendora API.

launcher_media_type
enum<string> | null

Launcher media type returned by the Sendora API.

Available options:
image,
video
launcher_media_url
string | null

Launcher media url returned by the Sendora API.

settings
WidgetEditorSettings · object

Settings returned by the Sendora API.