About Host Modules

Host modules allow you to use SDK APIs to interact with a site when writing code for frontend environments such as dashboard or site extensions. The module you use depends on which environment you're writing code for.

Note: Host modules should only be used in self-hosted apps. You don't need to use them in apps built using the Wix CLI or Wix Blocks. You can't use host modules when building headless projects.

To use a host module, create a Wix client. The client's authentication and authorization are handled automatically by the host module. The client authenticates API calls using the identity of the site visitor, site member, or Wix user who accesses the frontend you create.

Some host modules also provide functionality for interacting with their environments. For example, the Dashboard module contains functionality to navigate users to pages in the dashboard.

The SDK includes the following host modules:

Was this helpful?
Yes
No