Introduction
This documentation covers the integration of Voiceflow with Convocore. Learn how to connect your Voiceflow projects, access analytics, and leverage templates and library components for better performance.Prerequisites
- Voiceflow account and access to your project dashboard.
- A Voiceflow project API key (
VF.DM...) or a personal access token (vfp_...). - The Voiceflow Project ID. Required when you use a personal access token.
- Access to the Convocore platform.
Connecting the Voiceflow Agent
Step 1: Gather Required Information
- Log in to your Voiceflow account.
- Copy a project API key (
VF.DM...) from the project, or a personal access token (vfp_...) from Settings → Access tokens. - Copy the Project ID from Settings → General → Metadata. See
Authentication for Project ID vs
Version ID and how to create a
vfp_...token.
Step 2: Configure in Convocore
- Open the agent in Convocore and go to Settings → Integrations.
- Turn on Voiceflow Integration.
- Paste the
VF.DM...key orvfp_...token, plus the Project ID. - Set the environment alias (
production,development, ormain) and save.
Personal access tokens need a Project ID. New Voiceflow projects usually use the
main environment alias. Older canvas projects use production or development.Voiceflow Analytics
Accessing Analytics
- Go to your Convocore agent dashboard.
- Navigate to the Analytics section.
Key Metrics Explained
- Total Interactions: Total number of interactions your users have had with the agent.
- Total Conversations: Number of total conversations your AI agent has had across all platforms.
- User Retention: Total messages exchanged before the user leaves the conversation.
- Top Intents: Most triggered intents on your agent, showing the most common actions users take.
- Time Retention: Seconds users have spent interacting with the agent.
Voiceflow Template
Where to Find the Template
Importing the Template
- Download the Voiceflow template file.
- Go to your Voiceflow creator page.
- Import the template using the Import option.
Using Library Components
Overview
Library components in the Voiceflow template are pre-built, reusable tools designed to simplify and enhance your conversational flow creation. They help you save time, ensure consistency, and provide advanced functionality without starting from scratch.Step-by-Step Guide
1. Locate Components in the Voiceflow Template
- Open the Voiceflow template in your Voiceflow creator.
- Navigate to the Library section to view the available components.
2. Drag and Drop
- Select the desired component and drag it into your conversation flow.
If you’re not importing the whole template into your flow and just a single component,
make sure to create the variables and intents needed for that component so nothing
breaks.
3. Customize
- Modify the component’s settings to suit your agent’s requirements, such as adding specific intents, API endpoints, or fallback messages.
4. Test Your Flow
- Use Voiceflow’s testing environment to simulate interactions and ensure the components work as expected.