Skip to main content
WidgetSettingsResource is reachable on every Kataven Node client as client.widgetSettings. Each method maps to one HTTP endpoint on the Hub API; links to the underlying spec entry are inline below. Account-level widget branding (colors, logo, copy) and per-agent widget policy (auth requirements, custom intro copy).

​
Methods at a glance

MethodHTTPSummary
getGET /api/v1/widget-settingsGet account-level widget branding
updatePATCH /api/v1/widget-settingsUpdate account-level widget branding
getAgentGET /api/v1/agents/{agentId}/widget-settingsGet per-agent widget policy
updateAgentPATCH /api/v1/agents/{agentId}/widget-settingsUpdate per-agent widget policy

​
Reference

​
client.widgetSettings.get(...)

Get account-level widget branding HTTP — GET /api/v1/widget-settings · API reference → 
get()
Returns the widget appearance config (colors, logo, copy) shared by every embedded widget in this account.

​
client.widgetSettings.update(...)

Update account-level widget branding HTTP — PATCH /api/v1/widget-settings · API reference → 
update(patch: {
  primary_color?: string;
  accent_color?: string;
  logo_url?: string;
  launcher_position?: "br" | "bl" | "tr" | "tl";
  launcher_label?: string;
  privacy_notice?: string;
})

​
client.widgetSettings.getAgent(...)

Get per-agent widget policy HTTP — GET /api/v1/agents/{id}/widget-settings · API reference → 
getAgent(agentId: string)
Returns the widget policy for one agent (auth requirements, custom intro copy, agent-specific overrides).

​
client.widgetSettings.updateAgent(...)

Update per-agent widget policy HTTP — PATCH /api/v1/agents/{id}/widget-settings · API reference → 
updateAgent(agentId: string, patch: { widget_enabled?: boolean; auth_mode?: "guest" | "user" | "both" })