Conversational Processes
platform.extensions.conversational-processes
A conversational process is the user-facing flow of a plugin: the slots it collects from the user and the steps it runs, such as actions, branches and replies.
To learn what conversational processes do, see Conversational Processes in the Tool Studio docs.
- Endpoint:
/platform/extensions/conversational-processes| 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: Activities call actions by
id(action_id.http_action,compound_actionorscript_action). Slots of a custom type use the data type’sname. A plugin launches the process throughexecution_config.conversational_plugin_body_config_uuid, which takes the process’sid.
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
- The server sets
signature.namefromsignature.display_name. Don’t send it. conversation_flowis one block:sequential,switch,activity,returnornoop. Don’t put asequentialblock directly inside anothersequentialblock.- A
switchcase can’t have an emptythen; usenoop. textactivity templates use Mustache overdata, for example{{ data.purchase_order.status }}.