Retrieve integration configuration

Retrieving integration configuration

To fetch the configuration for a web integration, make a GET HTTP request to:

https://channels-ws.moveo.ai/v1/web/{INTEGRATION-ID}

If the integration has trusted domains, send an Origin header with one of those domains. Otherwise the request fails with a 403 status code.

This will return the parameters of the web integration you setup in Moveo. This can be useful for customizing the UI of the integration, or check if the integrations needs a required field filled by the user.

Configuration types

Below is a comprehensive list of all available configuration options:

Field	Type	Description
session_timeout	integer	Time in seconds before a session expires
domains	string[]	List of trusted domains where the widget can be embedded
name	string	Name of the integration
avatar	string	URL of the avatar image
header_title	string	Title shown in the widget header
icon_size	string	Size of the widget icon
window_size	string	Size of the chat window
show_powered_by	boolean	Whether to show the "Powered by Moveo" text
accent_color	string	Primary color used in the widget (hex code)
background_color	string	Background color of the widget (hex code)
welcome_message	string	Initial message shown to users
welcome_trigger_message	string	Default trigger message
optional_fields	string[]	List of optional visitor information fields
required_fields	string[]	List of required visitor information fields
theme	string	Color theme of the widget
widget_position	string	Position of the widget on the page
focus_trap	boolean	Whether to trap focus within the widget
auto_open	boolean	Whether the widget opens automatically
sticky_session	boolean	Whether to maintain session across page reloads
bubble_image	string	URL of the bubble image
language	string	Default language of the widget
show_survey	boolean	Whether to show post-chat survey
waiting_time_threshold	integer	Time threshold for waiting messages
external_urls_limit	integer	Limit for external URLs
file_upload	boolean	Whether file upload is enabled
rate_responses	boolean	Whether users can rate responses
widget_alignment	string	Alignment of the widget on the page

Launcher configuration

Field	Type	Description
launcher.size	string	Size of the launcher button
launcher.show	boolean	Whether to show the launcher
launcher.type	string	Type of launcher

Welcome screen configuration

Field	Type	Description
welcome_screen.greeting	string	Welcome screen greeting text
welcome_screen.enabled	boolean	Whether welcome screen is enabled
welcome_screen.starters	string[]	List of starter messages

Visitor information configuration

Field	Type	Description
visitor_information.headline	string	Headline for visitor information form
visitor_information.location	boolean	Whether to collect location
visitor_information.fields[].field	string	Field identifier
visitor_information.fields[].required	boolean	Whether the field is required
visitor_information.fields[].variable	string	Variable name for the field
visitor_information.fields[].languages	string[]	Supported languages for the field
visitor_information.disclaimer.html	string	HTML content of the disclaimer
visitor_information.disclaimer.enabled	boolean	Whether disclaimer is enabled

Page triggers configuration

Field	Type	Description
page_triggers[].opening_message	string	Message shown when trigger is activated
page_triggers[].trigger_message	string	Message that triggers the widget

Example response

{
  "session_timeout": 3600,
  "domains": ["https://trusted-domain.com"],
  "show_powered_by": false,
  "accent_color": "#fff",
  "background_color": "#1b66d6",
  "welcome_message": "Welcome to Move!",
  "welcome_trigger_message": "defaultstartmessage",
  "theme": "dark",
  "widget_position": "embed",
  "focus_trap": true,
  "auto_open": true,
  "bubble_image": "https://your-image-url.com/image.png",
  "show_survey": true,
  "launcher": {
    "type": "bubble"
  },
  "visitor_information": {
    "location": true,
    "fields": [
      {
        "field": "email",
        "required": true
      }
    ],
    "disclaimer": {
      "html": "This conversation is recorded for quality assurance purposes.",
      "enabled": true
    }
  }
}