Initiating a Workflow via Virtual Assistant
You can trigger any workflow directly through the Virtual Assistant by registering it as a skill. This allows end-users to initiate complex automated processes simply by chatting with the assistant.
Prerequisites
- A published workflow that you want to make available through the Virtual Assistant.
- Access to AI Colleagues > Skills in the admin console.
- Access to the Virtual Assistant interface.
Step 1: Enable Workflow Initiation via Web-hook
Before a workflow can be triggered from the Virtual Assistant, it must be configured to accept initiation via a web-hook. This exposes the workflow as an externally callable endpoint that the Virtual Assistant can invoke on behalf of the user.
Read more on the configuration here.
Once the web-hook is enabled, your workflow is ready to be registered as a skill.
Step 2: Register the Workflow as a Skill
Next, you need to register the webhook-enabled workflow as a Skill so that the Virtual Assistant knows how and when to trigger it.
- Navigate to AI Colleagues > Skills in the admin console.
- Create a new skill and link it to the webhook-enabled workflow you configured in Step 1.
- Define the skill's name, description and positive examples. The description is especially important — the Virtual Assistant uses it to understand when this skill should be invoked based on the user's query.
- Save and publish the skill.
Read more on the configuration here.
Step 3: Trigger the Skill via the Virtual Assistant
With the web-hook enabled and the skill registered, end-users can now initiate the workflow through a natural language conversation with the Virtual Assistant.
- Open the Virtual Assistant chat interface.
- Type a query that matches the intent of the registered skill. For example, if you registered a skill called "Submit Leave Request," a user might type:
"I want to submit a leave request"
- The Virtual Assistant identifies the matching skill, collects any required input parameters through the conversation, and triggers the underlying workflow.
- The workflow executes, and the assistant can relay the result or confirmation back to the user in the chat.
Troubleshooting
- The Virtual Assistant doesn't recognize my query. Make sure the skill description clearly describes the intent it should match. The assistant relies on this description for skill matching.
- The workflow doesn't trigger. Verify that the web-hook is enabled and the workflow is published. Check that the skill is correctly linked to the workflow.
Updated 2 days ago
