wix-cli-service-plugin
Wix Service Plugin (SPI) Builder
Creates service plugin extensions for Wix CLI applications. Service plugins are a set of APIs defined by Wix that you can use to inject custom logic into the existing backend flows of Wix business solutions or to introduce entirely new flows to Wix sites.
When you implement a service plugin, Wix calls your custom functions during specific flows. Common use cases include eCommerce customization (shipping, fees, taxes, validations) and Bookings customization (staff sorting), but service plugins can extend any Wix business solution that exposes SPIs.
Quick Start Checklist
Follow these steps in order when creating a service plugin:
- Read the reference doc for your SPI type, then STOP and call
ReadFullDocsMethodSchemawith the docs URL from the reference to get the exact request/response types — DO NOT write any code until you have the schema - Create plugin folder:
src/extensions/backend/service-plugins/<service-type>/<plugin-name>/ - Create
plugin.tswith correct imports andprovideHandlers()call - Implement all required handler functions with complete business logic
- Create
extensions.tswith appropriate builder method and unique UUID - Update
src/extensions.tsto import and use the new extension - Run
npx tsc --noEmitto verify TypeScript compiles - Run
npx wix buildto verify build succeeds - Test by triggering the relevant site action (e.g., add to cart for fees)
More from wix/skills
wds-docs
Wix Design System component reference. Use when building UI with @wix/design-system, choosing components, or checking props and examples. Triggers on "what component", "how do I make", "WDS", "show me props", or component names like Button, Card, Modal, Box, Text.
329wix-cli-dashboard-page
Use when building admin interfaces, management pages, CRUD operations, or dashboard configuration UIs. Triggers include dashboard, admin panel, data management, settings pages.
289wix-cli-embedded-script
Use when adding tracking code, advertising pixels, third-party integrations, popups, banners, or client-side JavaScript to sites. Triggers include embed, inject, script, third-party integration, DOM injection, Google Analytics, Facebook Pixel, tracking pixel, chat widget, popup, coupon popup, custom JavaScript, site script.
289wix-cli-dashboard-modal
Use when adding popup forms, confirmations, or detail views to Wix dashboards; creating reusable dialog components across dashboard pages; showing context-specific information in overlays; opening modals from dashboard pages; or passing data between dashboard pages and modals. Do NOT use for static content (use dashboard pages instead) or site-facing UI (use site widgets/embedded scripts).
289wix-cli-site-widget
Use when building interactive widgets, custom data displays, or configurable site components with settings panels. Triggers include widget, custom element, interactive component, editor component, configurable widget, web component.
289wix-cli-site-component
Use when building React site components with editor manifests for Wix CLI applications. Triggers include site component, editor manifest, custom component, visual customization, editor element, CSS properties, data API, site builder component, Wix Editor component. Use this skill whenever the user wants to create a component that site owners can customize through the Wix Editor's visual interface.
289