Developer Overview

Connect Chatvox to your own systems with the REST API and webhooks: chat with agents, read leads and conversations, manage knowledge, and get notified of events.

Chatvox gives developers two ways to connect your agents to other systems:

• REST API: your code calls Chatvox. Send messages to an agent, read leads and conversations, and add or remove knowledge.
• Webhooks: Chatvox calls your code. Get a signed POST request when a lead is captured, a visitor asks for a person, or a Helpdesk ticket is opened.

You can also connect both to Zapier, Make, or n8n without writing code. See Zapier, Make, and n8n.

Quick start

curl https://my.chatvox.co/api/v1/agents \
  -H "Authorization: Bearer cvx_your_key"

curl -X POST https://my.chatvox.co/api/v1/agents/AGENT_ID/messages \
  -H "Authorization: Bearer cvx_your_key" \
  -H "Content-Type: application/json" \
  -d '{"message": "What are your opening hours?"}'

Basics

Lists and pagination

List endpoints return the items in data, plus links and meta for paging:

{
  "data": [{ "id": "…", "name": "Support agent", "status": "active", "created_at": "…" }],
  "links": { "first": "…?page=1", "last": "…?page=3", "prev": null, "next": "…?page=2" },
  "meta": { "current_page": 1, "per_page": 25, "total": 61, "last_page": 3 }
}

Single items are returned as a plain object, without a data wrapper.

Endpoints