What You'll Set Up
By the end of this guide, your AI agent will be able to interact with your Convoso dialer — managing leads, campaigns, and call operations. The entire setup takes about five minutes.
Before You Begin
Make sure you have:
- A Convoso account with admin access
- A Pipeworks workspace — Sign up at pipeworks.ai if you haven't already
Steps
Get your Convoso API auth token
Log into your Convoso admin panel. Navigate to your account or API settings to locate your API auth token. This token is what Pipeworks uses to authenticate requests to your Convoso account.
Open your Pipeworks console
Log into your Pipeworks workspace and go to the Integrations page. Find Convoso in the list and click on it.
Enter your credentials
Paste your Convoso API auth token into the Auth Token field and click Connect.
Pipeworks encrypts your token with AES-256-GCM before storing it. The plaintext token is never saved to disk and is only decrypted when your integration container starts.
Start the integration
Click Start to launch the Convoso integration container. This takes a few seconds. Once the status shows Running, your agent is ready to use Convoso tools.
Test the connection
Use the Test button in your Pipeworks console to verify the connection. This sends a simple API call to Convoso to confirm your token works.
What Your Agent Can Do
Once connected, your AI agent has access to Convoso tools for:
- Leads — Search, create, and manage leads in your dialer
- Campaigns — View and manage dialer campaigns
- Call operations — Monitor and interact with call activity
Use tool profiles to control what your agent can do. Set the profile to read-only if you only want your agent to retrieve data, not modify anything.
Connecting from Your AI Agent
Add the Pipeworks tools endpoint to your agent's configuration. Here's an example for Claude Desktop:
{
"mcpServers": {
"pipeworks-convoso": {
"command": "npx",
"args": ["-y", "mcp-remote", "https://app.pipeworks.ai/tools/convoso"]
}
}
}
Claude Desktop will prompt you to sign in through Pipeworks when you first connect. No access key needed.
Troubleshooting
Connection test fails? Double-check that you copied the full API auth token from Convoso.
Container won't start? Make sure your integration is enabled. An admin needs to assign the Convoso integration to your workspace first.
Agent can't find tools? Verify your Pipeworks session is authenticated and that the integration status shows "Running" in your Pipeworks console.