Skip to navigation

Plugins

View as Markdown

platform.extensions.plugins

A plugin is what the assistant runs. A conversational plugin is triggered by what users say and launches a conversational process. A system plugin is triggered by a webhook listener, a schedule or a built-in event, and runs an action.

To learn what plugins do, see Plugins in the Tool Studio docs.

  • Endpoint: /platform/extensions/plugins | Methods: GET, PATCH, POST
  • Request shape: fields go at the top level of the JSON body, with no resource wrapper. The item’s id goes in the URL for reads and updates, not in the body.
  • Updates: a JSON merge-patch with version: {num, change_description} from your last read. Lists of objects merge row by row, so read first and send the whole list when you remove or reorder rows. See Tool Studio.
  • References: A conversational plugin takes the process’s id in execution_config.conversational_plugin_body_config_uuid. A system plugin takes an action id in execution_config.system_plugin_body_config.action_id, and a listener’s id in each event subscription’s listener_id.

Endpoints

All paths are relative to https://api.moveworks.ai/configurations/v1alpha1. Each endpoint page lists the request and response schema, an example, and the errors it can return.

MethodPathEndpoint reference
GET/platform/extensions/pluginsList plugins
POST/platform/extensions/pluginsCreate plugin
GET/platform/extensions/plugins/{id}Get plugin
PATCH/platform/extensions/plugins/{id}Update plugin

Rules the API checks

  • Use custom_triggering_config (conversational) or system_triggering_config (system), not both.
  • A conversational plugin needs at least 5 positive_triggering_examples and a launch_config.user_allow_list_config with exactly one of allow_all, allow_emails, block_emails or allowlist_rule.
  • A system plugin has exactly one trigger: one event subscription, one schedule or one built-in trigger.
  • To pilot a plugin, set allow_emails to the people testing it, then update it to {"allow_all": true}.

Fields

FieldTypeRequiredNotes
basic_infoUseCaseBasicInfo✅Name and description of the plugin, as shown to users.
launch_configUseCaseLaunchConfigWho can use the plugin, whether analytics are enabled, and how logs are redacted. If omitted, analytics are disabled and standard log redaction is used.
triggering_configUseCaseTriggeringConfig✅What triggers the plugin. Set exactly one of custom_triggering_config or system_triggering_config.
execution_configUseCaseExecutionConfig✅What the plugin runs. Must match the trigger: conversational triggers run a conversational process; system triggers run an action.
idstringread-onlyUnique identifier of the plugin, assigned by the server.
updated_timestringread-onlyWhen the configuration was last updated.
updated_bystringread-onlyWho last updated the configuration.
versionVersion✅Document version. On update, send back the num from your last read.

Example create body

{
"basic_info": {
"name": "Purchase Order Lookup",
"description": "Looks up a purchase order and reports its status."
},
"launch_config": {
"user_allow_list_config": {
"allow_emails": {
"values": [
"jordan.lee@example.com"
]
}
},
"enable_analytics": true
},
"triggering_config": {
"custom_triggering_config": {
"positive_triggering_examples": [
"where is my purchase order",
"check the status of PO-1024",
"has my PO been approved yet",
"look up purchase order PO-2231",
"what happened to my purchase order"
],
"negative_triggering_examples": [
"create a new purchase order",
"cancel my purchase order",
"list all purchase orders for my team"
]
}
},
"execution_config": {
"conversational_plugin_body_config_uuid": "0f36c4e2-9a0f-4d21-8e0e-3a9c2f6b1d77"
},
"version": {
"change_description": "Initial version."
}
}