API Reference

The Convor public API is served from the following production base URL:

https://api.convor.io

All documented paths already include the /api prefix. Authenticate with an organization API key and review the authentication guide before sending requests.

Resources

• Conversations — Conversation management
• Conversation Tags — Tagging and labeling conversations
• Messages — Message management
• Attachments — Private file attachments linked to customer conversations
• Visitors — Visitor management
• Tracking — Visitor tracking and analytics
• Operators — Operator management
• Operator Teams — Operator team membership and routing groups
• Triggers — Proactive message triggers
• Automation Rules — Event-driven automation rules for conversation workflows
• Canned Responses — Predefined message templates
• Surveys — CSAT ratings and post-chat surveys
• Departments — Support departments and operator membership
• Tag Definitions — Reusable organization tag definitions
• Custom Fields — Custom conversation and visitor data fields
• Knowledge Base — Knowledge-base articles, categories, collections, and search
• Scheduling — Appointment availability and booking management
• Webhooks — Outgoing webhook management
• Search — Full-text search across conversations and messages
• Export — Data export in CSV and JSON formats
• GDPR — GDPR data management
• SLA — Service Level Agreement management
• Routing — Conversation routing rules
• Analytics — Dashboard analytics and reporting

Common API behavior

• Authentication and API-key scopes
• Errors, pagination, idempotency, and versioning
• Rate limits
• Webhooks and signature verification