Skip to main content

executePlugin()

Last updated 13/07/2021

The executePlugin() is a function that executes a plugin by its Plugin ID on the Five Server. Plugins allow you to extend Five's functionality and can be written in any coding language.

Available
Server


Function Signature
executePlugin(PluginID, Context) : PluginResult;


ParameterTypeDefaultDescription
PluginIDstringPlugin ID for the Plugin.
ContextstringnullOptional string of data to be sent to the plugin.


PluginID must be the Plugin ID of the plugin you wish to execute.

Context is an optional string containing data the plugin can understand. Common formats are JSON, YAML, etc.

Example

executePlugin()