ConverseIQ API Reference

API reference for ConverseIQ REST and Webhook endpoints. Base URL: https://converseiq.devblocktechnologies.com

Live API Playground

Test ConverseIQ endpoints. API keys are per-business — use your business API key.

REST API Overview

ConverseIQ provides a RESTful API for managing messages, agents, channels, and webhooks. All requests require authentication via Bearer token.

Authorization: Bearer sk-converseiq-your-api-key

Webhook Endpoints

POST/api/webhooks/whatsapp

Webhook endpoint for WhatsApp Cloud API incoming messages. Configure this URL in your WhatsApp Business Account webhook settings.

POST/api/webhooks/telegram

Webhook endpoint for Telegram Bot API updates. Configure this as your bot's webhook URL.

POST/api/webhooks/discord

Webhook endpoint for Discord interaction callbacks.

POST/api/webhooks/slack

Webhook endpoint for Slack Events API and slash commands.

Message Sending Endpoints

POST/api/messages

Send a message through a specified channel.

Request Body

{
  "channel": "whatsapp" | "telegram" | "discord" | "slack",
  "recipient": "string",
  "message": "string",
  "agent_id": "string (optional)"
}
GET/api/messages/:messageId

Retrieve the status and details of a sent message.

Agent Management Endpoints

GET/api/agents

List all configured agents for your account.

POST/api/agents

Create a new agent with specified configuration.

PUT/api/agents/:agentId

Update an existing agent's configuration.

DELETE/api/agents/:agentId

Delete an agent and its associated data.