Getting Started with the Kanvo API

A practical guide to integrating Kanvo messaging into your own applications.

Prerequisites

Before you begin: - Create a Kanvo account at kanvo.app - Get your API key from the dashboard - Have basic familiarity with REST APIs

Authentication

All API requests require authentication using your API key:

Core Endpoints

List conversations: `` GET /v1/conversations ``

Conversations

List conversations: `` GET /v1/conversations ``

Messages

Send a message: ``bash POST /v1/messages { "conversation_id": "conv_123", "content": "Hello!", "platform": "slack" } ``

Contacts

Create a contact: ``bash POST /v1/contacts { "name": "John Doe", "email": "john@example.com" } ``

Webhooks

Receive real-time notifications when events occur:

Embedding Chat Widgets

``html <iframe src="https://embed.kanvo.app/chat?appId=YOUR_APP_ID" width="400" height="600" frameborder="0" ></iframe> ``

Rate Limits

API requests are rate limited to ensure fair usage: - 100 requests per minute for most endpoints - 1000 messages per hour - Contact us for higher limits

Error Handling

The API returns standard HTTP status codes: - 200 - Success - 400 - Bad request (check your parameters) - 401 - Unauthorized (check your API key) - 429 - Rate limit exceeded - 500 - Server error

Need Help?

Check our API documentation at docs.kanvo.appEmail developer support at kanvo@aw3.techJoin our community for questions and discussions

Kanvo Team

Writes here about what Kanvo is building and why — the send path, the evidence it leaves, and the decisions behind both.

Step-by-step tutorial for embedding messaging functionality into your web application.

Adding Chat to Your App: A Practical Guide