startInstallFlow()
Opens the one-step installation modal for a Wix app.
Important: This method is only available in the editor.
Method declaration
Copy
Parameters
| Name | Type | Description |
|---|---|---|
args | InstallFlowRequest | Configuration options for installing the app. |
InstallFlowRequest
| Name | Type | Description |
|---|---|---|
appId | string | Required. The ID of the app to install. |
enablePostInstallNavigation | boolean | Whether to redirect after installation for additional app setup. Default is true. If you call the method in the editor, the method ignores this field and doesn't redirect. |
Returns
Copy
A promise that resolves to an InstallFlowResponse indicating the result of the installation attempt.
InstallFlowResponse
| Name | Type | Description |
|---|---|---|
status | string | Status indicating that the installation completed or explaining why it didn't. Possible values:
|
installedApps | InstalledApp[] | Array of installed apps. Includes the target app and any apps that were also installed because they're dependencies for it. The response includes this field only if status is SUCCESS. |
InstalledApp
| Name | Type | Description |
|---|---|---|
appId | string | The ID of the installed app. |
version | string | The version of the installed app. |
Examples
Install an app
Copy
Errors
This method may return the following error codes:
ALREADY_INSTALLED: The app is already installed on the site.UPGRADE_TO_PREMIUM: The installation requires upgrading the site to a premium plan.CONNECT_DOMAIN: The installation requires connecting a domain to the site.
Did this help?