Plugins
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
resourcewrapper. The item’sidgoes 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
idinexecution_config.conversational_plugin_body_config_uuid. A system plugin takes an actionidinexecution_config.system_plugin_body_config.action_id, and a listener’sidin each event subscription’slistener_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.
Rules the API checks
- Use
custom_triggering_config(conversational) orsystem_triggering_config(system), not both. - A conversational plugin needs at least 5
positive_triggering_examplesand alaunch_config.user_allow_list_configwith exactly one ofallow_all,allow_emails,block_emailsorallowlist_rule. - A system plugin has exactly one trigger: one event subscription, one schedule or one built-in trigger.
- To pilot a plugin, set
allow_emailsto the people testing it, then update it to{"allow_all": true}.