Widget

field	type	description	properties
widget_id	string(uuid)	A unique identifier for the Widget.
intro_title	string	The message displayed upon the introduction of the Widget flow.
public_alias	string	The public identifier for the Widget (eg. demo => https://app.usecanopy.com/c/demo). When not explicitly set, a public_alias will be auto generated.
company_name	string	The company name presented in the Widget flow.
success_message	string	The message displayed upon successful completion of the Widget flow.
on_success_redirect_url	string \| null	The URL the user is taken to upon successful completion of the Widget flow.
is_sandbox	boolean	Whether or not the Widget is in sandbox mode (as opposed to production mode).
brand_color_hex	string	RRGGBB hexadecimal string used for color theming in the Widget flow.
cobranded_intro_screen	boolean	Whether the enhanced “cobranded” introduction screen is enabled for the Widget flow.
public_url	string	The fully qualified public URL for the Widget flow (eg. https://app.usecanopy.com/c/demo).
logo_src	string \| null	The fully qualified public URL for the logo image displayed in the Widget flow.
icon_src	string \| null	The fully qualified public URL for the icon image shown in the Widget flow when cobranded_intro_screen is enabled.
agents	array	List of agents	References Agent