--- title: Tawk.to API Integration on Truto slug: tawkto category: Helpdesk canonical: "https://truto.one/integrations/detail/tawkto/" --- # Tawk.to API Integration on Truto **Category:** Helpdesk **Status:** Generally available ## MCP-ready AI tools Truto exposes 80 tools for Tawk.to that AI agents can call directly. - **list_all_tawk_to_properties** — List properties for the authenticated agent. Supports pagination via body. - **get_single_tawk_to_property_by_id** — Retrieve property details. Required: propertyId. - **create_a_tawk_to_property** — Create a new property of type site for an agent. Required: name. - **list_all_tawk_to_conversations** — List chats for a property. Required: propertyId. Optional filters/pagination via body. - **get_single_tawk_to_conversation_by_id** — Get a single chat by ID. Required: propertyId, chatId. - **list_all_tawk_to_tickets** — List tickets for a tawk.to property with optional filters by date range, status, tags, and sort order. Returns: id, humanId, type, source, propertyId, subject, message, requester, personId, status, priority, createdOn, updatedOn, deleted, tags, spam, creator, assignee. Required: propertyId. - **get_single_tawk_to_ticket_by_id** — Get a single ticket by ID. Required: propertyId, ticketId. - **get_single_tawk_to_agent_by_id** — Get basic information about a specific tawk.to agent by id. Returns: id, name. Required: id. - **list_all_tawk_to_agents** — List members (agents) of a tawk.to property. Returns: id, name, role, enabled. Required: propertyId. - **tawk_to_agents_me** — Return basic agent information for the owner of the API key or OAuth token. - **tawk_to_agents_enable** — Enable a member's access to a property. Required: propertyId, agentId. Cannot enable yourself. - **tawk_to_agents_disable** — Disable a member's access to a property. Required: propertyId, agentId, successor.type, successor.id. - **tawk_to_agents_update_permissions** — Update a member's role on a property. Required: propertyId, agentId, role. - **tawk_to_agents_remove** — Remove a member from a property. Required: propertyId, agentId, successor. - **list_all_tawk_to_widgets** — List widget API keys for a property. Required: propertyId. - **get_single_tawk_to_widget_by_id** — Get settings for a specific Tawk.to widget. Returns the widget object including id, propertyId, name, enabled, version, language, and nested settings for theme, behavior, visibility, notifications, scheduler, and restrictions. Required: propertyId, widgetId. - **create_a_tawk_to_widget** — Create a new tawk.to widget of a specific type and add it to a property. Returns the created widget object including its id, name, type, and language. Required: propertyId, widget.name. - **update_a_tawk_to_widget_by_id** — Update widget settings for a tawk.to property, including name, enabled state, language, theme, behavior, visibility, notifications, consent, and scheduler configuration. Returns: ok. Required: propertyId, widgetId. - **delete_a_tawk_to_widget_by_id** — Remove a widget from a tawk.to property. Returns an empty 204 response on success. Required: propertyId, widgetId. - **tawk_to_widgets_add_card** — Add a new card to a widget. Required: propertyId, widgetId, state, card. - **tawk_to_widgets_remove_card** — Remove a card from a widget. Required: propertyId, widgetId, cardId, state. - **tawk_to_widgets_update_card** — Update widget card settings. Required: propertyId, widgetId, cardId, state, card. - **tawk_to_widgets_get_global_settings** — Fetch global widget settings for a property. Required: propertyId. - **tawk_to_widgets_update_global_settings** — Update global widget settings for a property. Required: propertyId, settings. - **list_all_tawk_to_webhooks** — List tawk.to webhooks for a property. Returns: hookId, propertyId, name, url, events, enabled, secretKey, createdOn, updatedOn. Required: propertyId. - **get_single_tawk_to_webhook_by_id** — Get a single tawk.to webhook by hookId and propertyId. Returns: hookId, propertyId, name, url, events, enabled, secretKey, createdOn, updatedOn. Required: hookId, propertyId. - **create_a_tawk_to_webhook** — Create a tawk.to webhook for a property. Returns: hookId. Required: propertyId, events, url, name. - **update_a_tawk_to_webhook_by_id** — Update a tawk.to webhook configuration for a property. Returns: ok. Required: hookId, propertyId, config. - **delete_a_tawk_to_webhook_by_id** — Delete a tawk.to webhook from a property. Returns: ok. Required: hookId, propertyId. - **get_single_tawk_to_contact_by_id** — Fetch a contact person's details from tawk.to by specifying which fields to return. Returns: id, name, jobTitle, primaryEmail, emails, primaryPhone, phones, avatar, socialProfiles, tags, organizationId, userId, device, location, webSession, liveChat, ticket, firstSeenOn, lastSeenOn, customAttributes, customEvents, createdOn, updatedOn. Required: propertyId, personId, fields. - **tawk_to_contacts_list_custom_attributes** — List custom contact attributes for a property. Required: propertyId, object. - **list_all_tawk_to_kb_articles** — List articles with each article's meta data & translation data in primary site or the first site for which its translation was created - **get_single_tawk_to_kb_article_by_id** — Fetch article for provided site - **create_a_tawk_to_kb_article** — Create new article in KB and its translation for provided site - **update_a_tawk_to_kb_article_by_id** — Update article and its translation for provided site - **delete_a_tawk_to_kb_article_by_id** — Destroy whole article and all its translations. Required: propertyId, articleId. - **tawk_to_kb_articles_search** — Searches articles from the given query, it will search through `title`, `subtitle` and `contents` - **tawk_to_kb_articles_soft_delete** — Delete an article translation for a site, or the whole article if it is the last translation. Required: propertyId, articleId, siteId. - **list_all_tawk_to_kb_categories** — List knowledge base categories for a property in tawk.to. Returns: id, name, description, slug, sites, icon, position, parent, articlesCount, hasChildren, createdAt, updatedAt. Required: propertyId. - **get_single_tawk_to_kb_category_by_id** — Retrieves the knowledge base category - **create_a_tawk_to_kb_category** — Create a new knowledge base category in tawk.to. Returns the created category object including meta (icon, parent, position) and content (siteId, name, description, slug, createdAt, updatedAt). Required: propertyId, category. - **update_a_tawk_to_kb_category_by_id** — Update a tawk.to knowledge base category's metadata and content. Returns: ok. Required: propertyId, categoryId, and category (with content.siteId, content.name, content.description). - **delete_a_tawk_to_kb_category_by_id** — Delete a Tawk.to knowledge base category for a specific site. Returns: ok. Required: propertyId, categoryId, siteId. - **tawk_to_kb_categories_destroy** — Destroy a category for all sites and reparent children. Required: propertyId, categoryId. - **tawk_to_kb_categories_list_articles** — List articles in a knowledge-base category. Required: propertyId, categoryId. - **tawk_to_kb_categories_order_articles** — Change article order within a category. Required: propertyId, categoryId. - **list_all_tawk_to_kb_sites** — List tawk.to knowledge base sites for a property. Returns: id, language, primary, title, description, header, banner, ticketForm, links, enabled, widgetId. Required: propertyId. - **get_single_tawk_to_kb_site_by_id** — Get a single tawk.to knowledge base site by property and site id. Returns: id, language, primary, title, description, header, banner, ticketForm, links, enabled, widgetId. Required: propertyId, siteId. - **create_a_tawk_to_kb_site** — Create a new tawk.to knowledge base site. Returns: id, language, primary, title, description, header, banner, ticketForm, links, enabled, widgetId. Required: propertyId, language, title. - **update_a_tawk_to_kb_site_by_id** — Update a tawk.to knowledge base site's settings including language, title, banner, ticket form, and widget configuration. Returns: ok. Required: propertyId, siteId, and site. - **delete_a_tawk_to_kb_site_by_id** — Delete a tawk.to knowledge base site. Returns a success-only response with no data payload. Required: propertyId, siteId. - **tawk_to_metrics_chat_metrics** — Retrieve chat statistics for a Tawk.to property over a specified time range. Returns: metrics. Required: propertyId, metrics, query.startTime, query.endTime. - **tawk_to_metrics_ticket_metrics_new** — Retrieve new ticket statistics for a tawk.to property, grouped by date with optional source breakdown. Returns: metrics. Required: propertyId, metrics, query (startTime, endTime). - **tawk_to_metrics_ticket_metrics_resolved** — Retrieve resolved ticket statistics for a tawk.to property. Returns a metrics array where each item includes date, total, and resolutionTime statistics. Required: propertyId, metrics, query (with startTime and endTime). - **tawk_to_metrics_ticket_metrics_reopened** — Retrieve reopened ticket statistics for a tawk.to property. Returns: metrics. Required: propertyId, metrics, query.startTime, query.endTime. Defaults granularity to day, timezone to 0. - **tawk_to_metrics_ticket_metrics_responses** — Retrieve ticket response statistics for a property. Required: propertyId, metrics, query.startTime, query.endTime. - **list_all_tawk_to_member_invites** — List pending member invites for a Tawk.to property. Returns: id, propertyId, role, email, invitedBy, createdOn. Required: propertyId. - **create_a_tawk_to_member_invite** — Invite an agent to a Tawk.to property by email. Returns: id. Required: propertyId, email, role. - **update_a_tawk_to_member_invite_by_id** — Update the role of a pending member invite in a Tawk.to property. Returns: found. Required: propertyId, inviteId, role. - **delete_a_tawk_to_member_invite_by_id** — Revoke a pending member invite from a Tawk.to property. Returns: id. Required: propertyId, inviteId. - **list_all_tawk_to_tabs** — List all tabs configured for a tawk.to property. Returns each tab with propertyId, tabId, type, position, enabled, and optionally subType, label, content, parent, and icon. Required: propertyId. - **tawk_to_tabs_list_available** — List available tabs that can be added to a tawk.to property. Returns: type, subType. Required: propertyId. - **create_a_tawk_to_tab** — Add a new tab to a tawk.to property. Returns the created tab including propertyId, tabId, type, position, enabled, label, content, parent, and icon. Required: propertyId, type, subType. - **update_a_tawk_to_tab_by_id** — Update a tab by ID in tawk.to. Supports changing the label, enabled status, position, content, parent menu, and icon for url, text, and menu type tabs. Returns an empty 204 response on success. Required: propertyId, tabId. Label is limited to 25 characters; url content must start with https and max 1024 characters; text content max 5000 characters. - **delete_a_tawk_to_tab_by_id** — Remove a tab from a Tawk.to property by tab ID. Returns a success-only response with no data payload. Required: propertyId, tabId. - **get_single_tawk_to_tab_by_id** — Retrieve a tab by ID. Required: propertyId, tabId. - **get_single_tawk_to_kb_setting_by_id** — Information that contains the specific settings about the knowledge base - **update_a_tawk_to_kb_setting_by_id** — Updates knowledge base settings - **tawk_to_kb_settings_check_domain** — Can be used to check if a certain domain is to available to use - **tawk_to_kb_settings_check_subdomain** — Can be used to check if a certain subdomain is to available to use - **tawk_to_kb_settings_update_subdomain** — Updates knowledge base subdomain settings - **tawk_to_kb_settings_add_domain_candidate** — Adds knowledge base domain candidate - **tawk_to_kb_settings_remove_domain_candidate** — Removes knowledge base domain candidate - **tawk_to_kb_settings_remove_domain** — Removes knowledge base domain settings - **create_a_tawk_to_kb_site_link** — Adds a knowledge base site navigation link - **update_a_tawk_to_kb_site_link_by_id** — Updates a knowledge base site navigation link - **delete_a_tawk_to_kb_site_link_by_id** — Removes a knowledge base site navigation link - **create_a_tawk_to_knowledge_base** — Creates a knowledge base for a property - **tawk_to_knowledge_bases_list_fonts** — Fetches all supported Knowledge Base fonts - **tawk_to_knowledge_bases_list_languages** — List available languages that can be used in Knowledge Base ## How it works 1. **Link your customer's Tawk.to account.** Use Truto's frontend SDK; we handle every OAuth and API key flow so you don't need to create the OAuth app. 2. **Authentication is automatic.** Truto refreshes tokens, stores credentials securely, and injects them into every API request. 3. **Call Truto's API to reach Tawk.to.** The Proxy API is a 1-to-1 mapping of the Tawk.to API. 4. **Get a unified response format.** Every response uses a single shape, with cursor-based pagination and data in the `result` field. ## Use cases - **Embed live chat into your platform for end customers** — Website builders, e-commerce platforms, and vertical SaaS tools can offer native live chat by programmatically provisioning Tawk.to properties, widgets, and agent invites for each of their merchants — no manual Tawk.to setup required. - **Sync KB content for AI and RAG training** — AI chatbot and support automation platforms can ingest their users' Tawk.to Knowledge Base articles and categories to train LLMs on customer-specific documentation and deliver accurate, grounded responses. - **Aggregate Tawk.to conversations and tickets into a unified inbox** — Helpdesk aggregation and customer service platforms can pull live conversations and tickets from Tawk.to into a centralized workspace, letting agents manage chat alongside other support channels. - **Surface your product inside the Tawk.to agent workspace** — B2B SaaS tools (order tracking, CRM lookups, internal apps) can inject custom tabs into the Tawk.to widget so support agents see relevant context and take action without leaving the chat interface. - **Build unified support analytics dashboards** — BI and workforce analytics platforms can pull chat and ticket metrics from Tawk.to to power cross-channel productivity dashboards, SLA reports, and agent scorecards for their customers. ## What you can build - **Automated property and widget provisioning** — Create Tawk.to properties, generate branded widgets, and update widget theme and behavior on behalf of your users so live chat is ready the moment they sign up. - **Two-way Knowledge Base sync** — Programmatically create, update, and delete KB sites, categories, and articles to keep your users' Tawk.to documentation in lockstep with your product's content or release notes. - **Webhook-driven chat and ticket automations** — Register Tawk.to webhooks to react to chat and ticket events in real time, then fetch conversation, ticket, or contact details to trigger downstream workflows in your product. - **Agent provisioning and permission management** — Invite new members, enable or disable agents, update their permissions, and remove agents from a Tawk.to workspace directly from your admin UI. - **Custom tabs inside the Tawk.to widget** — Use the Tabs API to embed your app's URLs, quick actions, or contextual data as native tabs inside the Tawk.to agent interface. - **Support performance analytics** — Pull chat metrics and ticket metrics (new, resolved, reopened, responses) to power dashboards, SLA tracking, and agent productivity reports for your customers. ## FAQs ### How do end users connect their Tawk.to account through Truto? Truto handles the Tawk.to authentication flow for you. Your users authorize access from your app, and Truto stores and refreshes credentials so you can call Tawk.to endpoints on their behalf without managing tokens yourself. ### Which Tawk.to resources can I read and write? Truto exposes tools for properties, widgets (including cards and global settings), conversations, tickets, contacts, agents, member invites, webhooks, tabs, KB sites, KB categories, KB articles, KB settings, and chat/ticket metrics. Both read operations and full CRUD are available across most of these resources. ### Can I receive real-time events from Tawk.to? Yes. You can programmatically register Tawk.to webhooks via Truto and receive events for chats, tickets, and other activity, then fetch the relevant conversation, ticket, or contact resource to enrich your workflow. ### Does Truto support provisioning entire Tawk.to workspaces for new customers? Yes. You can create a property, create and configure a widget, invite agents via member invites, and set up KB sites and categories — all through Truto's tool calls — enabling fully automated multi-tenant onboarding. ### Can I access custom contact attributes? Yes. Truto exposes a tool to list Tawk.to contact custom attributes and to fetch individual contacts, so you can map custom fields into your own data model when syncing to a CRM or other system of record. ### Can I embed my own UI inside the Tawk.to agent interface? Yes. Truto exposes Tawk.to's Tabs API, so you can list available tabs and create, update, or delete custom tabs that render your app's URLs or content directly inside the Tawk.to workspace.