Skip to main content

Interface: MountForgotPasswordPayload

Configuration for mounting a password recovery interface.

This interface extends the core embed configuration to provide a complete password recovery flow. It allows users to request password resets and enter verification codes to regain access to their accounts.

Extends​

Properties​

baseURL?​

optional baseURL: string

Base URL for API requests.

This specifies the endpoint for all API communications from the embed. If not provided, the system will use the default API URL from the embed environment.

Inherited from​

EmbedPayloadPartial.baseURL

CDNPath?​

optional CDNPath: string

Path to the CDN for static assets.

This URL is used to load images, 3D models, and other static resources required by the configurator. If not provided, the system will use the default CDN path from the embed environment.

Inherited from​

EmbedPayloadPartial.CDNPath

customerId​

customerId: string

Identifier for the customer account.

This specifies which customer's products and configurations will be available in the embed. Each customer has their own isolated data and settings.

Inherited from​

EmbedPayloadPartial.customerId

elementId?​

optional elementId: string

Deprecated​

Use uid with data-mimeeq-short-code attributes instead ID of HTML element in which to mount the embed

Inherited from​

EmbedPayloadPartial.elementId

locale​

locale: string

Language code for the embed UI.

This sets the language used throughout the interface, including labels, button text, and error messages. Uses standard language codes like 'en', 'fr', 'de'.

Inherited from​

EmbedPayloadPartial.locale

onEventDispatch?​

optional onEventDispatch: EventDispatchCallback<any>

Callback function for handling events from the embed.

This function is called whenever a significant event occurs within the configurator, such as option selection, configuration changes, or user actions. It allows the hosting application to respond to these events.

Inherited from​

EmbedPayloadPartial.onEventDispatch

onLoginSuccess?​

optional onLoginSuccess: OnLoginSuccess

Callback function triggered after successful login.

This function is called when a user successfully completes the password recovery process and is automatically logged in. It receives the user data object containing authentication details and profile information.

This callback can be used to update UI state, redirect to protected areas, or perform any other post-authentication actions.

uid​

uid: string

Unique identifier for this embed instance.

This ID is used to identify a specific embed configuration and is typically the shortcode for the embed. The system will mount the embed into an HTML element with a data-mimeeq-shortcode attribute matching this value.

Each embed on a page should have a unique UID to prevent conflicts.

Inherited from​

EmbedPayloadPartial.uid

withWatcher?​

optional withWatcher: boolean

Enables sandbox logic for development and testing.

When true, the embed runs in a sandboxed mode with additional monitoring and development features. This should generally be false in production.

Inherited from​

EmbedPayloadPartial.withWatcher