Integration Metadata

Prev Next

If you want each installation to have custom values passed to the SDK, follow the steps below to add and manage integration metadata.

1. Configure Integration Metadata

  1. Go to the Embedded tab in your dashboard.

  2. Select your integration.

  3. See the Integration Metadata section.

Here, you can add metadata fields that will be passed through the SDK.

Note: Each field’s key will automatically be converted to camelCase. Meaning a field with name “Test String” will have key testString.

2. Define Test Metadata for Workflows

To test your metadata values during workflow development:

  1. Open the Workflow screen.

  2. Under the Properties tab, go to the Variables section.

  3. Edit the Test Metadata Values as needed.

While editing the workflow, any input will automatically include these metadata values for testing purposes.

3. Pass Metadata via the SDK

On your platform, when using the Embedded SDK, add the metadata field to the .install() and .modify() methods.

Example

mindCloud.install({ integrationId: 'int_123', metadata: { testString: 'some string', testFlag: true } });
mindCloud.modify({ installation: 'install_123', metadata: { testString: 'some string', testFlag: true } }); 

Your workflows will now run with the custom metadata values you’ve defined for each installation.