Wix guide

Create a Wix app and configure it so that you can process payments and storefront data through Rutter.

Wix moved custom app management into Wix Studio (manage.wix.com/studio/custom-apps). The older dev.wix.com/dc3/my-apps Dev Center is deprecated. The steps below reflect the current Wix Studio UI. You need a Wix Studio account (sign up at wix.com/studio) — a "Wix developer account" is no longer a separate thing.

New Wix apps use OAuth client credentials. Custom authentication (the old App URL + Redirect URL exchange) is available only to older apps. Rutter uses the new flow by default; a legacy app is identified by the Wix proxy credential credential_dump value wix_legacy_oauth_uses_old_oauth_urls.

Create a Wix app

  1. Go to Custom Apps in Wix Studio.
  2. Click Create New AppBuild from scratch. (The dropdown also offers "Build with AI" and "Start with a template" — Rutter integrations start from scratch.)
    • In the Choose a framework to start building dialog, select Self-Managed ("Take full control over your tech stack, deployment, and hosting") and click Get Started. (Do not pick Wix CLI or Wix Blocks.) Give the app a name.
  3. You'll land on the app's Home at manage.wix.com/apps/{APP_ID}/home. The left nav has five groups: Home, Develop, App Profile, Distribute, Manage. All the configuration below lives under Develop.

Configure OAuth

  1. Go to Develop → OAuth. Find your Rutter organization ID here.
    • Copy the App ID and App Secret Key from App keys. Rutter uses these to mint client-credentials tokens for each installed Wix app.
  1. Go to Develop → Extensions → Create Extension → Dashboard Page and set its URL to:

    https://production.rutterapi.com/wix/proxy/${YOUR_RUTTER_ORG_ID}/page-url

    Wix app pages receive the signed instance value. Rutter uses it to create or reuse the connection and sends the browser back to Rutter Link's normal completion callback. Verify this in a test install before sharing the link with merchants.

Legacy custom authentication — existing apps only

If the OAuth page still has Custom authentication (legacy), configure it only when the matching Rutter proxy credential has credential_dump set to wix_legacy_oauth_uses_old_oauth_urls:

  • Set the App URL to https://production.rutterapi.com/wix/proxy/${YOUR_RUTTER_ORG_ID}/app-url
  • Set the Redirect URL to https://production.rutterapi.com/wix/proxy/${YOUR_RUTTER_ORG_ID}/redirect-url

Add permissions

  1. Go to Develop → PermissionsAdd Permissions.
    • Add Wix Stores → Manage Stores - all permissions.
    • Wix is migrating Wix Stores to the Catalog V3 APIs. To make sure every merchant (old and new sites) can install your app, go to Develop → App Settings → Wix Stores Catalog V1 & V3 compatibility and click Confirm Compatibility once your app supports both. If you skip this, some sites won't be able to install the app.

Add webhooks

  1. Go to Develop → Webhooks → Create Webhook. Webhooks are now added one event at a time: filter by category (or search), click Select Event, then paste the callback URL and click Subscribe. Repeat for each event below.

    The callback URL for every Rutter webhook is: https://production.rutterapi.com/wix/proxy/${YOUR_RUTTER_ORG_ID}/webhooks

    Subscribe to these events:

    • eCommerce → Product Deleted
    • eCommerce → Order Created, Order Updated, and Order Canceled
    • App Instance → App Installed
    • App Instance → App Removed

    The old Wix Stores → Order created event is now marked DEPRECATED in the Wix UI. Use the eCommerce order events instead. If you are unsure which events your Rutter environment expects, confirm with your Rutter onboarding contact — Rutter's proxy only acts on ProductDeleted, the eCommerce Orders event, and AppRemoved.

  2. Get the webhook signing public key: on Develop → Webhooks, on the Subscriptions tab, click Get Public Key (top right). Click Copy Key and share the JWT-encoded public key with your Rutter onboarding team member. (This replaces the old "Public key → Open" step, which used to live on the OAuth page.)

Copy your keys into Rutter

  1. Go to https://dashboard.rutterapi.com/platforms/wix and paste your App ID and App Secret Key into the Rutter config.
  2. In Distribute → App distribution, release a version and copy the private Share Install Link. Add that URL to the Wix proxy credential's wix_test_share_link field. Despite its legacy name, this field is the Studio install/share URL used by Link.
  3. Go to https://dashboard.rutterapi.com/customize, expand Platforms, and enable Wix.

Test the install flow

  1. Use the share install link to install the app on a Wix site you control, open its Rutter dashboard page, and verify that Link receives its success callback and the connection begins its initial refresh.

Create a Wix Test Store

  1. Go to wix.com and create a new site.
  2. Choose an Online Store business type so the site has the Wix Stores app.
  3. Pick any template/theme and publish the site.
  4. (Optional) To place real test orders you need a paid Business & eCommerce plan: https://manage.wix.com/wix/api/premiumStart.

Wix changes the site-creation onboarding flow frequently (ADI, templates, AI builder, etc.). The exact clicks vary — the only requirement for Rutter is that the finished site has the Wix Stores app installed.

Launch Your Wix App on the Wix App Market

You do not need App Market approval to use the app with a specific merchant: use Distribute → Share Install Link or Install on Site for private distribution. Public listing on the App Market requires review (Wix usually takes ~2 weeks; Israeli holidays can add delay). To submit:

  1. From the app, complete every section under App Profile: App Info, Media, App Audience, Get Found, Pricing, Contact Info, and Company Info.
  2. Go to Distribute → Submit to App Market. If there are blockers, click Show Blockers and resolve each one, then submit.
  3. During submission you'll provide testing instructions and a test account for the Wix reviewer.
    • We recommend creating a test account on your own service and only allowing that account to authorize a Wix store, so Wix reviewers can test the flow end to end without exposing the connection feature to your customers before approval. Until Wix approves the app, no other Wix merchant can connect to it (unless you share a private install link).
  4. Wait for the email from Wix App Review for the next step.
Previous
Webflow