About the Apps API

The Apps API lets developer tools create and configure Wix apps. Use it to prepare an app's identity and configuration before adding functionality or preparing a release.

With the Apps API, you can:

• Create apps and update their names and installation preferences.
• Retrieve app configuration and assign namespaces and slugs.
• Retrieve app secrets with the required authorization.

Apps and their building blocks

An app provides the shared identity for its components, permissions, webhooks, dependencies, and versions. Use its id when working with these related App Management APIs:

• Components manages pages, widgets, and other app extensions.
• App Permissions manages the Wix resources the app can access. Permission changes can take up to 5 minutes to appear across the Wix ecosystem.
• Webhooks manages subscriptions to Wix events.
• Dependencies manages other apps required by the app.
• App Versions manages draft and published versions.

Creating or updating the app's configuration doesn't publish an app version or install the app on a site.

Before you begin

It's important to note the following points before starting to code:

• Keep app secrets in secure backend storage. Don't include them in frontend code, source control, or logs.
• Get App omits secrets by default. Include APP_SECRETS in additionalFields to retrieve them with the required authorization.
• App configuration, app publication, and app installation are separate workflows. This API covers app configuration.
• Retain the app.id returned when creating an app. This API has no public methods to list or delete apps.
• Apps intended for the Wix App Market should have names of no more than 30 characters. The API accepts up to 50 characters.
• appUrls.appUri and appUrls.redirectUris configure Advanced OAuth, whose use is highly discouraged. See Advanced OAuth.
• Unreleased-change flags are calculated automatically, update asynchronously and don't track every change. Permission deletions and component-translation creation events currently aren't reflected in their corresponding flags.

Use cases

• Create and configure an app for development.

Terminology

• App: An extension built for Wix, with its own identity, configuration, and building blocks.
• Display name: The human-readable name shown to users.
• Namespace: An identifier combining an account or company identifier with an app-name component, such as @example-company/bookings-helper.
• Slug: A human-readable, URL-friendly identifier for the app.
• Code identifier: An identifier used to reference the app in code. Reserved JavaScript words aren't rejected; choose a non-reserved value when using it as a variable name. Companion apps share the value companionApp, so use the app ID when a unique identifier is needed.
• Companion app: An app assigned to a specific site or account.