In this document, you'll learn about the options of the Integration Module. You can pass these options when you register the module as a plugin in medusa-config.ts.

The encryptionKey option is the passphrase the module derives its encryption key from. It encrypts every option marked secret: true (AES-256-GCM) before saving it, and decrypts those values back at runtime.

Set it when you register the module:

medusa-config.ts
1module.exports = defineConfig({
2  // ...
3  plugins: [
4    {
5      resolve: "@gorgo/medusa-integration",
6      options: {
7        encryptionKey: process.env.INTEGRATION_ENCRYPTION_KEY,
8      },
9    },
10  ],
11})

The value can be any non-empty string, though a high-entropy one is best for production, for example the output of openssl rand -hex 32. The module derives the key once, the first time it's needed, and reuses it for every registered integration's secret fields from then on. Without encryptionKey, the module throws the first time it tries to save or read an integration that has at least one secret: true option.

The providers option is an array of Integration Module providers.

When the Medusa application starts, these providers are registered under the Integration Module and their options become configurable in the Admin.

For example:

medusa-config.ts
1module.exports = defineConfig({
2  // ...
3  plugins: [
4    {
5      resolve: "@gorgo/medusa-integration",
6      options: {
7        providers: [
8          {
9            resolve: "@gorgo/medusa-payment-my/providers/integration-my",
10            id: "my-1",
11            options: {},
12          },
13        ],
14      },
15    },
16  ],
17})

The providers option is an array of objects that accept the following properties:

• resolve: A string indicating either the package name of the Integration Module provider or its relative path.
• id: An optional string identifying this particular registration. Omit it for the provider's single, unnamed instance, or set it to register multiple instances of the same provider.
• options: An object of the module provider's own options. For an Integration Module provider, this is almost always {}, since the store admin sets the real configuration in the Admin instead.