App Object


An app defines the identity and configuration of an extension built for Wix. It contains ownership information, identifiers, authentication settings, and installation preferences. Components, permissions, webhooks, dependencies, and versions are managed through related APIs.

Properties
accountIdstringRead-onlyformat GUID

ID of the account that owns the app.


appSecretsAppSecrets

Secrets for authentication and webhooks. Omitted from Get App responses by default. To retrieve them, include APP_SECRETS in Get App's additionalFields. Requires authorization to access the app's secrets.


appUrlsAppUrls

URL settings for Advanced OAuth and post-installation navigation. Using Advanced OAuth through appUri and redirectUris is highly discouraged. See Advanced OAuth.


codeIdentifierstringminLength 3maxLength 150

An identifier for referencing the app in code, separate from its display name, namespace, and slug. Must start with a letter, underscore, or dollar sign; remaining characters can also include digits. JavaScript reserved words aren't rejected. Choose a non-reserved identifier if using this value as a JavaScript variable name. Unique for non-companion apps. Companion apps return the shared value companionApp; use id to uniquely identify an app. For example, the namespace @app-builder/my-cool-app can be represented by the code identifier AppBuilderMyCoolApp.


companionAppboolean

Indicates whether this app is a companion app assigned to a specific site or account.


createdByCreatedByimmutable

Identity and creation channel of the user or app that created the app, including its source template when applicable. Create App derives id and type from the caller's identity, replacing any supplied values. You can supply sourceTemplateId during creation. Creator information can't be changed through Update App.


createdDatestringRead-onlyformat date-time

Date and time the app was created.


idstringformat GUID

App ID.


installationPreferencesInstallationPreferences

Settings for post-installation navigation, opening the app, and uninstalling it.


namestringmaxLength 50

The display name shown to users and in App Market after publication, separate from the namespace, slug, and code identifier. Apps intended for publication in the Wix App Market should have a name of no more than 30 characters. On creation and update, <, >, double quotes, and apostrophes are escaped as &lt;, &gt;, &quot;, and &apos;. Responses contain the escaped value, which can be longer than the submitted name.


namespacestringminLength 1maxLength 150

App namespace, combining an account or company identifier with an app-name component. For example, @example-company/bookings-helper. Assign it once through Set Namespace after creating the app. Don't supply it to Create App or Update App. Set Namespace fails if the app already has a namespace.


revisionstringformat int64

Revision number, which increments by 1 each time the app is updated. To prevent conflicting changes, supply the current revision when calling Update App. Retrieve the latest revision through Get App before updating. Ignored when creating an app.


slugstringminLength 1maxLength 50

A human-readable, URL-friendly identifier for the app.


statusstring

The state of the application.


unreleasedChangesUnreleasedChanges

Automatically calculated, event-based tracking of unreleased changes, grouped by type. Updates asynchronously; see each flag for its tracking scope.


updatedDatestringRead-onlyformat date-time

Date and time the app was last updated.

Did this help?