Apps API: Sample Flows

This article presents a possible use case and corresponding sample flow that you can support. It provides a useful starting point as you plan your implementation.

Create and configure an app

Use this flow when a developer tool creates an app and prepares its identity before adding components, permissions, webhooks, or versions through the related App Management APIs.

To create and configure an app:

1. Call Create App with the display name and installation preferences. Use a name of no more than 30 characters if you intend to publish in the Wix App Market. Omit the namespace and slug. Creating companion apps is restricted to authorized provisioning services. Store returned credentials securely on the backend.
2. Save the returned app.id and app.revision for subsequent calls. Use the app ID in the related App Management APIs.
3. Call Set Namespace with the app ID and appName. The namespace can be assigned once. Review the method's normalization and reserved-name rules. A suggestion doesn't reserve the namespace; choose a different app name and retry when assignment conflicts.
4. Call Generate Slug to generate the app's App Market slug. An existing slug is returned unchanged. This operation doesn't generate slugs for companion apps.
5. Call Get App to retrieve the latest revision, then Update App with the ID, revision, and fields to change, such as the display name or installation preferences. In REST requests, specify mask.paths with only the fields to change, excluding id and revision. Identity fields, creator information, and secrets aren't updated through this method. The published SDK doesn't expose the mask argument; use the SDK-authenticated REST workaround in the Update App example.

After configuring the app, use the related Components, App Permissions, Webhooks, Dependencies, and App Versions APIs to manage its building blocks. Configuration doesn't publish a version or install the app on a site.

appUrls.appUri and appUrls.redirectUris configure Advanced OAuth, whose use is highly discouraged. See Advanced OAuth.

To configure allowed destinations after installation from an external install link, set appUrls.postInstallationUrls. Use the nested field mask appUrls.postInstallationUrls to replace this list while preserving the other URL settings. The destination must match an entry, unless it is a Wix-managed destination allowed separately. URLs are compared after normalizing whitespace and ignoring query strings and fragments.