Settings

Get Chat Widget

Changed on

Get a single chat widget's full configuration.

get/settings/chat-widgets/{chat_widget_id}

Request

  • Base URL: https://api.openintake.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.openintake.ai/settings/chat-widgets/{chat_widget_id}
  • Auth: none declared

Path parameters

chat_widget_idstring uuid required

Response

Successful Response

customer_idstring uuid required
enabledboolean required

Whether the chat widget is shown on the customer's website

accent_colorstring required

Primary color for the bubble, header, and assistant messages

secondary_colorstring nullable

Secondary accent color. When null, derived automatically from the accent color.

launcher_colorstring nullable

Overrides the floating launcher bubble color only (e.g. when the accent blends into the site background). When null, the launcher uses the accent color.

positionstring required

Where the chat bubble appears on the page (bottom-right or bottom-left)

greeting_messagestring required

The first message shown when a visitor opens the chat

assistant_namestring required

Displayed in the chat header

system_promptstring nullable

Full system prompt override. When set, replaces the assembled prompt entirely.

persona_promptstring nullable

Personality/tone instructions (e.g. 'You are Ashley, a warm and professional intake specialist')

law_firm_contextstring nullable

Firm-specific information injected into the prompt. Falls back to Customer.law_firm_info_prompt if not set.

intake_goalstring nullable

What to do after collecting info (e.g. 'Let them know an attorney will follow up within 24 hours')

additional_instructionsstring nullable

Extra rules or context for the AI assistant

teaser_enabledboolean

Whether to show a teaser message bubble next to the chat button

teaser_messagestring nullable

Teaser message text. Falls back to greeting_message if not set.

teaser_delay_secondsinteger

Seconds to wait before showing the teaser message

show_online_statusboolean

Whether to show an online indicator on the chat bubble and header

show_unread_badgeboolean

Whether to show an unread badge on the chat bubble

tab_notification_enabledboolean

Whether to flash unread count in the browser tab title

avatar_urlstring nullable

URL of the agent avatar image for the header and messages

avatar_video_urlstring nullable

URL of a silent looping video shown in place of the avatar image (header and launcher). Takes precedence over avatar_url.

avatar_video_in_headerboolean

When false, the open panel's header shows the static avatar image and the avatar video only plays on the launcher bubble

launcher_avatar_enabledboolean

When true (and avatar_url is set), the floating launcher shows the avatar image inside an accent-colored ring instead of the default chat bubble icon

intro_video_enabledboolean

When true (and intro_video_url is set), opening the widget plays an intro video full-panel before transitioning into the chat

intro_video_urlstring nullable

URL of the intro video (mp4/webm) played when the widget opens

intro_video_autoplay_on_loadboolean

When true, desktop visitors see the muted intro video playing in the widget corner on page load; when false it only plays after they click the launcher

auto_open_on_loadboolean

When true, the chat panel opens automatically on page load for desktop visitors (>=768px wide); mobile keeps the collapsed bubble. No conversation is created until the visitor sends their first message

attention_grabber_enabledboolean

When true, a full-page modal asks visitors if they need help; Yes opens the chat directly, No dismisses it

attention_grabber_messagestring nullable

Question shown in the attention grabber modal. Falls back to a default when not set.

attention_grabber_delay_secondsinteger

Seconds to wait before showing the attention grabber modal

idle_messagestring nullable

Message shown when visitor is idle. Leave empty to disable.

idle_delay_secondsinteger nullable

Seconds of inactivity before showing the idle nudge message

quick_exit_enabledboolean

Privacy Quick Exit: the widget never persists the chat across page loads — the conversation is ended and reset on browser close/refresh

mobile_bottom_offset_pxinteger nullable

Extra clearance in pixels between the widget and the bottom of the viewport on mobile, for sites with a fixed bottom bar. Null = none.

chat_idle_timeout_minutesinteger nullable

Minutes of inactivity before a chat is auto-completed. Default: 10 minutes.

allowed_originsstring[] nullable

Allowed origins for CORS. When empty or null, any origin can embed the widget.

allow_all_originsboolean

When true, any origin may embed the widget regardless of allowed_origins (temporary escape hatch, e.g. during onboarding)

custom_domainstring nullable

White label: customer-owned hostname (e.g. chat.theleachfirm.com) serving both widget.js and /chat/*. Shapes the embed snippet only — the CloudFront distribution and certificate must be provisioned separately, and this value never reaches the public widget config.

chat_widget_idstring uuid required
namestring required

Display label for the widget

is_defaultboolean required

Whether this is the customer's default widget

Changes