What is the Integration Module?

The Integration Module lets any plugin declare its options, and store admins configure them as integrations right in the Admin – no medusa-config edits, no redeploys. The module takes care of the UI, storage, encryption, and validation.

The Integration Module is useful for any Medusa developer building plugins, providers, or custom modules that need configurable settings, such as API keys, credentials, modes, or webhooks, but who'd rather not hand-build settings UI pages, a data layer, and validation for each one.

Features

• Settings management in Admin: Set in the Settings → Integrations section, no medusa-config/env edits and no redeploys.
• Any plugin, provider, or module: Works across payment, fulfillment, ERP, notification, content, and other extensions.
• Declarative descriptor (defineIntegration): A single description of the options, settings sections, validation, and connection test.
• Flexible typing and validation: Typed fields (string, url, email, uuid, number, boolean, enum, json) with per-option and cross-section rules, conditional visibility, and read-only fields. At runtime, the plugin gets a typed, decrypted object: incomplete or disabled settings never resolve, so an unfilled draft is never returned.
• Encrypted secrets: Fields marked secret are encrypted (AES-256-GCM) and never reach the browser.
• Multiple instances: The same provider can be configured more than once. For example, for several accounts in the same third-party service.
• Connection test: Verify credentials against the third-party service right from the Admin.
• Extensible UI: Sections can be reordered (LayoutComposer). If the generated sections aren't enough, you can implement any UI for your options using custom widgets.
• Integration catalog: Available integrations are shown in the Admin, and any plugin appears there on equal footing with the built-in ones.

Available Integrations

Any plugin can use the Integration Module, see the documentation.

💬 Support & Community

Got questions or ideas? Join the Telegram support chat — @gorgojs_chat

Connect with other Medusa developers on Telegram — @medusajs_chat

Requirements

• Medusa v2.17.2 or later
• Node.js v20 or later

Installation

yarn add @gorgo/medusa-integration
# or
npm install @gorgo/medusa-integration

Documentation

The complete installation, configuration, and usage guide is available on the Gorgo documentation website.

License

Licensed under the MIT License.