API Reference

Integrate CrispChat programmatically with our RESTful API. Build custom integrations, automate workflows, and extend functionality.

What's Coming

We're building a comprehensive API that will allow developers to:

Conversations API

Retrieve chat history, send messages programmatically, and manage conversations.

Visitors API

Access visitor data, session information, and engagement metrics.

Webhooks

Receive real-time notifications for new messages, visitor events, and more.

Analytics API

Export analytics data, generate reports, and integrate with your BI tools.

API Preview

Here's a preview of what the API will look like:

// Get all conversations
GET /api/v1/conversations

// Get a specific conversation
GET /api/v1/conversations/:id

// Send a message
POST /api/v1/conversations/:id/messages
{
  "content": "Hello! How can I help you?",
  "type": "text"
}

// Get visitor information
GET /api/v1/visitors/:id

// List all leads
GET /api/v1/leads

Authentication

The API will use API keys for authentication:

curl -X GET "https://api.crispchat.app/v1/conversations" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"