Create a new Active widget

post

https://api.motaword.com/continuous_projects/{projectId}/widgets

Create a new widget for your Active project to be used in your website. Most website-specific configuration is provided via widgets. This does not create a new Active project, just a separate widget.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

projectId

int64

required

Continuous project ID

Body Params

int64

created_at

date-time

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

token

string

Token that you should use when you are using this widget on your website.

name

string

mode

string

Options are "simple", "advanced"

theme

string

"light", "dark" OR custom JSON.

position

string

Options are "bottom-left", "bottom-right", "in-place"

use_dummy_translations

boolean

When enabled, we will translate your website with dummy content, rather than actually using MT/TM.

follow_user

boolean

Specify whether we should follow the user around in your website and automatically translate pages.

technology

string

When a user changes technology (or when we automatically detect and change it for them), we will re-control whole site.

url_mode

string

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.

url_change_mode

string

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.

live

boolean

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

boolean

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.

use_cache

boolean

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.

force_cache_refresh_interval

boolean

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.

language_mappings

string

Continuous project language mappings

variables

string

Continuous project variable definitions

sections

string

Continuous project section rules

pages

string

Continuous project page rules

elements

string

Continuous project exclusive elements and rules

test_mode

boolean

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.

restricted_domains

string

JSON string for a list of domains that this widget's API interactions are limited to.

auto_detect_source_language

boolean

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.

allow_query_in_url

boolean

When true, query params are included in filenames. When false, params are ignored.

allow_hash_in_url

boolean

When true, hash params are included in filenames. When false, params are ignored.

optimize_per_page

boolean

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.

path_regex

string

Custom regex for path-type URL mode.

query_name

string

Defaults to locale

Query parameter name to be used with query-type URL mode. Default is 'locale'.

reboot_on_url_change

boolean

When true, Active ecosystem reboots itself when url changes.

debug_mode

boolean

When true, Active ecosystem will print debug-level logs from all Active modules.

hit_backend_for_existing

boolean

When true, Active ecosystem will collect all strings on TMS no matter if the translation is present in the cache.

admin_mode

boolean

Is the Active Widget in admin mode? This changes a couple of behaviors in the widget to configure some rules like elements, sections, pages, etc.

convert_relative_urls_to_absolute

boolean

Using this, all relative URLs (apart from the "A" tag) are converted to absolute URLs. This is especially useful when you are rendering a webpage via serve.motaword.com without using customer’s domain as hostname. When false, webpage will try to load relative assets from serve.motaword.com host

enforce_source_locale_in_path

boolean

This option enforces source locale in path when urlMode is query.

start_dynamic_after_dom

boolean

Start the dynamic translation when document ready state is complete. Default it starts when interactive.

url_mappings

string

Continuous project url mappings

Responses

200Updated widget details

404ProjectNotFound | ActiveWidgetNotFound | UnauthorizedUser