Skip to main content

Workflow Plugins - Custom Nodes


Workflow plugins let you package commonly used data processing logic into custom workflow nodes that organization members can use directly in their workflows.

Within a plugin, you can combine nodes such as Branch, AIGC, Send API Request, Code Block, and JSON Parsing to turn complex data processing operations into simple, reusable custom nodes.

Once developed, a plugin can be published for use within your organization. Published plugins can also be exported as files and imported into or used to upgrade plugins in other organizations.

Example Scenario​

When integrating external APIs into workflows, data often needs to be encrypted using different methods. Previously, users had to write their own code in a Code Block node, which was inconvenient and difficult for those without programming experience.

With a workflow plugin, you can create a custom node that lets users select an encryption method (MD5, SHA-1, SHA-256, or HMAC) and apply it to the input data.

The custom node can then be made available to everyone in the organization.

Create a Workflow Plugin​

Open the Plugin Editor​

Go to Plugin Center > Workflow Node and click Create Plugin to get started.

Configure the Node Name, Icon, and Description​

Enter a name, select an icon, and add a description for the custom node.

The description is displayed when users work with the node in a workflow.

Configure Input Parameters​

Define the input parameters for the custom node.

You can also configure option-based inputs, checkbox inputs, and group headings to organize the input interface and make it easier for users to provide the required information.

Configure Data Processing Steps​

In the data processing section, add and configure the nodes required to process the input data.

Configure Output Parameters​

Add output parameters and map their values to the outputs of the data processing nodes.

Publish and Test​

Click Publish in the upper-right corner to publish the plugin.

Once published, the custom node appears under the Plugins category when adding nodes to a workflow. You can then use and test it in your own workflows.

Publish to the Organization​

After testing the custom node and confirming that it works as expected, publish the plugin to your organization from Plugin Center.

Once published to the organization, the custom node becomes available to all organization members.

Manage Plugins​

Under Created by Me, you can manage plugins you have created, including editing, deleting, and publishing new versions.

Click a plugin's name to update its name, icon, and other basic information. Click Edit to modify its data processing steps and input and output parameters.

After making changes, you can publish a new version.

The latest version is not necessarily the version currently published for use. You can select any version and click Set as Current Version.

Export Plugins​

Published workflow plugins can be exported as plugin files for importing into or upgrading plugins in other organizations.

To export a plugin: Select the published version you want to export and click Export. The plugin is exported as a .mdye file.

Configure Export Authorization

When exporting a plugin, you can enable Verify Authorization Key on Import to configure authorization requirements for importing the plugin.

  • Authorization Key: Required. The system generates a random eight-character key containing letters and numbers.
  • Expiration Date: Specify how long the authorization remains valid. If no expiration date is set, the authorization remains valid indefinitely.
  • Allowed Organizations: Specify which organizations are allowed to import the plugin. If none are specified, any organization can import it.

When authorization verification is enabled, importing the plugin requires successful validation of the authorization key, expiration date, and allowed organization.

Export History​

After exporting a plugin, you can download the exported file from Export History.

If authorization requirements were configured during export, you can also view the corresponding authorization key and expiration date.

Import or Upgrade Plugins​

In Plugin Center, open the Organization plugin list and click Import to upload a .mdye plugin file.

HAP checks the plugin's source ID to determine whether a plugin from the same source already exists in the current organization:

  • No matching source plugin exists: The plugin is imported as a new plugin.

  • A matching source plugin exists: You can choose to create a new plugin or overwrite and update the existing plugin.

    Select Overwrite and Update to upgrade the existing plugin using the version included in the imported file.

Once imported, the plugin appears in the organization's workflow plugin list.

Was this document helpful?