Use integration metadata

Integration metadata stores values for one installation, such as a store name or region. Workflows can read those values when they run. Define the allowed fields in the integration before you send values.

1. Open the integration in the MindCloud dashboard and define its Integration Metadata fields.

2. Set test values in the workflow editor when you test a workflow.

3. Supply values when the customer installs the integration, or update an existing installation explicitly.

mindCloud.install({
  integrationId,
  metadata: { storeName: 'North store' }
});

await mindCloud.updateMetadata({
  installationId,
  metadata: { storeName: 'West store' }
});

updateMetadata() uses the end-user token set with setToken(). MindCloud validates each key against the integration's definitions and merges valid values into the installation. Unknown keys, invalid values, or missing required values can reject the whole update. Handle the returned error and show the field that needs correction.

mindCloud.modify({ installationId }) opens the modal. It does not save metadata passed as an option. Use updateMetadata() for an existing installation, or edit metadata in the dashboard's installation list. Metadata is separate from the per-user values used to resolve a credential exchange URL.