Documentation
Browse the public documentation by section or search all available guides and reference pages.
Api Reference
248Creates an organization analytics export for selected metric sections.
Returns AI support performance for the selected date range.
Returns the top-level analytics overview for the selected range, including total conversations, active conversations, average response time, and CSAT score with change indicators.
Returns aggregate, approximate city-level locations for visitors in one country during the selected analytics period.
Returns average CSAT ratings grouped by first-response-time buckets for rated conversations in the selected range.
Calculates the time from the first visitor message to the first operator reply for conversations in the selected range.
Returns the average first-response time per day for the selected date range.
Returns conversation totals per tag together with the average CSAT rating for tagged conversations in the selected range.
Shows how conversation volume and close rate are distributed across priorities for the selected date range.
Returns how many conversations came from each channel during the selected date range.
Returns the latest successful unified AI analysis for each conversation in the selected period.
Groups conversations into a 7×24 grid (day-of-week × hour) so workforce planners can schedule shifts to match demand.
Groups conversations by the hour they were created so teams can see when traffic is highest.
Groups conversation starts by hour of day for the selected time window.
Returns the CSAT response rate for each conversation channel in the selected date range.
Returns one row per day showing how many AI-handled conversations were fully resolved by AI compared with all AI-touched conversations in the selected range.
Returns daily conversation totals for the selected range together with how many of those conversations are resolved.
Returns daily conversation counts for the selected date range.
Returns SLA breach totals for the selected date range together with a daily trend, per-metric counts, and per-policy totals.
Summarizes how active open and pending conversations are distributed across assigned operators in the selected range.
Measures conversations created outside business hours, defined here as 09:00 through 16:59 server time.
Returns a dashboard-ready list of operator performance metrics for the selected time window.
Lists operator performance for the selected date range, including conversations handled and average first-response time.
Returns plan-usage counters for the current organization, including operator seats, conversation usage, and AI credits compared with the active plan limits.
Returns a live queue snapshot for open or pending conversations that are still unassigned.
Returns a live dashboard snapshot covering visitors active in the last 5 minutes, open or pending conversations, operators marked online, and the most common current pages and visitor countries.
Returns SLA breach counts, adherence metrics, and per-operator bottleneck analysis for the selected project scope.
Returns the share of conversations in the selected range that were abandoned.
Returns the main analytics datasets for the selected date range in one response: conversation volume, response-time trends, operator performance, visitor sources, and plan-usage counters.
Returns the top visitor referrers for the selected date range.
Returns visitor acquisition and browsing metrics for the selected range, which defaults to the last 30 days.
Returns UTM source, medium, and campaign breakdowns for the selected date range.
Dashboard analytics and reporting
Returns live workload and capacity for operators in the current organization.
Polls one asynchronous analytics PDF export.
Deletes one private attachment only when it belongs to the path conversation and authenticated organization.
Returns an access-controlled download URL for one private attachment.
Returns private attachment metadata and an access-controlled download URL.
Private file attachments linked to customer conversations
Streams an attachment only after rechecking the current conversation, mailbox access, visitor identity and storage lifecycle.
Uploads one private file to a conversation as multipart/form-data using the file field.
Append a rule to the project order with an optional reply and any supported actions.
Permanently delete the selected project rule and its localized replies.
Event-driven automation rules for conversation workflows
List connected provider accounts owned by the selected organization and project.
Read the ordered rules and localized replies for the selected project.
Evaluate unsaved conditions, channel and account availability, schedule and reply cooldown using the runtime rule planner.
Read the project inactivity-close setting and localized close messages.
Set the complete rule order atomically for the selected project.
Enable or disable the selected project rule without changing its order.
Update a rule in the selected project.
Replace the inactivity-close setting and localized close messages for the selected project.
Creates a category for grouping canned responses in the authenticated organization.
Creates a reusable response in a category owned by the authenticated organization.
Permanently deletes a canned-response category.
Permanently deletes a canned response together with its translations and shortcuts.
Predefined message templates
Returns a paginated list of canned responses resolved for the requested locale.
Returns every canned-response category in the authenticated organization, resolved for the requested locale and ordered by sort position.
Increments a canned response's usage count and updates its last-used timestamp.
Applies explicit sort positions to up to 500 canned responses in one transaction.
Partially updates a canned-response category's key, sort order, or localized names.
Partially updates a canned response in the authenticated organization.
Adds one or more tags to a conversation and returns the updated tag list.
Tagging and labeling conversations
Returns the tags assigned to a conversation in the authenticated organization.
Returns the distinct tag names used in the authenticated organization's conversations, together with saved color definitions for tag pickers and autocomplete fields.
Removes a tag from a conversation.
Archives one conversation by setting its archivedAt timestamp.
Assigns one conversation to a specific operator in the current organization.
Assigns up to 100 conversations to one operator.
Closes up to 100 conversations in one request.
Soft-deletes up to 100 conversations and marks their messages as deleted.
Removes the stored follow-up reminder fields from the conversation metadata and keeps all other metadata keys unchanged.
Closes one conversation in the current organization.
Starts a new conversation for an existing visitor in the current organization.
Soft-deletes one conversation in the current organization.
Exports one conversation transcript from the authenticated organization.
Returns one conversation from the current organization, including the joined visitor record and computed dashboard fields such as unreadCount, tags, messageCount, and firstResponseTimeMs.
Returns assignment-related audit events for one conversation in chronological order.
Returns a merged chronological feed of messages, internal notes, tag changes, transfers, CSAT responses, and audit log entries for a conversation.
Conversation management
Adds another conversation ID to metadata.linkedConversationIds for the source conversation.
Returns paginated conversations for the current organization.
Returns messages, visitor page views, internal notes, tag changes, transfers, CSAT responses, and audit entries in one deterministic newest-first cursor-paginated stream.
Merges two conversations from the same visitor into a single thread.
Sets a manual visitor-language override for one conversation.
Checks the state of a PDF export job that was created by GET /api/conversations/{id}/export?format=pdf.
Removes a related conversation ID from metadata.linkedConversationIds for the source conversation.
Reopens a closed conversation in the current organization.
Stores a follow-up reminder in the conversation metadata so operators can revisit the conversation later.
Searches conversation messages by content and falls back to a case-insensitive match when no ranked results are found.
Emails the transcript of one conversation to the requested address.
Sets a stable locale for future visitor-facing messages in one conversation.
Snoozes one conversation until a future ISO timestamp.
Clears the archivedAt timestamp and returns the conversation to the default list tabs.
Clears the operator assignment for one conversation in the current organization.
Clears the snoozedUntil timestamp and makes the conversation active again.
Updates mutable conversation fields such as status, priority, assigned operator, and metadata.
Creates a custom field definition for conversations or visitors in the authenticated organization.
Permanently deletes a custom field definition, including its localized labels and select options.
Custom conversation and visitor data fields
Returns every organization-owned custom field definition resolved for the requested locale.
Merges validated values into a conversation's metadata.customFields object.
Partially updates a custom field definition.
Adds an operator to a department in the authenticated organization.
Creates a department in the authenticated organization.
Deletes a department from the authenticated organization.
Support departments and operator membership
Lists all-project departments and reusable definitions explicitly bound to the selected project.
Returns every operator assigned to a department in the authenticated organization.
Removes an operator from a department in the authenticated organization.
Partially updates a department in the authenticated organization.
Streams conversations with filters as CSV or JSON, including operator names and flattened message content.
Exports analytics for the active site or authorized All-sites scope as CSV.
Streams conversations from the active site or authorized All-sites scope as CSV or JSON, including project attribution and flattened message content.
Streams a full JSON archive of conversations and messages for the active site or authorized All-sites scope.
Exports visitors for the active site or authorized All-sites scope as CSV, including project attribution.
Data export in CSV and JSON formats
Exports the complete project-scoped dataset associated with a visitor as a JSON attachment.
GDPR data management
Explore the customer-supported Convor REST API resources and endpoint contracts.
Creates a knowledge-base article with localized lifecycle variants, optional category and owner assignments, and stable tags.
Creates a knowledge-base category with a stable key, icon, sort position, and localized lifecycle variants.
Permanently deletes a knowledge-base category and clears that category from its articles.
Returns one article by UUID, including content resolved for the requested locale and the complete translation set used by the dashboard editor.
Knowledge-base articles, categories, collections, and search
Returns a paginated category collection resolved for the requested locale, with the number of published articles in each category.
Returns a paginated list of knowledge-base articles resolved for the requested locale.
Returns all knowledge-base categories for the authenticated organization, resolved for the requested locale.
Soft-deletes a knowledge-base article.
Partially updates a knowledge-base article.
Partially updates a category's key, icon, sort order, or supplied locale variants.
Adds or toggles a reaction through one channel-agnostic conversation endpoint.
Cancels a pending scheduled message in the authenticated organization and path conversation.
Soft-deletes one non-deleted message in a conversation.
Deletes one internal note from the current organization.
Updates the content of one non-deleted message and returns the full message.
Returns one message from a conversation in the current organization.
Message management
Returns up to 200 internal notes for one conversation in the current organization, ordered from newest to oldest.
Returns up to the 20 most recent stored versions of one message.
Returns messages for one conversation using cursor-based pagination.
Returns pending scheduled messages for a conversation in the authenticated organization, including each message's ID, content, type, and delivery time.
Returns reactions for one message, grouped by emoji.
Removes the authenticated user's or organization API key's reaction for one emoji from a non-deleted message.
Creates a message with a scheduled delivery time.
Adds a message to an existing conversation.
Adds an operator to the specified team within the current organization.
Creates a new operator team in the current organization with a name, optional description, routing priority, and project binding scope.
Permanently deletes an operator team within the current organization, including its member assignments and project bindings.
Operator team membership and routing groups
Returns every operator team in the current organization, ordered by priority, together with the projects each team is bound to.
Returns the operators assigned to the specified team within the current organization.
Removes an operator from a team in the authenticated organization.
Updates the availability status for multiple operators in the current organization.
Creates an unlinked operator record in the authenticated organization.
Returns an operator's canonical seven-day recurring availability schedule and timezone, including split and overnight ranges.
Returns performance statistics for an operator in the authenticated organization.
Returns a ranked leaderboard of operators in the current organization.
Operator management
Invites a user to the authenticated organization as an operator, admin, or viewer.
Lists operators in the authenticated organization together with their profile, presence status, and active conversation counts.
Removes an operator from the authenticated organization.
Updates an operator's seven-day recurring availability schedule and optional timezone.
Partially updates an operator's assignment settings in the authenticated organization.
Updates an operator's presence status in the authenticated organization.
Creates a routing rule for the current organization.
Deletes a routing rule from the current project.
Conversation routing rules
Returns routing rules for the current project in the order they are evaluated.
Runs routing immediately for one conversation in the current project.
Returns the routing result for one conversation without changing the actual assignment.
Switches a routing rule between enabled and disabled without changing any other fields.
Updates an existing routing rule in the current project.
Cancels a confirmed booking, releases its slot, and clears any reminder claim.
Creates a booking in confirmed status.
Returns future 30-minute slots for the requested date, from 09:00 through 16:30 in the selected timezone.
Appointment availability and booking management
Returns every booking linked to the required conversationId, including confirmed, cancelled, completed, and no_show bookings.
Returns confirmed bookings for the required date, ordered by local timeSlot.
Moves a confirmed booking to a new future 30-minute slot without changing its ID or conversation link.
Records the final outcome of a confirmed booking.
Full-text search across conversations and messages
Searches conversations in the active site or authorized All-sites scope by matching message text.
Searches messages inside one conversation in the active site or authorized All-sites scope.
Marks an SLA breach as acknowledged and records the user or API key that performed the action.
Creates an SLA policy for the authenticated organization.
Deletes an SLA policy from the authenticated organization.
Returns the SLA status for one conversation in the selected project.
Returns an aggregate SLA overview for up to the 500 most recently active open conversations in the selected project.
Service Level Agreement management
Returns recent SLA breaches for the selected project or the caller's explicit all-project scope.
Returns the selected project's SLA policies with server-side name search, state filter, deterministic sort and pagination.
Marks an SLA breach as resolved, records the user or API key that performed the action, and sets the resolution timestamp.
Partially updates an SLA policy in the authenticated organization.
Soft-deletes a survey response by setting isActive to false; the record remains stored.
Returns CSAT summary metrics for the current organization over the selected period.
Returns the average rating, total rating count, and 1-to-3 rating distribution for an operator in the authenticated organization.
Returns the CSAT survey configuration for the selected project.
CSAT ratings and post-chat surveys
Lists CSAT responses for the current organization, sorted newest first.
Lists survey responses for the authenticated organization, newest first, using offset pagination.
Corrects an existing survey response in the authenticated organization.
Updates CSAT survey settings for the organization.
Creates a reusable tag definition for the current organization.
Permanently deletes a tag definition from the authenticated organization.
Reusable organization tag definitions
Lists tag definitions available to the current project.
Updates the name, color, or both for one tag definition in the current organization.
Returns tracked page history for one visitor in the current organization.
Returns aggregate visitor statistics for the current organization.
Visitor tracking and analytics
Creates a proactive chat trigger for the authenticated organization.
Permanently deletes a trigger and all of its localized variants.
Proactive message triggers
Returns proactive triggers for the authenticated organization, newest first.
Partially updates a trigger in the authenticated organization.
Appends an internal note to the visitor metadata.
Adds one tag to the visitor metadata.
Anonymizes a visitor's PII (identifier, fingerprint, geo data, metadata) in compliance with GDPR Article 17.
Adds or removes a tag, or blocks or unblocks up to 100 visitors from the current organization in one transactional operation.
Creates or updates a ban record for the visitor and also marks the visitor metadata as blocked.
Marks the visitor as blocked in metadata and also creates a project-scoped visitor ban record.
Returns whether the visitor has an active ban record and includes the ban details when present.
Deletes a visitor note by note ID from the visitor metadata and returns a success flag.
Updates the text of one existing visitor note and keeps its other note fields, including pin state and author metadata, unchanged.
Streams up to 1000 visitors as a CSV file using the same filtering options as the visitor list route.
Returns the visitor's page history and time spent on each page.
Returns the full visitor record, including browser details, page history, and selected metadata-derived fields.
Returns visitor totals, online visitor count, new-versus-returning counts, and top countries for the requested period.
Visitor management
Lists visitors for the current organization with pagination and optional filters for search, status, tags, blocked state, visit counts, and last-seen range.
Atomically reassigns conversations, visitor messages, surveys, CSAT responses, and pending outbox records from one or more source visitors to the target.
Pins or unpins one visitor note inside the visitor metadata.
Removes one tag from the visitor metadata if it exists.
Removes the visitor ban record and clears the blocked metadata flags for the visitor.
Clears the blocked visitor metadata and removes any matching visitor ban record for the current organization.
Partially updates operator-managed visitor contact details.
Deletes an outbound webhook from the authenticated organization and stops future deliveries immediately.
Outgoing webhook management
Returns recent delivery attempts for one webhook, ordered from newest to oldest.
Returns the event names you can subscribe to when creating or updating an outbound webhook, with a short description and the editable data fields used to construct canonical test deliveries.
Returns organization-scoped outbound webhooks with server-side URL search, event and site-binding filters, deterministic sort, and paginated results.
Registers an HTTPS URL at a public IP to receive event notifications.
Queues a new attempt for a previously failed webhook delivery.
Generates a new signing secret for one webhook and returns the new plaintext value once.
Sends a canonical test event to the webhook URL and reports the delivery status and remote response.
Api
6Authenticate server-to-server requests with an organization API key and restrict each integration with resource read/write scopes.
Read Convor rate-limit response headers and implement bounded retries without relying on obsolete plan-wide request tables.
Use Convor realtime through the hosted widget, dashboard, browser events, and outbound webhooks.
Use the Convor REST API safely with the correct base URL, response shapes, pagination models, error envelope, and retry rules.
Receive signed Convor event deliveries, verify the raw request body, deduplicate retries, and distinguish customer webhooks from provider callbacks.
Understand the public widget key, browser session boundary, allowed domains, and verified customer identity.
Dashboard
4The analytics dashboard provides real-time insights into your support operations. Track conversation volume, response times, customer satisfaction, and operator
Manage your Convor plan, usage, add-ons, payment details, and invoice history from the top-level Billing area.
The conversations view is the central hub for your support team. It shows all active, pending, and resolved conversations in a unified inbox.
Manage operators, roles, live status, weekly availability, and routing-related team settings from the top-level Team area.
Dev
2Developer
1Features
12Track every significant action across your organization with filterable, paginated audit logs for compliance and debugging.
Set up replies and workflow actions from one Rules screen.
Create reusable reply templates with shortcuts and categories for faster operator responses.
Prepared chatbot replies are now part of the Rules editor.
Export conversations, analytics summaries, and visitor data as CSV or JSON files for backup and reporting.
Export and delete personal data to comply with GDPR right to portability and right to erasure requirements.
Publish articles for AI answers and decide when a topic needs an operator.
Engage visitors automatically with time-on-page, exit-intent, and page-visit triggers that send personalized messages.
Check fixed booking availability and create, list, reschedule, complete, or cancel 30-minute appointments through the scheduling API.
Find conversations and messages with text search and practical filters.
Configure response and resolution targets, workspace business hours, live SLA status, and breach handling.
Configure widget appearance, localized content, pre-chat fields, installation, identity verification, and site domains from their current dashboard locations.
Getting Started
4Configure the widget from the Convor dashboard without changing the production embed code.
Definitions of the core terms used across the Convor docs and API reference.
Add the Convor widget to your site with one script tag.
Get Convor running on your website in three simple steps. No server-side installation required. The widget is a lightweight client-side script that connects to
Help
1Start
1Integrations
32The ActiveCampaign integration syncs your email marketing and CRM data with Convor. When visitors start conversations, their contact information is synced to Ac
Planned Allegro integration: one inbox for buyer conversations, manual replies, acknowledgements and optional AI.
Authorize Convor to access Asana, choose the default workspace and project, and manage support tasks from the inbox.
Install the Convor BigCommerce app in a store and use order and customer context in support workflows.
Authorize Calendly, choose an event type, and share the corresponding scheduling link from Convor.
Authorize ClickUp, choose a list and default status, and manage support tasks from Convor.
Connect Discord to receive conversation alerts, share transcripts, and check delivery activity for your Convor site.
The Freshdesk integration connects your customer support platform to Convor. Operators can create tickets from conversations, sync contact details, and track ti
Install the Convor GitHub App, select a repository, and create issues from support conversations.
The Google Analytics 4 integration lets Convor send chat interaction events directly to your GA4 property via the Measurement Protocol API. Track conversations,
Connect an Instagram professional account through Meta authorization and handle direct messages from the Convor inbox.
Authorize Jira Cloud, choose the default project and issue type, and create issues from Convor conversations.
Authorize Klaviyo, select a list, and synchronize visitor profiles from Convor.
Authorize Mailchimp, select an audience, and sync visitor contacts and tags from Convor.
Connect a Facebook Page to Convor through Meta authorization and handle Messenger conversations from the shared inbox.
Authorize Monday.com, choose a default board, and create work items from Convor conversations.
The n8n integration forwards Convor events to your self-hosted n8n workflow automation instance. When events happen in Convor (new conversations, messages, assi
Authorize a Notion workspace, select a data source or database target, and create pages from Convor conversations.
Authorize Pipedrive, choose the default pipeline and stage, and create CRM records from Convor conversations.
The Segment integration sends customer data and event tracking from Convor to your Segment workspace. Convor pushes events like conversations started, messages
The SendGrid integration connects your email delivery service to Convor. Operators can send email follow-ups from conversations, manage email templates, and tra
Install the Convor Shopify app in a store and choose which commerce events are synchronized.
Connect Slack to receive conversation alerts, share transcripts, and check delivery activity for your Convor site.
Connect a Stripe account through Stripe Connect and choose the payment events Convor should process.
Send Convor notifications to a Microsoft Teams channel with a Power Automate Teams Workflows webhook.
The Telegram integration connects Telegram to Convor bidirectionally. Your team receives Convor notifications in Telegram groups or channels, and messages sent to your Telegram bot are routed into Convor conversations.
Authorize Trello, choose a default board and list, and create and manage cards from Convor.
The Twilio SMS integration adds SMS as a support channel in Convor. Your team can send text messages to customers through a Twilio phone number, and conversation
Connect a WhatsApp Business Account and phone number through Meta Embedded Signup, then handle conversations in Convor.
Connect WooCommerce to Convor with REST API keys, signed webhooks, order context, and a manual widget script embed.
Connect WordPress to Convor with Application Passwords, selected post types, and a manual widget script embed.
Connect Convor to thousands of apps using Zapier REST hooks. When events happen in Convor (new conversations, messages, assignments), Zapier can automatically t
Recipes
3Use operator availability and the AI Chatbot's no-operator rule to collect and answer after-hours conversations without inventing unsupported automations.
Set up a knowledge-base-powered AI chatbot that answers common questions and hands off when confidence or intent requires a person.
Mirror high-priority conversations into a Slack channel so the right team sees them instantly.
Using Convor
37Configure inactivity closure, conversation analysis and AI activity history.
Use Allegro as an inbox filter and limit Rules and Knowledge to conversations from that channel.
Set conditions, replies and actions. Learn when Knowledge takes over.
Choose the right blocking level and review the consequences before applying restrictions.
Publish articles, set topic-handling rules and find questions your AI couldn't answer.
Understand inbox source labels, actual integration availability and email notifications.
Set AI availability, Knowledge requirements and what happens when the bot can't answer.
Review the notification center, enable browser push, choose delivery events, and control dashboard sound.
Create practical SLA policies, watch breaches, and keep response targets visible to the team.
Start a helpful conversation at the right moment without interrupting every visitor.
Match the chat widget to your brand, preview the result, and copy the production embed code.
Connect Google Workspace, Microsoft 365 or IMAP/SMTP mailboxes and reply from the shared Convor inbox.
Export only what you need and understand the consequences of personal-data deletion.
A practical first run through your Convor workspace, inbox, and team setup.
A straightforward workflow for finding, assigning, replying to, and closing visitor conversations.
Guides with screenshots for the day-to-day Convor dashboard.
Authorize Instagram through Meta, select the account and test incoming direct messages.
Add admins, operators, and viewers with the least access they need to do their work.
Choose where your AI replies come from and how multilingual operators work.
Check the active plan, compare limits, and keep the billing contact ready for invoices.
Keep one simple Default version or add only the languages your site actually needs.
Check provider availability, connection status and outbound automation events.
Store focused conversation filters so recurring queues are one click away.
Keep website domains, operators and settings in the correct Convor project.
Classify conversations with tags and store typed customer details in custom fields.
Authorize a Facebook Page, configure its first reply and verify message delivery in Convor.
Update organization details, timezone, plan navigation and unattended conversation handling.
Use the overview, realtime view, and operator table to decide what your support team should change next.
Find out who changed workspace settings, when the change happened, and which resource it affected.
Read CSAT scores with their response volume, speed context, and survey settings.
Use departments and routing rules to send each conversation to the operators who can help.
Set your support team's weekly availability and understand which features use that schedule.
Save realistic visitor messages and check whether Rules and Knowledge still behave as expected.
Use visitor filters, profiles, and merge tools to understand activity and keep duplicate records under control.
Keep reusable replies short, searchable, and easy for every operator to insert from the inbox.
Use Meta Embedded Signup, configure the first reply and verify WhatsApp message delivery.
Protect operator accounts and review API key scopes without exposing credentials.
Widget
5Configure the hosted widget in the dashboard and use supported browser options only when your application needs a deliberate override.
Install the Convor widget with the production embed code from your dashboard.
Deploy the Convor production embed with a Google Tag Manager Custom HTML tag.
Collect visitor details before a conversation starts using built-in and custom fields configured in Settings → Widget.
Create visitor-facing proactive messages from the Triggers page using the trigger types supported by the current dashboard.