action motaword_get_active_widget { label: "View an Active widget" description: "View the details of an Active widget to be used in your website. Most website-specific configuration is provided via widgets." provider: motaword method: GET path: "/continuous_projects/{projectId}/widgets/{widgetId}" encoding: json input: { type: "object" properties: { projectId: { type: "integer" format: "int64" } widgetId: { type: "integer" format: "int64" } } required: ["projectId", "widgetId"] additionalProperties: false } output: { type: "object" properties: { allow_hash_in_url: { type: "boolean" description: "When true, hash params are included in filenames. When false, params are ignored." } allow_query_in_url: { type: "boolean" description: "When true, query params are included in filenames. When false, params are ignored." } auto_detect_source_language: { type: "boolean" description: "When true, we will ignore the source language of your project and try to automatically detect the source language of the given content. This is especially useful in environments with unpredictable source contents, such as a chat environment." } created_at: { type: "string" format: "date-time" description: "the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z" } elements: { type: "string" description: "Continuous project exclusive elements and rules" } follow_user: { type: "boolean" description: "Specify whether we should follow the user around in your website and automatically translate pages." } force_cache_refresh_interval: { type: "boolean" description: "Determines whether to force-refresh local browser cache of your translations in certain period of times, no matter if there is a new activity in the project." } id: { type: "integer" format: "int64" } language_mappings: { type: "string" description: "Continuous project language mappings" } live: { type: "boolean" description: "Whether ActiveJS should be considered live in an embedded site. Use `false` if you are still testing Active. Go to your Active dashboard and follow links to your website to actually test Active." } modify_links: { type: "boolean" description: "We can automatically localize the same-domain URLs in your page. The way we localize the URL depends on urlMode configuration. We can either add/update the locale query parameter, or add/update the path of the URL." } name: { type: "string" } optimize_per_page: { type: "boolean" description: "When true, Active ecosystem will optimize the script and data flows per page, rather than per project. This decreases the bandwidth usage per script, but makes translation publishing more complex and script serving per-page." } pages: { type: "string" description: "Continuous project page rules" } path_regex: { type: "string" description: "Custom regex for path-type URL mode." } position: { type: "string" description: "Options are \"bottom-left\", \"bottom-right\", \"in-place\"" } query_name: { type: "string" description: "Query parameter name to be used with query-type URL mode. Default is 'locale'." } reboot_on_url_change: { type: "boolean" description: "When true, Active ecosystem reboots itself when url changes." } restricted_domains: { type: "string" description: "JSON string for a list of domains that this widget's API interactions are limited to." } sections: { type: "string" description: "Continuous project section rules" } test_mode: { type: "boolean" description: "Is the Active Widget in test mode? This changes a couple behaviors in the widget to make it easier for you to test and develop your Active integration." } theme: { type: "string" description: "\\\"light\\\", \\\"dark\\\" OR custom JSON." } token: { type: "string" description: "Token that you should use when you are using this widget on your website." } url_change_mode: { type: "string" description: "When a user changes locale (or when we automatically detect and change it for them), we will change the URL of the page they are in. We can do this by actually redirecting the user to the new page, or by simply changing the URL in the address bar via browser's History API. When NULL, we won't apply any URL changes." } url_mode: { type: "string" description: "When a user changes locale (or when we automatically detect and change it for them), we will change the URL of the page they are in. We can either change the path of the URL to prefix it with the locale code, or we can add a query parameter to the URL. We also use this mode to detect the locale for the current page when a user directly loads a page. When NULL, locale detection from URL will be disabled (even then, if the user has selected a locale manually, and followUser is enabled, we will still automatically translate the page in user's locale." } use_cache: { type: "boolean" description: "Should we make use of local browser cache for your visitors? We will refresh the cache when Active JS detects new activity in your project." } use_dummy_translations: { type: "boolean" description: "When enabled, we will translate your website with dummy content, rather than actually using MT/TM." } variables: { type: "string" description: "Continuous project variable definitions" } } } }