Skip to navigation

Embedded Assistant Settings

View as Markdown

assistant.embedded-assistant-setting

Appearance/behaviour of the embedded (web) assistant widget.

  • Endpoint: /assistant/embedded-assistant-setting | Methods: GET, PATCH
  • Request shape: one per organization, so there is no id. It already exists: read it with GET, then PATCH the fields you want to change. Fields go at the top level of the JSON body, with no resource wrapper.
  • Updates: a JSON merge-patch. Send only the fields you change, plus version: {num, change_description} with the num from your last read. Lists and maps you send replace the stored ones whole.

Endpoints

All paths are relative to https://api.moveworks.ai/configurations/v1alpha1. Each endpoint page lists the request and response schema, an example, and the errors it can return.

MethodPathEndpoint reference
GET/assistant/embedded-assistant-settingGet embedded assistant settings
PATCH/assistant/embedded-assistant-settingUpdate embedded assistant settings

Fields

FieldTypeRequiredNotes
font_familystringCustom font family for the chat, in CSS font-family syntax. Invalid values are ignored and the default font is used.
avatar_buttonAvatarButtonSettingsSettings for the assistant avatar button.
close_buttonCloseButtonSettingsSettings for the chat close button.
speech_bubbleSpeechBubbleSettingsControls how the speech bubble above the avatar is displayed.
full_screen_heightstringHeight of the full screen chat window, in CSS syntax. Invalid values are ignored and the default of 100% is used.
full_screen_widthstringWidth of the full screen chat window, in CSS syntax. Invalid values are ignored and the default of 100% is used.
display_urlsUrlFilterSettingsWildcard URL patterns that decide on which pages the assistant is displayed.
proactive_popup_urlsUrlFilterSettingsWildcard URL patterns that decide on which pages the chat opens automatically.
updated_timestringread-onlyWhen the configuration was last updated.
updated_bystringread-onlyWho last updated the configuration.
versionVersionDocument version. On update, send back the num from your last read.

Document fields (example)

The document as GET returns it. To change any of these, send only the fields you want to change in the PATCH body.

{
"font_family": "<string>",
"avatar_button": {
"image_url": "https://example.com/path",
"size": 1
},
"close_button": {
"size": 1
},
"speech_bubble": {
"hide_after_expiration_enabled": true,
"expiration_time_seconds": 60
},
"full_screen_height": "<string>",
"full_screen_width": "<id>",
"display_urls": {
"allow_list": [
"https://example.com"
],
"block_list": [
"https://example.com"
]
},
"proactive_popup_urls": {
"allow_list": [
"https://example.com"
],
"block_list": [
"https://example.com"
]
}
}