Unlocking the Power of CallHub: A Comprehensive API Overview

Want to automate campaigns, sync contacts, or build a custom integration against CallHub? Here's what the API can do and how to authenticate your first request.

Before you start

• Access: your CallHub account and its Settings page.
• Time: a couple of minutes to get your key and make your first authenticated request.

Authenticate your requests

1. Log in to CallHub and click your profile name.
2. Go to Settings, then open the API Key tab under General. Your account's API endpoint is listed in the same place.
3. Copy your API key.
4. Include it as an Authorization header on every request: Authorization: Token {your_api_key}, replacing {your_api_key} with your actual key.

What you can do with the API

• Call Center campaign management: create, retrieve, update, and delete campaigns. Add agents, assign them to campaigns, and monitor their activity.
• Contact and contact list management: add, retrieve, update, and delete contacts, organize them into contact lists, and define custom fields to fit your data.
• Webhooks: get real-time notifications for account events, including vb.transfer (a voice broadcast transfer digit is pressed), sb.reply (a text reply is received), cc.notes (a call center agent adds a note), and agent.activation (an agent activates their account). See the CallHub Webhooks Documentation for setup.
• Analytics: pull performance metrics like call center reach and agent shifts to monitor and improve your campaigns.

Notes & limits

ⓘ Sample code is available in cURL, Python, C, C#, C++, and several other languages in the Developer Portal, so you don't have to start from a blank request.

FAQs

Where do I find my API key? 
Click your profile name, go to Settings, then open the API Key tab under General. See Where to find my API key.

How do I authenticate a request? 
Include an Authorization: Token {your_api_key} header, replacing the placeholder with your actual key.

Can I get notified in real time when something happens in my account? 
Yes. Set up a webhook for events like vb.transfer, sb.reply, cc.notes, or agent.activation.

Where's the full API reference and sample code? 
The CallHub Developer Portal.